---
title: "Get a list of payouts with FX"
method: GET
path: "/fx/payouts"
---

# Get a list of payouts with FX

`GET /fx/payouts`

[Available in Production/Sandbox environment] Retrieve a paginated list of FX payouts with optional filters.<br>To list payouts for a customer profile, include `initiator` query parameters. If omitted, defaults to the authenticated user.

## Query parameters

- `initiator[mode]` string
- `initiator[customerProfileId]` string
- `page[number]` integer
- `page[size]` integer
- `payoutId` string
- `from` string
- `to` string
- `status` string
- `sort` string

## Headers

- `X-XFERS-APP-API-KEY` string, required
- `X-PUBLIC-KEY-ID` string
- `X-TIMESTAMP` string
- `X-NONCE` string
- `X-SIGNATURE` string

## Response `200`

200

- object
  - `data` object[]
    - `id` string — Payout ID, prefixed with `contract_`.
    - `type` string — Resource type. Always `fxPayout`.
    - `attributes` object
      - `initiator` object — Initiator information. Present when acting on behalf of a customer profile.
        - `mode` string — Initiator mode. Currently only `onBehalfOf`.
        - `customerProfileId` string — UUID of the customer profile.
      - `status` string — Transaction status. One of: `pending`, `completed`, `failed`.
      - `quoteId` string — UUID of the quote used.
      - `recipientId` string — ID of the payout recipient used.
      - `rate` number — FX rate applied.
      - `from` object — Source currency and amount.
        - `currency` string — Source currency.
        - `amount` string — Amount in source currency.
      - `to` object — Target currency and amount.
        - `currency` string — Target currency.
        - `amount` string — Computed amount in target currency.
      - `fee` object — Fee charged. Contains `currency` and `amount`.
        - `currency` string — Fee currency.
        - `amount` string — Fee amount.
      - `createdAt` string — ISO 8601 timestamp of transaction creation (Singapore timezone).
      - `updatedAt` string — ISO 8601 timestamp of last status change (Singapore timezone).
      - `references` object — Reference identifiers for the payout.
        - `externalReference` string — External reference provided by the merchant.
        - `internalReference` string — Internal reference provided by the merchant.
  - `meta` object — Pagination metadata.
    - `total` integer — Total number of items.
    - `pages` integer — Total number of pages.
  - `links` object — Pagination links.
    - `self` string — Link to the current page.
    - `next` string — Link to the next page.
    - `last` string — Link to the last page.

---

[API](https://skmtc.net/straitsx/apis/straitsx-sandbox-base-url.md) · [All operations](https://skmtc.net/straitsx/apis/straitsx-sandbox-base-url/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/straitsx/straitsx-sandbox-base-url/versions/9ceee2969aeb/schema)