---
title: "Get required fields for a payee"
method: GET
path: "/open-api/v3/payees/required-fields"
tags: ["Payouts"]
---

# Get required fields for a payee

`GET /open-api/v3/payees/required-fields`

Get the required fields for making payments to corporate or individual bank accounts in various countries and currencies

## Query parameters

- `paymentType` 'COMPANY' | 'INDIVIDUAL', required — Payment to company or individual bank account.
- `currency` 'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR', required — Currency code.
- `country` string, required — Country code. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

## Response `200`

OK

- PayeeRequiredRespDTO
  - `code` string — Error code
  - `message` string — Error message
  - `data` PayeeRequiredFieldVO[], required — data
    - `paymentMethod` string — Payment method. This parameter belongs to LOCAL except SWIFT, For example, ACH is a local in the United States."ACH", "WIRE", "EFT", "SEPA", "FPS", "CHATS", "LOCAL", "IBG", "FAST", "AUS_PAY_NET", "FED_WIRE", "SWIFT"
    - `fields` PayeeRoutingCodeFieldInfo[] — Fields info.
      - `filedName` string — Field name.
      - `validationRules` RequiredFieldVO[] — Validation rules.
        - `routingCodeType` 'ROUTING_NUMBER' | 'ACH_CODE' | 'BSB_CODE' | 'SORT_CODE' | 'IBAN' | 'BANK_CODE' | 'BRANCH_CODE' | 'PHONE_NUMBER' | 'SWIFT_CODE'
        - `fieldName` string
        - `max` number — The maximum value, String type is the maximum length, number type is the maximum value
        - `min` number — Minimum value, String type is the maximum length, number type is the minimum value
        - `regex` string

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/interlace/apis/core-resource.md) · [All operations](https://skmtc.net/interlace/apis/core-resource/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interlace/core-resource/revisions/29c08a4da357/schema)