Request payment quote
API reference
This API calls an executable international payment quote that returns the cost of the transfer, including any fees and the exchange rate to a foreign currency.
IMPORTANT! 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.
For an example of how to request a quote for currencies using Payment Purpose Codes, please refer to the Payment purpose codes page.
For payments to Mexico and China, take note of the instructions in the beneficiaryFi section relating to accountNumber, routingCodeType1, routingCodeValue1, and iban.
Endpoint: /international/v1/quotes
POST
https://sandbox.crbcos.com/International/v1/quotes
curl --location 'https://sandbox.crbcos.com/International/v1/quotes' \
--data '{
"currency": "gbp",
"accountNumber": "158560897007",
"fromAmount": "500",
"toAmount": "",
"beneficiary": {
"firstName": "Jon",
"lastName": "Smith",
"fullName": "JonSmith",
"birthDate": "2001-06-18T13:05:09.015Z",
"address": "1 Street",
"city": "Winfield",
"stateProvince": "",
"postalCode": "GB12345",
"countryCode": "GB",
"entityType": "Individual"
},
"beneficiaryFi": {
"bankName": "Bank UK",
"bankCountryCode": "GB",
"bankAddress": "1 Avenue",
"bankAccountType": "Checking",
"routingCodeType1": "SortCode",
"routingCodeValue1": "123456789",
"routingCodeType2": "aba",
"routingCodeValue2": "123456789",
"bicSwift": "TGCLGB99",
"iban": "GB33BUKB20201555555555"
},
"originator": {
"entityName": "Cross River Bank",
"firstName": "",
"lastName": "",
"fullName": "Cross River Bank",
"address": "885 Teaneck Road",
"city": "Teaneck",
"state": "NJ",
"postalCode": "07666",
"countryCode": "US",
"entityType": "Company",
"birthDate": "2008-06-23",
"identificationType": "IncorporationNumber",
"identificationValue": "0400170263"
},
"priority": true,
"purpose": "SRV"
}'
For additional information, refer to our International payments tutorial.