---
title: "Get a list of payout recipients"
method: GET
path: "/fx/payout-recipients"
---

# Get a list of payout recipients

`GET /fx/payout-recipients`

Retrieve a paginated list of payout recipients with optional filters.<br>To list recipients for a customer profile, include `initiator` query parameters. If omitted, defaults to the authenticated user.

## Query parameters

- `initiator[mode]` string
- `initiator[customerProfileId]` string
- `filter[disbursementMethod]` string
- `filter[bankAccountNo]` string
- `filter[bankShortCode]` string
- `sort` string
- `page[number]` integer
- `page[size]` integer

## 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 recipient ID.
    - `type` string — Resource type.
    - `attributes` object
      - `initiator` object — Initiator information.
        - `mode` string
        - `customerProfileId` string
      - `verificationStatus` string — Bank account verification status.
      - `recipientCountry` string — ISO 3166 alpha-2 country code.
      - `recipientInformation` object — Recipient information.
        - `disbursementMethod` string
        - `entityType` string
        - `recipientName` string
        - `currency` string
        - `bankAccountNo` string
        - `bankShortCode` string — Numeric bank code (e.g. `009` for BNI, `014` for BCA). Auto-populated from swiftBic.
        - `swiftBic` string
        - `bankName` string
      - `createdAt` string
      - `updatedAt` string
  - `meta` object — Pagination metadata.
    - `total` integer — Total count.
    - `pages` integer — Total pages.
  - `links` object — Pagination links.
    - `self` string — The URL of the current request/page.
    - `next` string — The URL to retrieve the next page of results, if available.

---

[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/revisions/9ceee2969aeb/schema)