API Reference
About ReadyRemitContact Us
Start typing to search…

Create Transfer

post
https://sandbox-api.readyremit.com/v1/transfers

The POST /transfers endpoint executes a transfer based on the provided transfer details.

Implementation Guide:

  • Prerequisite: Ensure that the GET /transfer-fields endpoint is called first to retrieve the necessary fields for executing a transfer.
  • Dynamic Fields: The fields required for executing a transfer are dynamic and may change based on the transfer details such as source and destination countries, currencies, and transfer method. Always use the latest field requirements from the GET /transfer-fields endpoint.
  • Validation: Validate the request body against the field requirements obtained from the GET /transfer-fields endpoint to ensure all required fields are included and correctly formatted.
  • Examples: See Posting a Transfer and the example request and response payloads below or to the right.
Body Params
string
required
length between 3 and 3

The ISO 3166-1 alpha-3 code of the destination country. This code is used to identify the country where the recipient's account is located. It ensures that the transfer is directed to the correct country. Example: "USA"

string
required

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. Example: "USD"

string
required

The ISO 4217 code of the currency of the amount you would like to send money. A string of exactly 3 uppercase alphabetical characters. This code is used to identify the currency in which the sender is transferring the funds. Example: "EUR"

string
enum
required
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, or push to card. Example- "BANK_ACCOUNT". See Transfer Method.

Allowed:
string
enum
required
Defaults to SEND_AMOUNT

This parameter determines how the quote is calculated, based on either the sender amount or the recipient amount. It helps in providing an accurate estimate for the transfer. See quoteBy. Example: "SEND_AMOUNT"

Allowed:
integer
required
≥ 0

Numeric value. The amount the sender wishes to transfer. Example- If you want to send 100 USD, this would be 10000. See how to format an amount based on the currency you would like to send or receive money.

integer
deprecated

The transaction fee associated with the transfer. Example: 499 ($4.99 USD)

string
required

The quote history ID from the GET /quote endpoint response.

string
required

Unique identifier for the recipient. This ID is used to track and manage the recipient within the system, ensuring that the transfer is directed to the correct recipient. Example: "a24d0ea7-401a-438e-8e88-0759622a9fb7"

string
required

Unique identifier assigned to the recipient's account. This ID is used to reference and manage the specific account within the system, ensuring that the funds are deposited into the correct account. Example: "ae22913a-521b-4d91-a86e-15c9c778bfaf"

integer
Defaults to 1

The purpose of the remittance. This field specifies the reason for the transfer, such as family maintenance, education, or medical expenses. It helps in categorizing and managing the transfer. Example: 1

boolean
Defaults to false

Controls whether to place a customer initiated hold on the transfer. If set to true, the transfer will be created in a held state and will not be processed until this hold is explicitly released. Note that transfers may also be subject to additional system-initiated holds independent of this setting. All holds (both customer-initiated and system-initiated) must be released before the transfer will be processed. Example: false

uuid | null

Optional unique identifier obtained from the GET /nonce endpoint. Use this to prevent duplicate transfer submissions. Each nonce can only be used once per customer. If a nonce has already been used, the transfer request will be rejected with an error. Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

fields
array of objects

A list of fields associated with the transfer. Each field contains specific information and attributes, such as field type and value, providing additional details required for the transfer.

fields
Responses

Updated 23 days 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 23 days ago