Get the additional payment-data fields (form descriptors) required for an outgoing transfer from the given account to the given recipient over the given payment system — e.g. the UAE purpose-of-payment code, or fields configured for the account's provid

GET

/Transfers/outgoing/additional-payment-fields

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/Transfers/outgoing/additional-payment-fields?accountId=undefined&recipientParticipantId=undefined&system=undefined'

Responses

🟢200

application/json

Request has been successfully completed.

Bodyapplication/json

Example

[
    {
        "key": "string",
        "displayName": "string",
        "type": "string",
        "required": true,
        "values": [
            {
                "key": "string",
                "displayName": "string"
            }
        ],
        "isMultipleChoice": true,
        "fieldValueFormatter": "string",
        "regex": "string",
        "regexError": "string",
        "allowedCharactersRegex": "string",
        "maxLength": 0,
        "minLength": 0,
        "conditions": [
            {
                "attribute": "string",
                "values": [
                    "string"
                ]
            }
        ]
    }
]

🟠400

🟠404

🟠422

🔴500

Modified at 2026-10-29 19:39:20

Check whether a confirmation document is required for an outgoing transfer with the given parameters.

Get the constraints configured for the transfer's reference and purpose, so the form can apply the provider's alphabet and length limits before the payment is sent. An empty array means nothing is configured and the platform defaults apply.