Get Schema

This API returns a dynamic schema that depends on the values of certain parameters. The schema contains the fields and validation rules for each payment scenario. A payment scenario is a combination of these parameters: is_external, country, transfer_method, currency, holder_type. To get the final schema, you need to submit the field values and re-render the form multiple times until all the fields are completed. For example, if you submit only the country parameter, the API will return a schema with the fields for country and transfer_method. If you submit the country and transfer_method parameters, the API will return a schema with the fields for country, transfer_method, currency, and so on.

Headers

X-BUSINESS-API-KEY

string

required

Body

application/json

is_external

boolean

true - for external beneficiaries, false - for own bank accounts (used for daily wallet payouts)

country

string

2-letter ISO 3166-1 country code

Required string length: 2

transfer_method

string

It's local or swift

currency

string

The supported currency.