v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of payouts with FX

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

get/fx/payouts

Query parameters

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]integer

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

page[size]integer

Number of results per page. Defaults to 10. Max 100.

payoutIdstring

Filter by payout UUID.

fromstring

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

tostring

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

statusstring

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

sortstring

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

Headers

X-XFERS-APP-API-KEYstring 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-IDstring

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-TIMESTAMPstring

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-NONCEstring

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-SIGNATUREstring

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

200

Example response

{
  "data": [
    {
      "id": "contract_d4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "type": "fxPayout",
      "attributes": {
        "initiator": {
          "mode": "onBehalfOf",
          "customerProfileId": "cp_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        },
        "status": "pending",
        "quoteId": "fx_quote_c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "recipientId": "payout_recipient_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "rate": 15832.5,
        "from": {
          "currency": "XUSD",
          "amount": "1000.00"
        },
        "to": {
          "currency": "IDR",
          "amount": "15832500.00"
        },
        "fee": {
          "currency": "XUSD",
          "amount": "1.50"
        },
        "createdAt": "2025-03-25T20:04:05+08:00",
        "updatedAt": "2025-03-25T20:04:05+08:00",
        "references": {
          "externalReference": "INV-2025-001",
          "internalReference": "internal-ref-001"
        }
      }
    }
  ],
  "meta": {
    "total": 98,
    "pages": 10
  }
}