OAuth scope: international_transfers.write
Creates a new international transfer.
This endpoint is still in beta. Please get in touch with our team if you have any question or feedback: here.
quote_id
: The ID of the quote you got in the previous steptarget_account_id
: The account_id of the beneficiary, obtained after creating or updating the beneficiaryrequirements
field is an array, with only one item in it (or 0 if everything is already configured).
Like the beneficiary requirements endpoint, you will retrieve all fields that are required to complete the transfer, so
you will have to collect the required information from the user.
For instance, if the requirements look like this:
reference
information.
When you collect the required information, you may be asked to call again this endpoint (boolean
refresh_requirements_on_change
). You have to add the key
of the field and the value
(provided by the user)
in the details
object.
source.funds
means that the field is an object with a funds
property, you should call our api
with the following payload:Bearer authorization header: Bearer <token>
, where <token>
is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Language to be used to display the requirements. Languages supported: en, it, es, de, fr, pt
"en"
Returns the list of international transfer's requirements
The response is of type object
.