Create Recipient

The POST /recipients endpoint creates a new recipient record. This operation requires the necessary fields obtained from the GET /recipient-fields endpoint.

Implementation Guide:

  • Prerequisite: Ensure that the GET /recipient-fields endpoint is called first to retrieve the necessary fields for creating a recipient record.
  • Data Retrieval: The fields required for creating a recipient record are dynamic and may change based on the recipient type, destination country, destination currency, and transfer method. Always use the latest field requirements from the GET /recipient-fields endpoint.
  • Validate the request body against the field requirements obtained from the GET /recipient-fields endpoint to ensure all required fields are included and correctly formatted.
Body Params
string
enum
Defaults to PERSON

The type of recipient. See Recipient Type.

Allowed:
string
length between 3 and 3

The ISO 3166-1 alpha-3 code of the destination country.

string

The ISO 4217 code of the currency of the amount you would like to receive money. A string of exactly 3 uppercase alphabetical characters. This code is used to identify the currency in which the recipient will receive the funds.

string
enum
Defaults to BANK_ACCOUNT

The method of transfer (BANK_ACCOUNT, CASH_PICKUP, etc.).

Allowed:
string

Unique identifier for the sender.

fields
array of objects
required
fields*
Responses

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