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

# Get recipient requirements

`GET /payout-recipients/requirements`

## Query parameters

- `filter[recipientCountry]` string, required
- `filter[currency]` string, required
- `filter[disbursementMethod]` string, required
- `filter[proxyType]` string
- `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
    - `id` string — Recipient requirement ID.
    - `type` string — Request type.
    - `attributes` object
      - `recipientCountry` string — The country where the recipient is located.
      - `recipientInformation` object — Recipient information.
        - `disbursementMethod` string — Disbursement method used to send funds.
        - `currency` string — Currency for the transfer.
        - `entityType` string — Recipient entity type.
        - `recipientName` string — Recipient name.
        - `proxyType` string — Type of PayNow proxy.
        - `proxyValue` string — The actual PayNow identifier value.
      - `requiredFields` string[] — List of fields that must be provided when creating the payout recipient.

---

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