Calculate transfer routes

POST {{baseUrl}}/transferRoutes/calculate

Returns available transfer routes based on a combination of transfer country, currency, counterparty, and priorities. Use this endpoint to find optimal transfer priorities and associated requirements before you make a transfer.

Request Body

{"balancePlatform"=>"{{YOUR_BALANCE_PLATFORM}}", "currency"=>"USD", "category"=>"bank", "counterparty"=>{"bankAccount"=>{"accountIdentification"=>{"type"=>"iban", "iban"=>"NL91ABNA0417164300"}}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

"{\n \"transferRoutes\": [{\n \"country\": \"NL\",\n \"currency\": \"USD\",\n \"priority\": \"crossBorder\",\n \"requirements\": [{\n \"description\": \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n ,\n \"min\": 100,\n \"type\": \"amountMinMaxRequirement\"\n}, {\n \"description\": \"Country, street and city is required.\",\n \"requiredAddressFields\": [\"line1\", \"city\", \"country\"],\n \"type\": \"addressRequirement\"\n}, {\n \"description\": \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\": [\"iban\", \"numberAndBic\"],\n \"type\": \"bankAccountIdentificationTypeRequirement\"\n}, {\n \"issuingCountryCode\": \"NL\",\n \"paymentInstrumentType\": \"BankAccount\",\n \"type\": \"paymentInstrumentRequirement\"\n}]\n}, {\n \"country\": \"NL\",\n \"currency\": \"USD\",\n \"priority\": \"wire\",\n \"requirements\": [{\n \"description\": \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n ,\n \"min\": 100,\n \"type\": \"amountMinMaxRequirement\"\n}, {\n \"description\": \"Country, street and city is required.\",\n \"requiredAddressFields\": [\"line1\", \"city\", \"country\"],\n \"type\": \"addressRequirement\"\n}, {\n \"description\": \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\": [\"iban\", \"numberAndBic\"],\n \"type\": \"bankAccountIdentificationTypeRequirement\"\n}, {\n \"issuingCountryCode\": \"NL\",\n \"paymentInstrumentType\": \"BankAccount\",\n \"type\": \"paymentInstrumentRequirement\"\n}]\n}]\n}"