Get the API 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:country, transfer_method,transfer_type, currency, holder_type and bank_swift_code. 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.

post/v1/beneficiaries/schema

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

countrystring

2-letter ISO 3166-1 country code

transfer_methodstring

The transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account

transfer_typestring

The transfer type needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account

currencystring

It is beneficiary bank account currency

holder_type'individual' | 'company'

The type of the account holder. Individual is for personal accounts, and company is for business accounts.

bank_swift_codestring

The bank swift code is a unique identifier for a specific bank.

Example request

{
  "country": "sg",
  "transfer_method": "bank_transfer",
  "transfer_type": "local",
  "currency": "sgd",
  "holder_type": "company",
  "bank_swift_code": "AEIBSGSXXXX"
}

Response

200

Changes

No recorded changes to this endpoint across all 2 revisions of this API.