-
Eligibility
GET request to /v2/international/eligibility (see Check Eligibility).
-
Currencies
GET request to /v2/international/currencies (see List Available Currencies).
-
Quote
POST request to /v2/international/quotes (see Create a Quote).
-
Beneficiary
GET request to
/v2/international/beneficiaries. (see List Beneficiaries).
In both scenarios (create a new beneficiary or reuse an existing one), you will need to check if the user has to provide
more information to complete the transfer.
To do so, you have to make a POST request to /v2/international/beneficiaries/requirements(see
Check Beneficiary Requirements).
This endpoint returns the specific requirements the user must provide to properly configure the beneficiary.
After you have collected the required information, you have to either:
- Update the existing beneficiary by making a
PUTrequest to/v2/international/beneficiaries/{beneficiaryId}(see Update Beneficiary) - Create a new beneficiary by making a
POSTrequest to/v2/international/beneficiaries(see Create Beneficiary)
You may receive a new quote after creating or updating a beneficiary. Please use this new one to proceed with the
transfer.
-
Transfer
POST request to /v2/international/transfers/requirements
(see Check Transfer Requirements).
After you have collected the required information for the transfer, you can initiate the transfer by making a POST
request to /v2/international/transfers (see Create Transfer).
Summary
Here are the steps to follow when working with international transfers:- Check Eligibility: Ensure the organization is eligible for international transfers, by sending a
GETrequest to/v2/international/eligibility. - List Currencies: Retrieve the list of supported currencies by sending a
GETrequest to/v2/international/currencies. - Create a Quote: Obtain a quote for the transfer by sending a
POSTrequest to/v2/international/quotes. - List Beneficiaries: Check existing beneficiaries by sending a
GETrequest to/v2/international/beneficiaries. - Check Beneficiary Requirements: Ensure you have the necessary information for the beneficiary by sending a
POSTrequest to/v2/international/beneficiaries/requirements. - Create or Update Beneficiary: Either create a new beneficiary by sending a
POSTrequest to/v2/international/beneficiariesor update an existing one by sending aPUTrequest to/v2/international/beneficiaries/{beneficiaryId}. - Check Transfer Requirements: Gather the required information for the transfer by sending a
POSTrequest to/v2/international/transfers/requirements. - Create Transfer: Initiate the transfer by sending a
POSTrequest to/v2/international/transfers.