Create an external transfer with trusted beneficiary
OAuth scope: payment.write
Automated creation of a instant external transfer with no user interaction involved once the beneficiary is trusted.
This endpoint allows you to execute transfers for a given beneficiary. The beneficiary must be trusted for the transfer to be created. The beneficiary can only be trusted through the Qonto web-app (for more details, please refer to this article).
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. The idempotency key must be a unique string. We recommend using a UUID.
Request parameter details
X-Qonto-Idempotency-Key header
This is a unique string (we advise to use a uuid) that identifies a transfer. This is used by Qonto to prevent "double spending" by accidentaly replaying the same API call.
Amount and Currency
- The amount corresponds to the amount of the transaction in the currency of the bank account. Amounts must be https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value
- The currency should be EUR.
Reference
- Transfer reference that can be used to enter transfer details to further describe the transfer
- Maximum reference length is 99 characters
Debit iban
- debit_iban: IBAN of account to debit
Attachments
You can link up to 5 attachments per transfer by passing the attachment_ids parameter. You can upload your attachments using our POST /v2/attachments endpoint. Note: For SEPA transfers above 30,000 EUR at least one attachment is required
Request
- Base URLhttps://thirdparty.qonto.com
- AuthOAuth 2Authorization codehttps://oauth.qonto.com/oauth2/authToken URLhttps://oauth.qonto.com/oauth2/tokenScopespayment.write
Headers
This parameter is required. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. The idempotency key must be a unique string. We recommend using a UUID.
Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.
Request body
Example request
{
"external_transfer": {
"scheduled_date": "2021-07-12"
}
}Response
returns an external transfer
Example response
{
"external_transfer": {
"debit_amount": "12.55",
"debit_amount_cents": "1255",
"debit_currency": "EUR",
"payment_purpose": "goods",
"declined_reason": "beneficiary_bic_invalid",
"status": "pending",
"scheduled_date": "2021-07-12",
"created_at": "2021-01-27T22:05:07.000Z",
"completed_at": "2021-01-27T22:05:07.000Z",
"processed_at": "2021-01-27T22:05:07.000Z"
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.