Get Payout Required Fields
GET {{baseUrl}}/v1/payout_methods/EU_sepa_bank/required_fields?beneficiary_country=FR&beneficiary_entity_type=individual&payout_amount=100&payout_currency=EUR&sender_country=FR&sender_currency=EUR&sender_entity_type=individual
Retrieve the fields required to use a payout method type. The fields are returned as an array of objects. The name of each field appears in the name field of each object. Use this information for Create Payout, Create Beneficiary and Create Sender. Note: The fields returned by this method are required when you create a payout. If you create a payout with a sender or beneficiary that was created previously, you are responsible for choosing a sender and beneficiary that have all the fields required by the payout method.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
beneficiary_country | string | (Required) Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase. | |
beneficiary_entity_type | string | (Required) Type of entity for the beneficiary. One of the following, individual, company | |
payout_amount | number | (Required) Amount of the payout, in units of the currency that the beneficiary is receiving. Decimal. | |
payout_currency | string | (Required) Currency received by the beneficiary. Three-letter ISO 4217 code. Uppercase. | |
sender_country | string | (Required) Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase. | |
sender_currency | string | (Required) Currency that the sender is paying with. Three-letter ISO 4217 code. Uppercase. | |
sender_entity_type | string | (Required) Type of entity for the sender. One of the following: individual, company | |
amount | number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"batch_file_header":"\u003cstring\u003e","beneficiary_country":"US","beneficiary_entity_type":"individual","beneficiary_required_fields":[{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"number"},{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"number"}],"image":"\u003cstring\u003e","is_cancelable":"\u003cinteger\u003e","is_expirable":"\u003cinteger\u003e","is_location_specific":"\u003cinteger\u003e","is_online":"\u003cboolean\u003e","maximum_amount":"\u003cnumber\u003e","maximum_expiration_seconds":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","minimum_expiration_seconds":"\u003cnumber\u003e","payout_currency":"PAB","payout_method_type":"\u003cstring\u003e","payout_options":[{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"boolean"},{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"string"}],"sender_country":"MX","sender_currency":"CUC","sender_entity_type":"individual","sender_required_fields":[{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"boolean"},{"allowed_values":"\u003cstring\u003e","description":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","name":"\u003cstring\u003e","regex":"\u003cstring\u003e","transfer_type":"\u003cstring\u003e","type":"number"}],"status":"\u003cinteger\u003e"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}