Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a payout recipient

get/payout-recipients/{recipient_id}

Path parameters

recipient_idstring required

Recipient ID is retrieved from the response of Create a Payout Recipient API

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200

OR
OR

Example response

{
  "data": {
    "id": "payout_recipient_4b34a644-4b26-4e15-a6ec-2abae166ba15",
    "type": "payoutRecipient",
    "attributes": {
      "recipientCountry": "SG",
      "recipientInformation": {
        "entityType": "individual",
        "currency": "SGD",
        "disbursementMethod": "bankTransfer",
        "recipientName": "John Doe",
        "bankAccountNo": "00000001",
        "bankShortCode": "DBS"
      },
      "createdAt": "2024-08-19T15:49:25.578+08:00",
      "updatedAt": "2024-08-19T15:49:25.578+08:00"
    }
  }
}