Get a list of regular payouts

get

https://api-sandbox.straitsx.com/v1/payouts

[Available in Production/Sandbox environment] Retrieve a list of regular payouts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page[size]

int32

Defaults to 10

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

page[number]

int32

Defaults to 1

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

sort

string

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

filter[to]

string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z
Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[from]

string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z
Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[disbursementMethodType]

string

bankTransfer or paynow, swift

filter[currency]

string

Accepts xsgd, xusd, sgd or usd

filter[status]

string

Accepts only failed, completed or pending

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