Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Create payout recipient

Create a new payout recipient for FX payouts.

post/fx/payout-recipients

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.

Request body

Response

201

Example response

{
  "data": {
    "id": "payout_recipient_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "fxPayoutRecipient",
    "attributes": {
      "initiator": {
        "mode": "onBehalfOf",
        "customerProfileId": "cp_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "verificationStatus": "pending",
      "recipientCountry": "ID",
      "recipientInformation": {
        "disbursementMethod": "bankTransfer",
        "entityType": "individual",
        "recipientName": "John Doe",
        "currency": "IDR",
        "bankAccountNo": "1234567890",
        "bankShortCode": "009",
        "swiftBic": "BNINIDJA",
        "bankName": "Bank Negara Indonesia"
      },
      "createdAt": "2025-04-30T10:00:00+08:00",
      "updatedAt": "2025-04-30T10:00:00+08:00"
    }
  }
}