Create external transfers with beneficiaries data

OAuth scope: payment.write

Accessible only using Strong Customer Authentication.

Example of SCA usage: Postman visual flow

Solo basic plans

Creates a single instant external transfer with beneficiary data.
Solo basic plans are not allowed to do bulk transfers. If a bulk transfer is attempted, it will fail and an error will be returned.

Rest of plans

Creates up to 400 instant external transfers with beneficiaries data.

This endpoint requires user interaction for approval of the external transfers. If you want to fully automate external transfers, check our POST /v2/external_transfers endpoint.

POST

external_transfers

checkout

curl --request POST \
  --url https://thirdparty.qonto.com/v2/external_transfers/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "debit_iban": "<string>",
  "external_transfers": [
    {
      "credit_iban": "<string>",
      "credit_account_name": "<string>",
      "credit_account_currency": "<string>",
      "reference": "<string>",
      "note": "<string>",
      "currency": "<string>",
      "scheduled_date": "2021-07-12",
      "amount": "<string>",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attachment_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}'

{
  "external_transfers": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "slug": "my-slug",
      "debit_iban": "string",
      "debit_amount": "12.55",
      "debit_amount_cents": "1255",
      "debit_currency": "EUR",
      "initiator_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiary_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "credit_amount": "12.55",
      "credit_amount_cents": "1255",
      "credit_currency": "EUR",
      "rate_applied": null,
      "payment_purpose": "goods",
      "reference": "my-reference",
      "note": "Some note",
      "declined_reason": null,
      "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",
      "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "errors": []
}

Authorizations

Authorization

string

header

required

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.

Headers

X-Qonto-Staging-Token

string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Body

application/json

Response

200

application/json

Returns the external transfers created.

The response is of type object.

Create an external transfer for a trusted beneficiary Create an insurance contract

curl --request POST \
  --url https://thirdparty.qonto.com/v2/external_transfers/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "debit_iban": "<string>",
  "external_transfers": [
    {
      "credit_iban": "<string>",
      "credit_account_name": "<string>",
      "credit_account_currency": "<string>",
      "reference": "<string>",
      "note": "<string>",
      "currency": "<string>",
      "scheduled_date": "2021-07-12",
      "amount": "<string>",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attachment_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}'

{
  "external_transfers": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "slug": "my-slug",
      "debit_iban": "string",
      "debit_amount": "12.55",
      "debit_amount_cents": "1255",
      "debit_currency": "EUR",
      "initiator_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiary_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "credit_amount": "12.55",
      "credit_amount_cents": "1255",
      "credit_currency": "EUR",
      "rate_applied": null,
      "payment_purpose": "goods",
      "reference": "my-reference",
      "note": "Some note",
      "declined_reason": null,
      "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",
      "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "errors": []
}