Skip to main content
GET
/
Gateway
/
v
{version}
/
Settlements
/
{id}
curl --request GET \
  --url https://waypay-merchant-api.icydesert-41d42f7e.uaenorth.azurecontainerapps.io/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000 \
  --header '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

​
id
uuid
required
Settlement unique identifier
​
version
string
required
API version (e.g., “1”)

​
Response

​
id
uuid
Unique settlement identifier
​
merchantId
uuid
Your merchant ID
​
amount
number
Settlement amount
​
currency
string
Source currency
​
payoutCurrency
string
Destination currency
​
payoutAmount
number
Amount to be paid out (after conversion)
​
fee
number
Settlement processing fee
​
netAmount
number
Net amount after fees
​
fxRate
number
Foreign exchange rate applied
​
fxRateTimestamp
datetime
When the FX rate was locked
​
bankName
string
Destination bank name
​
iban
string
Destination IBAN
​
accountTitle
string
Account holder name
​
usdtAddress
string
USDT wallet address
​
status
integer
Settlement status (0-5)
​
requestedAt
datetime
When settlement was requested
​
approvedAt
datetime
When settlement was approved
​
processedAt
datetime
When settlement was processed
​
failureReason
string
Reason for failure
​
isAuto
boolean
Whether this was an automatic settlement
curl --request GET \
  --url https://waypay-merchant-api.icydesert-41d42f7e.uaenorth.azurecontainerapps.io/Gateway/v1/Settlements/aa0e8400-e29b-41d4-a716-446655440000 \
  --header '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

​
MerchantId
uuid
Filter by merchant ID
​
Status
integer
Filter by status (0-5)
​
From
datetime
Filter settlements from this date
​
To
datetime
Filter settlements until this date
​
Page
integer
Page number (default: 1)
​
PageSize
integer
Items per page (default: 20)