Get Recipient Form Fields

GET

/api/v1/payees/recipient/{ScreenName}

Last modified:2026-07-16 12:48:45

Returns the dynamic recipient form configuration (fields, validations, mandatory flags) for the given screen — used to render the add-payee form per currency/country combination.

Request

Path Params

Responses

🟢200

application/json

Recipient form field configuration.

Bodyapplication/json

🟠401

Response Example

{
    "fields": [
        {
            "label": "Account Number",
            "key": "accountNumber",
            "isMandatory": "true",
            "validation": "^[0-9]{6,17}$",
            "fieldType": "text"
        },
        {
            "label": "Routing Number",
            "key": "abaRoutingCode",
            "isMandatory": "true",
            "validation": "^[0-9]{9}$",
            "fieldType": "text"
        }
    ]
}

Modified at 2026-07-16 12:48:45

View Fiat Payee Details

Get Payees Lookup Data