---
title: "Get payout recipient requirements"
method: GET
path: "/fx/payout-recipients/requirements"
---

# Get payout recipient requirements

`GET /fx/payout-recipients/requirements`

## Request

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

Retrieve the required fields and validation rules for creating a payout recipient.

## Query parameters

- `filter[recipientCountry]` string, required
- `filter[currency]` string, required
- `filter[disbursementMethod]` string, required
- `filter[entityType]` 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
    - `recipient_country` string: Country code for this requirement set.
    - `recipient_information` object: Field names mapped to regex validation patterns.
      - `disbursement_method` string: Disbursement method.
      - `currency` string: Currency for the transfer.
      - `entity_type` string: Recipient entity type.
      - `recipient_name` string: Regex validation pattern for recipient name.
      - `swift_bic` string: Regex validation pattern for SWIFT/BIC code.
      - `bank_account_no` string: Regex validation pattern for bank account number.
      - `bank_account_proof_url` string: Regex validation pattern for bank account proof URL.
    - `required_fields` string[]: List of required field paths for creating a payout recipient.

## Other responses

- `400`: Bad Request

---

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