Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of payout recipients

Retrieve a paginated list of payout recipients with optional filters.<br>To list recipients for a customer profile, include initiator query parameters. If omitted, defaults to the authenticated user.

get/fx/payout-recipients

Query parameters

initiator[mode]string

Set to onBehalfOf to list recipients for a customer profile. Omit for self.

initiator[customerProfileId]string

UUID of the customer profile. Required if mode is onBehalfOf.

filter[disbursementMethod]string

Filter by disbursement method. Currently only bankTransfer.

filter[bankAccountNo]string

Filter by bank account number.

filter[bankShortCode]string

Filter by bank short code (SWIFT BIC for IDR recipients).

sortstring

Sort field. Supported: createdAt. Prefix with - for descending. Defaults to -createdAt.

page[number]integer

Page number (1-indexed). Defaults to 1.

page[size]integer

Number of results per page. Defaults to 10.

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

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": "verified",
        "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"
      }
    }
  ],
  "meta": {
    "total": 25,
    "pages": 3
  },
  "links": {
    "self": "/v1/fx/payout-recipients?page[size]=10",
    "next": "/v1/fx/payout-recipients?page[number]=2&page[size]=10"
  }
}