Get a list of payout recipients

get

https://api-sandbox.straitsx.com/v1/fx/payout-recipients

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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

sort

string

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

page[number]

int32

Defaults to 1

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

page[size]

int32

Defaults to 10

Number of results per page. Defaults to 10.

Headers

X-XFERS-APP-API-KEY

string

required

You can retrieve this from your Dashboard Developer Tools.

Note: 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-ID

string

The Key ID, can be retrieved from your StraitsX Dashboard.

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMP

string

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCE

string

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.
Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATURE

string

Base64-encoded digital signature of the canonical request string.

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200200