Payout Requirements

Get Payout Methods Requirements

GET /corridor/{corridor_id}/{payout_method_id}/requirements

Description

The endpoint is designed to retrieve the necessary fields required for a specified payout method within a given corridor. This helps users understand what information is mandatory for both senders and receivers to successfully process a payout via the selected method. By specifying the corridor and payout method IDs, users can obtain detailed requirements such as field names, data types, and whether or not each field is required, which facilitates a seamless transaction process.

200

{
    "sender_requirements": [
        {
            "field_uid": "d888abb2-50a9-43cf-917d-b6a28413a59b",
            "field_name": "sender_email",
            "label": "Sender email",
            "one_of": [],
            "value": "",
            "data_type": "TEXT",
            "value_type": "TEXT",
            "value_regex": "",
            "require_rule": false,
            "mapping_field_name": null,
            "order_id": null
        },
        {
            "field_uid": "5e4eaf5f-80c7-4281-9817-ad6c646eacb8",
            "field_name": "source_of_funds",
            "label": "Source of funds",
            "one_of": [
                "Compensation",
                "Donation",
                "Other"
            ],
            "value": "",
            "data_type": "SELECT",
            "value_type": "TEXT",
            "value_regex": "",
            "require_rule": true,
            "mapping_field_name": null,
            "order_id": null
        },

    ],
    "receiver_requirements": [
        {
            "field_uid": "90ed8315-c00e-43c3-9702-acd4e9ba9cd5",
            "field_name": "beneficiary_account_number",
            "label": "Beneficiary bank account number",
            "one_of": [],
            "value": "",
            "data_type": "TEXT",
            "value_type": "TEXT",
            "value_regex": "",
            "require_rule": true,
        },
        {...},
        ...
     ],
}

Explanation of Sender and Receiver Requirements

The response contains requirements for both the sender and receiver. Each requirement includes:

• field_uid: Unique identifier for the field.

• field_name: The internal name of the field (e.g., bank_name).

• label: The display name of the field for users.

• require_rule: Indicates if the field is mandatory.

• data_type: Describes the type of data expected (e.g., SELECT,BOOLEAN,NUMBER).

• one_of: If the data type is SELECT, a list of valid options is provided (e.g., "Chase", "Wells Fargo", "Bank of America").

• value: Placeholder for the field value.

• value_type: Specifies the type of value (e.g., STRING).

• value_regex: A regular expression defining valid input for the field (e.g., ^.{1,30}$).