Get a list of payout recipients

get

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

Query Params

filter[disbursementMethod]

string

bankTransfer, paynow, or swift`

filter[bankShortCode]

string

Bank account abbreviation (abbreviation) can be retrieved from Get a list of supported banks API

filter[bankAccountNo]

string

Recipient's bank account number
Regex: /^[a-zA-Z0-9\-]{5,34}$/

filter[proxyType]

string

Type of PayNow proxy: mobile_number, nric, uen, vpa

filter[proxyValue]

string

Value of the PayNow proxy. Note that you would need to replace the + sign in the proxyValue with %2B
Regex: /^\s*.{1,255}\s*$/

page[number]

int32

Defaults to 1

Page number(Must be an integer greater than 0)
Regex: /^0*[1-9][0-9]*$/

page[size]

int32

Defaults to 10

Number of transactions per page(Must be an integer greater than 0)
Regex: /^0*[1-9][0-9]*$/

sort

string

Sorted by
Creation Date: Ascending (createdAt) / Descending (-createdAt)

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

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200