GET
/
v2
/
external_transfers
curl --request GET \
  --url https://thirdparty.qonto.com/v2/external_transfers \
  --header 'Authorization: Bearer <token>'
{
  "external_transfers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "debit_iban": "<string>",
      "debit_amount": "12.55",
      "debit_amount_cents": "1255",
      "debit_currency": "EUR",
      "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "initiator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credit_amount": "<string>",
      "credit_amount_cents": "<string>",
      "credit_currency": "<string>",
      "rate_applied": "<string>",
      "payment_purpose": "goods",
      "reference": "<string>",
      "note": "<string>",
      "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",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": "<any>",
    "prev_page": "<any>",
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}

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.

Query Parameters

​
status
enum<string>[]

External transfers can be filtered by their status. This filter accepts an array of statuses.

Available options:
pending,
processing,
canceled,
declined,
settled
Example:

"status[]=processing&status[]=declined&status[]=settled"

​
updated_at_from
string

External transfers can be filtered by their updated_at property. This filter can be used in combination with the updated_at_to query parameter to get external transfers updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10T11:47:53.123Z"

​
updated_at_to
string

External transfers can be filtered by their updated_at property. This filter can be used in combination with the updated_at_from query parameter to get external transfers updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10T11:47:53.123Z"

​
scheduled_date_from
string

External transfers can be filtered by their scheduled_date property. This filter can be used in combination with the scheduled_date_to query parameter to get external transfers scheduled within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10"

​
scheduled_date_to
string

External transfers can be filtered by their scheduled_date property. This filter can be used in combination with the scheduled_date_from query parameter to get external transfers scheduled within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10"

​
beneficiary_ids[]
string[]

External transfers can be filtered by their beneficiary_id. You can provide a list of ids.

​
sort_by
enum<string>
default:updated_at:desc

External transfers can be sorted by their scheduled_date / updated_at property in 2 possible orders: asc (Ascending) / desc (Descending).

Available options:
updated_at:asc,
updated_at:desc,
scheduled_date:asc,
scheduled_date:desc
​
page
string

Returned page (cf. Pagination).

​
per_page
string

Number of external transfers per page (cf. Pagination).

Response

200
application/json
Returns the list of external transfers for the authenticated organization.

The response is of type object.