Get Settlement

curl --request GET \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000 \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx'

const response = await fetch(
  'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
  {
    method: 'GET',
    headers: {
      'SWICH-API-Key': 'pk_test_xxxxxxxx'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
    headers={'SWICH-API-Key': 'pk_test_xxxxxxxx'}
)

{
  "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": 3,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": "2025-12-12T11:30:00Z",
  "processedAt": "2025-12-12T14:00:00Z",
  "failureReason": null,
  "isAuto": false
}

GET

Gateway

{version}

Settlements

{id}

curl --request GET \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000 \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx'

const response = await fetch(
  'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
  {
    method: 'GET',
    headers: {
      'SWICH-API-Key': 'pk_test_xxxxxxxx'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
    headers={'SWICH-API-Key': 'pk_test_xxxxxxxx'}
)

{
  "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": 3,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": "2025-12-12T11:30:00Z",
  "processedAt": "2025-12-12T14:00:00Z",
  "failureReason": null,
  "isAuto": false
}

Overview

Get detailed information about a specific settlement using its unique identifier.

Path Parameters

uuid

required

Settlement unique identifier

string

required

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

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

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-5)

datetime

When settlement was requested

datetime

When settlement was approved

datetime

When settlement was processed

string

Reason for failure

boolean

Whether this was an automatic settlement

curl --request GET \
  --url https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000 \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx'

const response = await fetch(
  'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
  {
    method: 'GET',
    headers: {
      'SWICH-API-Key': 'pk_test_xxxxxxxx'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://gateway.dev.waypay.live/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000',
    headers={'SWICH-API-Key': 'pk_test_xxxxxxxx'}
)

{
  "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": 3,
  "requestedAt": "2025-12-12T11:00:00Z",
  "approvedAt": "2025-12-12T11:30:00Z",
  "processedAt": "2025-12-12T14:00:00Z",
  "failureReason": null,
  "isAuto": false
}

List Settlements

You can also retrieve a paginated list of all settlements: Endpoint: GET /Gateway/v{version}/Settlements

Query Parameters

uuid

Filter by merchant ID

integer

Filter by status (0-5)

datetime

Filter settlements from this date

datetime

Filter settlements until this date

integer

Page number (default: 1)

integer

Items per page (default: 20)

API documentation

Authentication

Account Balance

Hosted Page Checkout

Deposit

Withdrawal

Order Status

Refund Endpoints

Settlement Endpoints

Errors

Overview

Path Parameters

Response

List Settlements

Query Parameters

​Overview

​Path Parameters

​Response

​List Settlements

​Query Parameters

Overview

Path Parameters

Response

List Settlements

Query Parameters