Create Refund

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Refunds \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "trxnRef": "TXN20251212123456",
    "amount": 250,
    "reason": "Customer requested refund",
    "signature": "d4e5f6789012345678abcdef1234567"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Refunds', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    trxnRef: 'TXN20251212123456',
    amount: 250,
    reason: 'Customer requested refund',
    signature: 'd4e5f6789012345678abcdef1234567'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Refunds',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'trxnRef': 'TXN20251212123456',
        'amount': 250,
        'reason': 'Customer requested refund',
        'signature': 'd4e5f6789012345678abcdef1234567'
    }
)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "paymentIntentId": "660e8400-e29b-41d4-a716-446655440001",
  "amount": 250,
  "currency": "PKR",
  "reason": "Customer requested refund",
  "status": 0,
  "isLive": true,
  "requestedAt": "2025-12-12T10:30:00Z",
  "approvedAt": null,
  "processedAt": null,
  "attemptCount": 0
}

POST

Gateway

{version}

Refunds

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Refunds \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "trxnRef": "TXN20251212123456",
    "amount": 250,
    "reason": "Customer requested refund",
    "signature": "d4e5f6789012345678abcdef1234567"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Refunds', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    trxnRef: 'TXN20251212123456',
    amount: 250,
    reason: 'Customer requested refund',
    signature: 'd4e5f6789012345678abcdef1234567'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Refunds',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'trxnRef': 'TXN20251212123456',
        'amount': 250,
        'reason': 'Customer requested refund',
        'signature': 'd4e5f6789012345678abcdef1234567'
    }
)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "paymentIntentId": "660e8400-e29b-41d4-a716-446655440001",
  "amount": 250,
  "currency": "PKR",
  "reason": "Customer requested refund",
  "status": 0,
  "isLive": true,
  "requestedAt": "2025-12-12T10:30:00Z",
  "approvedAt": null,
  "processedAt": null,
  "attemptCount": 0
}

Overview

This endpoint allows you to initiate a refund for a previously completed transaction. Refunds can be full or partial amounts.

Path Parameters

string

required

API version (e.g., “1”)

Request Body

string

required

Transaction reference number to refund

number

Refund amount (minimum 10). If not provided, full transaction amount will be refunded

string

Reason for refund (max 500 characters)

string

required

Request signature for authentication. A 32-character lowercase hexadecimal string generated using MD5 hash.

Never expose your secret key in client-side code or public repositories.

See the Signature Guide for implementation details.

Response

uuid

Unique refund identifier

uuid

Associated payment intent ID

number

Refund amount

string

Currency code

string

Refund reason

integer

Refund status:

0 - Pending
1 - Approved
2 - Processing
3 - Completed
4 - Failed
5 - Cancelled
6 - Rejected
7 - Expired

boolean

Whether this is a live or test refund

datetime

When the refund was requested

datetime

When the refund was approved

datetime

When the refund was processed

integer

Number of processing attempts

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Refunds \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "trxnRef": "TXN20251212123456",
    "amount": 250,
    "reason": "Customer requested refund",
    "signature": "d4e5f6789012345678abcdef1234567"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Refunds', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    trxnRef: 'TXN20251212123456',
    amount: 250,
    reason: 'Customer requested refund',
    signature: 'd4e5f6789012345678abcdef1234567'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Refunds',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'trxnRef': 'TXN20251212123456',
        'amount': 250,
        'reason': 'Customer requested refund',
        'signature': 'd4e5f6789012345678abcdef1234567'
    }
)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "paymentIntentId": "660e8400-e29b-41d4-a716-446655440001",
  "amount": 250,
  "currency": "PKR",
  "reason": "Customer requested refund",
  "status": 0,
  "isLive": true,
  "requestedAt": "2025-12-12T10:30:00Z",
  "approvedAt": null,
  "processedAt": null,
  "attemptCount": 0
}

Query Transaction/Order Status Cancel Refund

API documentation

Authentication

Account Balance

Hosted Page Checkout

Deposit

Withdrawal

Order Status

Refund Endpoints

Settlement Endpoints

Errors

Overview

Path Parameters

Request Body

Response

​Overview

​Path Parameters

​Request Body

​Response

Overview

Path Parameters

Request Body

Response