---
title: "Get a payout recipient"
method: GET
path: "/payout-recipients/{recipient_id}"
---

# Get a payout recipient

`GET /payout-recipients/{recipient_id}`

## Path parameters

- `recipient_id` string, required

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

- union
  - 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.
          - `bankAccountNo` string — Recipient's bank account number.
          - `bankShortCode` string — Recipient's bank short code.
        - `createdAt` string — Timestamp when the payout recipient was created.
        - `updatedAt` string — Timestamp when the payout recipient was last updated.
  - 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.
        - `createdAt` string — Timestamp when the payout recipient was created.
        - `updatedAt` string — Timestamp when the payout recipient was last updated.
  - 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.
          - `bankAccountNo` string — Recipient's bank account number.
          - `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.

---

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