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

# Get a list of payout recipients

`GET /payout-recipients`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1`
- URL: `https://api-sandbox.straitsx.com/v1/payout-recipients`
- Auth: none required

## Query parameters

- `filter[disbursementMethod]` string
- `filter[bankShortCode]` string
- `filter[bankAccountNo]` string
- `filter[proxyType]` string
- `filter[proxyValue]` string
- `page[number]` integer
- `page[size]` integer
- `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 recipient ID.
    - `type` string: Request type.
    - `attributes` object
      - `recipientCountry` string: The country where the recipient is located.
      - `recipientInformation` object: Recipient information.
        - `entityType` string: Recipient entity type.
        - `currency` string: Currency for the transfer.
        - `disbursementMethod` string: Disbursement method used to send funds.
        - `recipientName` string: Name of the recipient.
        - `proxyType` string: Type of PayNow proxy.
        - `proxyValue` string: The actual PayNow identifier value.
        - `bankAccountNo` string: Recipient's bank account number.
        - `bankShortCode` string: Recipient's bank short code.
        - `swiftBic` string: SWIFT code of the payout recipient.
        - `recipientAddress` object: Recipient address details.
          - `address` string: Street address.
          - `city` string: City name.
          - `postalCode` string: Postal or ZIP code.
          - `state` string: State or region.
          - `country` string: Country code.
        - `routingCode` string: Routing code.
        - `intermediarySwiftBic` string: Intermediary SWIFT code.
        - `paymentReason` string: Payment reason is a field used to pass clear, specific instructions to the receiving bank.
      - `createdAt` string: Timestamp when the payout recipient was created.
      - `updatedAt` string: Timestamp when the payout recipient was last updated.
  - `meta` object: Metadata about the returned list, such as pagination details.
    - `total` integer: Total count.
    - `pages` integer: Page size.
  - `links` object: URLs related to the paginated result set.
    - `self` string: The URL of the current request/page.

---

[API](https://skmtc.dev/straitsx/apis/base-url.md) - [All operations](https://skmtc.dev/straitsx/apis/base-url/llms.txt) - [OpenAPI document](https://skmtc.dev/straitsx/apis/base-url/revisions/a016bf48febc?raw)