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

# Get a payout recipient

`GET /fx/payout-recipients/{recipientId}`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1`
- URL: `https://api-sandbox.straitsx.com/v1/fx/payout-recipients/{recipientId}`
- Auth: API key in header `X-XFERS-APP-API-KEY`

## Path parameters

- `recipientId` 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

- object
  - `data` object
    - `id` string: Payout recipient ID.
    - `type` string: Resource type. Always `fxPayoutRecipient`.
    - `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.
      - `verificationStatus` string: Bank account verification status. One of: `pending`, `verified`, `rejected`.
      - `recipientCountry` string: ISO 3166 alpha-2 country code.
      - `recipientInformation` object: Recipient information.
        - `disbursementMethod` string: Disbursement method used to send funds.
        - `entityType` string: Recipient entity type. One of: `individual`, `business`.
        - `recipientName` string: Name of the recipient.
        - `currency` string: Currency for the transfer.
        - `bankAccountNo` string: Recipient's bank account number.
        - `bankShortCode` string: Numeric bank code (e.g. `009` for BNI, `014` for BCA). Auto-populated from swiftBic.
        - `swiftBic` string: SWIFT/BIC code of the recipient bank.
        - `bankName` string: Name of the recipient bank.
      - `createdAt` string: Timestamp when the recipient was created (ISO 8601, Singapore timezone).
      - `updatedAt` string: Timestamp when the recipient was last updated (ISO 8601, Singapore timezone).

## Other responses

- `404`: Not Found

---

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