Required Beneficiary Fields

Every request must contain common parameters.

Returns the bank-specific beneficiary fields required for a country, currency, and bank. Send the returned keys in beneficiaryFields when creating a quote.

POST /v1/fiatpayout/supports/fields

Request Body

Name	Type	Required	Description
country	String	Yes	Beneficiary country or region as an ISO 3166-1 alpha-2 code.
currency	String	Yes	Receiving currency as an ISO 4217 currency code.
bank_code	String	Yes	MusePay platform bank code returned by the supported banks endpoint.
network	String	No	Clearing network (optional). For bank-type payees, pass the network chosen via the supported networks endpoint (e.g. LOCAL_PAYMENT/SWIFT) to scope the returned fields to that network. Omit for wallet-type payees or when no network is chosen; returns the full field set.

{
  "country": "US",
  "currency": "USD",
  "bank_code": "bank-1",
  "network": "LOCAL_PAYMENT"
}

Response Body

Name	Type	Description
fields	Array	Bank-specific beneficiary field definitions.
fields[].key	String	Case-sensitive field key to send in beneficiaryFields.
fields[].label	String	Display name for the field.
fields[].required	Boolean	Whether the field must be provided.

{
  "code": "200",
  "message": "success",
  "data": {
    "fields": [
      {
        "key": "routing_number",
        "label": "Routing number",
        "required": true
      }
    ]
  }
}