International Payments
Cross River offers a set of APIs to enable cross border money movement for International Payments.
International Payments APIs are found in the internationalmodule of our COS sandbox.
Get started with Cross River APIs.
This table presents APIs that we describe in detail.
Action | API Call | Description |
|---|---|---|
GET /International/v1/estimates | Returns the estimated cost of sending an international payment, including the exchange rate | |
GET /International/v1/meta/quote-requirements | Returns country-specific fields you need to submit when requesting a quote | |
POST /International/v1/quotes | Requests an executable payment quote for sending either USD or foreign currency before actually sending funds | |
POST /International/v1/payments | Executes a payment quote to send funds internationally |
Returns an estimate of an exchange rate. The estimate shows the current foreign exchange rate, including spread and the transaction fee. Unlike a quote, no beneficiary data is required and the estimate cannot be executed.
The estimate is not saved.
IMPORTANT You must have a value for either a fromAmount or a toAmount, but not both.
Money amounts in API calls and responses are written without a decimal point between the dollars and the cents.
Returns the country-specific fields you need to submit when requesting a quote.
Money amounts in API calls and responses are written without a decimal point between the dollars and the cents.
The attributes in the response are required for the quote with the parameters defined in the request for this call (except where indicated in the table below). The values provided describe the required responses. For example, for lastName the value is ^.{1,255}, indicating that the regular expression characters are permitted, up to 255 characters maximum. The bankCountry is fr, as provided in the request.
Calls an executable international payment quote that returns the cost of the transfer, including any fees and the exchange rate to a foreign currency.
Many beneficiary details are conditionally optional depending on destination country. Call GET /International/v1/meta/quote-requirements for a list of specific required parameters for your quote.
You need beneficiary details to create a quote. You use the value of the id attribute in the response (the Quote ID) to originate an international transfer. Quotes are typically valid for only 30 seconds.
IMPORTANT You must have a value for either a fromAmount or a toAmount, but not both.
bankCountry is always a required field.
Other attributes may or may not be required depending on the country and other parameters.
Money amounts in API calls and responses are written without a decimal point between the dollars and the cents.
Originates a cross border money transfer.
You must get a quote ID using the Request a payment quote call. The quote ID is returned in the id field in the response to that call.
Quote IDs submitted in request are typically only valid for 30 seconds.
Money amounts in API calls and responses are written without a decimal point between the dollars and the cents.
Event Name | Description |
|---|---|
International.Hold.Cleared | Hold on payment cleared. Funds sent. |
International.Hold.Escalated | Payment on hold and status escalated. Additional actions needed. |
International.Payment.Sent | Funds sent via a wire payment to the receiver bank |
International.Payment.Canceled | Payment canceled at partner request |
International.Payment.Returned | Payment rejected by the receiving bank |
