Get a list of payouts with FX

get

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

[Available in Production/Sandbox environment] Retrieve a paginated list of FX payouts with optional filters.
To list payouts 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 payouts for a customer profile. Omit for self.

initiator[customerProfileId]

string

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

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. Max 100.

payoutId

string

Filter by payout UUID.

from

string

Start of date range filter (ISO 8601). Inclusive.

string

End of date range filter (ISO 8601). Inclusive.

status

string

Filter by status. One of: pending, completed, failed.

sort

string

Sort order. Format: field:direction. e.g. createdAt:desc. Defaults to createdAt:desc.

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

Loading…

Response

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

application/json

200200