Create Transfer Requests in Bulk

post

https://sandbox-api.readyremit.com/v2/transfer-requests/bulk

This operation takes in one or more Transfer Request records and ingests them into the Latitude system. The response from this endpoint will be the list of processed Transfer Requests. NOTE: This operation does not initiate any transfer of funds. Funds are transfered after a user collects their payment using the unique URL generated during this operation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

transferRequests

array of objects

required

length ≥ 1

transferRequests*

referenceId

string

required

length between 1 and 50

Unique ID used to reference the Transfer Request. Reference ID is used in reports, and by operations/support teams. This value is generated by you. Note: It is recommended to select a value that is already being used to reference this payment in your system. The Reference ID must be unique. Transfer Requests with duplicate Reference IDs will be rejected.

senderId

uuid

required

Unique ID provided by the ReadyRemit Integrations team referencing a specific sender configuration and account as the source of funds.

firstName

string

required

length between 1 and 50

Given name of the recipient (e.g. Jose)

lastName

string

required

length between 1 and 50

Surname of the recipient (e.g. Garcia)

secondLastName

string

length between 1 and 50

Maternal or second last name of the recipient (e.g. Lopez)

string

required

length between 1 and 50

Email address of the recipient. This will determine where notification emails are sent. (e.g. [email protected])

phone

string

required

length between 1 and 50

Phone number of the recipient (e.g. +1 555-555-5555).

addressLine1

string

length between 1 and 50

Address line 1 of the recipient mailing address (e.g. 123 Main St)

addressLine2

string

length between 1 and 50

Address line 2 of the recipient mailing address (e.g. Apt 123)

city

string

length between 1 and 50

City of the recipient mailing address (e.g. Tokyo, New York). NOTE: This field is required if one of the following corridors is enabled for PUSH_TO_CARD: AUS, BOL, ISR, JPN, MDV.

state

string

length between 1 and 50

State/Province of the recipient mailing address (e.g. NY, Guerrero). NOTE: This field is required if one of the following corridors is enabled for PUSH_TO_CARD: AUS, JPN, USA.

postalCode

string

length between 1 and 10

Zip/Postal code of the recipient mailing address (e.g. 10001, 12345). NOTE: This field is required if one of the following corridors is enabled for PUSH_TO_CARD: JPN.

countryCode

string

required

Country of the recipient mailing address in ISO 3 format (e.g. USA, JPN)

currencyCode

string

required

Currency of the Transfer Request source of funds in ISO 3 format (e.g. USD, JPY)

quoteBy

string

enum

required

Quoting by send or receive amount. Valid values are SEND_AMOUNT and RECEIVE_AMOUNT. If the value is SEND_AMOUNT then the amount received by the recipient is flexible based on rates and the amount sent by you the client will be fixed. If the value is RECEIVE_AMOUNT then the amount received by the recipient is fixed, and the amount sent by you, the client, will vary by rate.

Allowed:

amount

float

required

Amount of the Transfer Request in the currency designated in the currencyCode field. Correct decimal places must be used based on the currency. For example, USD requires 2 decimal places (200.00), JPY requires 0 decimal places (20000).

verificationCode

string

length between 1 and 50

Verification code the recipient will need to provide to receive the funds. If this property is left blank, the last 4 digits of the phone number will be used as a verification method. This value This value will not be returned in the response for security reasons.

supplementalInfo1

string

length between 1 and 50

Additional field for notes for cross reference

supplementalInfo2

string

length between 1 and 50

Additional field for notes for cross reference

supplementalInfo3

string

length between 1 and 50

Additional field for notes for cross reference

supplementalInfo4

string

length between 1 and 50

Additional field for notes for cross reference

201Transfer Request created

4XXDefault Response