Get Form Fields

This API retrieves the list of required form fields needed to add a beneficiary on the platform.

The response is dynamically generated based on the provided query parameters, such as:

  • Beneficiary type (Individual or Business)
  • Beneficiary country
  • Beneficiary currency

Based on these inputs, the API returns the applicable field definitions, including mandatory fields, data types, and validation rules required to create a beneficiary.

This API helps ensure that the correct beneficiary information is collected according to country-specific, currency-specific, and compliance requirements.

Query Params
integer
enum
required
Allowed:
string
required

ISO alpha code - 3

string
required
Defaults to USD
Headers
string
required

Identifies the merchant making the request.

string
required

Public API key associated with the merchant.

string
required

RSA signature generated from the HMAC hash of the request payload.

string
required

Current UNIX timestamp (in seconds). Used to prevent replay attacks.

string
required

Unique UUID per request

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json