API Reference
About ReadyRemitContact Us

Create Recipient Account

post
https://sandbox-api.readyremit.com/v1/recipients//accounts

The POST /recipients/{recipientId}/accounts endpoint creates a new account record for a specified recipient.

Implementation Guide:

  • Ensure that the GET /recipient-account-fields endpoint is called first to retrieve the necessary fields for creating a recipient account record.
  • The fields required for creating a recipient account 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-account-fields endpoint.
Path Params
uuid
required

Unique identifier for the recipient.

Body Params
string
length between 3 and 3
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.

string
enum
Defaults to BANK_ACCOUNT

The method used for transferring money. This field specifies how the funds will be delivered to the recipient's account, such as via bank account, cash pickup, push to card, or account funding. Example- "BANK_ACCOUNT". See Transfer Method.

Allowed:
string
fields
array of objects
fields
Responses

Updated 3 months ago

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