Create Settlement

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 50000,
    "currency": "PKR",
    "payoutCurrency": "PKR",
    "bankName": "Meezan Bank",
    "iban": "PK24MEZN0003490001234567",
    "accountTitle": "My Business Account",
    "signature": "e5f6789012345678abcdef12345678a"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Settlements', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50000,
    currency: 'PKR',
    payoutCurrency: 'PKR',
    bankName: 'Meezan Bank',
    iban: 'PK24MEZN0003490001234567',
    accountTitle: 'My Business Account',
    signature: 'e5f6789012345678abcdef12345678a'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'amount': 50000,
        'currency': 'PKR',
        'payoutCurrency': 'PKR',
        'bankName': 'Meezan Bank',
        'iban': 'PK24MEZN0003490001234567',
        'accountTitle': 'My Business Account',
        'signature': 'e5f6789012345678abcdef12345678a'
    }
)

{
  "id": "aa0e8400-e29b-41d4-a716-446655440000",
  "merchantId": "bb0e8400-e29b-41d4-a716-446655440000",
  "amount": 50000,
  "currency": "PKR",
  "payoutCurrency": "PKR",
  "payoutAmount": 50000,
  "fee": 100,
  "netAmount": 49900,
  "fxRate": null,
  "fxRateTimestamp": null,
  "bankName": "Meezan Bank",
  "iban": "PK24MEZN0003490001234567",
  "accountTitle": "My Business Account",
  "usdtAddress": null,
  "status": 0,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": null,
  "processedAt": null,
  "failureReason": null,
  "isAuto": false
}

POST

Gateway

{version}

Settlements

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 50000,
    "currency": "PKR",
    "payoutCurrency": "PKR",
    "bankName": "Meezan Bank",
    "iban": "PK24MEZN0003490001234567",
    "accountTitle": "My Business Account",
    "signature": "e5f6789012345678abcdef12345678a"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Settlements', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50000,
    currency: 'PKR',
    payoutCurrency: 'PKR',
    bankName: 'Meezan Bank',
    iban: 'PK24MEZN0003490001234567',
    accountTitle: 'My Business Account',
    signature: 'e5f6789012345678abcdef12345678a'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'amount': 50000,
        'currency': 'PKR',
        'payoutCurrency': 'PKR',
        'bankName': 'Meezan Bank',
        'iban': 'PK24MEZN0003490001234567',
        'accountTitle': 'My Business Account',
        'signature': 'e5f6789012345678abcdef12345678a'
    }
)

{
  "id": "aa0e8400-e29b-41d4-a716-446655440000",
  "merchantId": "bb0e8400-e29b-41d4-a716-446655440000",
  "amount": 50000,
  "currency": "PKR",
  "payoutCurrency": "PKR",
  "payoutAmount": 50000,
  "fee": 100,
  "netAmount": 49900,
  "fxRate": null,
  "fxRateTimestamp": null,
  "bankName": "Meezan Bank",
  "iban": "PK24MEZN0003490001234567",
  "accountTitle": "My Business Account",
  "usdtAddress": null,
  "status": 0,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": null,
  "processedAt": null,
  "failureReason": null,
  "isAuto": false
}

Overview

Create a settlement request to transfer funds from your Waypay wallet to your bank account or USDT address. Settlements can be in different currencies and support automatic currency conversion.

Path Parameters

string

required

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

Request Body

number

Settlement amount to withdraw

string

Source currency in your wallet (e.g., “PKR”, “USD”)

string

Destination currency for payout (e.g., “PKR”, “USD”, “USDT”)

string

Name of your bank (required for bank transfers)

string

Your IBAN or account number (required for bank transfers)

string

Account title/holder name (required for bank transfers)

string

USDT wallet address (required for crypto payouts)

string

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 settlement identifier

uuid

Your merchant ID

number

Settlement amount

string

Source currency

string

Destination currency

number

Amount to be paid out (after conversion)

number

Settlement processing fee

number

Net amount after fees

number

Foreign exchange rate applied (if applicable)

datetime

When the FX rate was locked

string

Destination bank name

string

Destination IBAN

string

Account holder name

string

USDT wallet address

integer

Settlement status:

0 - Pending
1 - Approved
2 - Processing
3 - Completed
4 - Failed
5 - Cancelled

datetime

When settlement was requested

datetime

When settlement was approved

datetime

When settlement was processed

string

Reason for failure (if applicable)

boolean

Whether this was an automatic settlement

curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 50000,
    "currency": "PKR",
    "payoutCurrency": "PKR",
    "bankName": "Meezan Bank",
    "iban": "PK24MEZN0003490001234567",
    "accountTitle": "My Business Account",
    "signature": "e5f6789012345678abcdef12345678a"
  }'

const response = await fetch('https://gateway.dev.waypay.live/Gateway/v1/Settlements', {
  method: 'POST',
  headers: {
    'SWICH-API-Key': 'pk_test_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50000,
    currency: 'PKR',
    payoutCurrency: 'PKR',
    bankName: 'Meezan Bank',
    iban: 'PK24MEZN0003490001234567',
    accountTitle: 'My Business Account',
    signature: 'e5f6789012345678abcdef12345678a'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements',
    headers={
        'SWICH-API-Key': 'pk_test_xxxxxxxx',
        'Content-Type': 'application/json'
    },
    json={
        'amount': 50000,
        'currency': 'PKR',
        'payoutCurrency': 'PKR',
        'bankName': 'Meezan Bank',
        'iban': 'PK24MEZN0003490001234567',
        'accountTitle': 'My Business Account',
        'signature': 'e5f6789012345678abcdef12345678a'
    }
)

{
  "id": "aa0e8400-e29b-41d4-a716-446655440000",
  "merchantId": "bb0e8400-e29b-41d4-a716-446655440000",
  "amount": 50000,
  "currency": "PKR",
  "payoutCurrency": "PKR",
  "payoutAmount": 50000,
  "fee": 100,
  "netAmount": 49900,
  "fxRate": null,
  "fxRateTimestamp": null,
  "bankName": "Meezan Bank",
  "iban": "PK24MEZN0003490001234567",
  "accountTitle": "My Business Account",
  "usdtAddress": null,
  "status": 0,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": null,
  "processedAt": null,
  "failureReason": null,
  "isAuto": false
}

Cancel Refund Get Settlement

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