v2

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-245593419.2 KB

Transactions

List transactions

OAuth scope: organization.read

Retrieves all transactions for a given bank account identified either by its bank_account_id either by its iban (cf. Query Parameters 👇)

get/v2/transactions

Query parameters

bank_account_idstring

Example:018f71db-c635-78b5-b90a-ea05de98c2bf

The id of the bank account for which transactions will be retrieved. Use /v2/organization to get this parameter. If both bank_account_id and iban are specified, bank_account_id takes precedence.

ibanstring

Example:FR7616798000010000005663951

The IBAN of the bank account for which transactions will be retrieved. Use /v2/organization to get this parameter. If both bank_account_id and iban are specified, bank_account_id takes precedence.

includes[]'vat_details' | 'labels' | 'attachments'

Use this query parameter to embed the associated resources (labels, attachments and/or VAT details) of the transactions in the JSON response.

status[]'pending' | 'declined' | 'completed'

Example:status[]=completed&status[]=declined&status[]=pending

Transactions can be filtered by their status attribute. <br>Possible values: <br>- pending: a transaction that is processing and has impacted the bank account's auth_balance but not its balance;<br>- declined: a transaction that has been declined;<br>- completed: a transaction that is completed, and has impacted the bank account's balance.

updated_at_fromstring

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

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

updated_at_tostring

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

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

emitted_at_fromstring

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

Transactions can be filtered by their emitted_at attribute. Can be use in combination with the emitted_at_to query parameter to get transactions emitted within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

emitted_at_tostring

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

Transactions can be filtered by their emitted_at attribute. This filter can be used in combination with the emitted_at_from query parameter to get transactions emitted within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

settled_at_fromstring

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

Transactions can be filtered by their settled_at attribute. This filter can be used in combination with the settled_at_to query parameter to get transactions settled within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

settled_at_tostring

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

Transactions can be filtered by their settled_at attribute. This filter can be used in combination with the settled_at_from query parameter to get transactions settled within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

side'credit' | 'debit'

Transactions can be filtered by their side attribute.

operation_type[]string

Example:operation_type[]=card&operation_type[]=transfer&operation_type[]=income

Transactions can be filtered by their operation_type attribute.

with_attachmentsboolean

Transactions can be filtered based on the presence of one or more attachments.

sort_bystring

Transactions can be sorted by a specific field and order (field:order format). <br>👉 Field: updated_at, settled_at or emitted_at <br>👉 Order: asc (Ascending) / desc (Descending)

Headers

X-Qonto-Staging-Tokenstring

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.

Response

Contains the list of transactions that contributed to the given bank account's balances (e.g., incomes, transfers, cards). All transactions visible in Qonto's UI can be fetched, as of API V2.

Example response

{
  "transactions": [
    {
      "amount_cents": 1000,
      "local_amount_cents": 1087,
      "local_currency": "USD",
      "vat_rate": 10
    }
  ]
}