Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
transactions

List transactions

List and filter transactions.

get/transactions

Query parameters

limitinteger
starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the transaction.

end_datestring date

The creation date of the transaction.

start_booking_datestring date

The booking date of the transaction.

end_booking_datestring date

The booking date of the transaction.

start_value_datestring date

The value date of the transaction.

end_value_datestring date

The value date of the transaction.

direction'credit' | 'debit'

The direction of the transaction.

currencystring

The currency of the transaction. All ISO-4217 currency codes are supported.

counterparty_account_numberstring
counterparty_namestring
external_account_numberstring
external_account_holder_namestring
external_account_idstring
internal_account_idstring
amount_frominteger

The amount of the transaction.

amount_tointeger

The amount of the transaction.

virtual_account_numberstring
internal_account_numberstring
connected_account_idstring

The ID of the connected account related to the transaction.

file_idstring

The ID of the file including the transaction.

category'credit_transfer' | 'cash_concentration' | 'direct_debit' | 'cheque' | 'card' | 'lockbox' | 'counter_operation' | 'bill_of_order' | 'instant_credit_transfer' | 'other_payment' | 'cash_pooling' | 'account_balancing' | 'other_cash_management' | 'derivative' | 'loan' | 'fx' | 'precious_metals' | 'commodities' | 'trade_services' | 'securities' | 'account_management' | 'unavailable'

The category of the transaction.

Example:credit_transfer

The category of the transaction.

reconciliation_status'partially_reconciled' | 'reconciled' | 'excluded' | 'unreconciled'

The reconciliation status of the transaction, which is either unreconciled, reconciled, excluded or partially_reconciled.

The reconciliation status of the transaction.

uetrstring

Unique End-to-end Transaction Reference (UETR).

Response

200

Example response

{
  "records": [
    {
      "id": "f6ada630-1774-46c1-a27f-1ce2f5fb8647",
      "object": "transaction",
      "connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
      "booking_date": "2022-01-03",
      "value_date": "2022-01-03",
      "category": "credit_transfer",
      "description": "MyCompany Invoice 5678",
      "direction": "credit",
      "amount": 2000,
      "currency": "EUR",
      "counterparty_account": {
        "account_number": "FR5412739000504811631858C47",
        "holder_name": "Jane Doe"
      },
      "external_account": {
        "account_number": "FR5412739000504811631858C47",
        "bank_code": "BNPAFRPPXXX",
        "holder_name": "Jane Doe",
        "holder_address": {
          "line_1": "1, rue de la Bourse",
          "building_number": "1",
          "street_name": "rue de la Bourse",
          "postal_code": "59000",
          "city": "Lille",
          "country": "FR"
        }
      },
      "virtual_account_number": "FR4714508000301359366727T71",
      "internal_account": {
        "account_number": "FR4714508000301359366727T71",
        "holder_name": "John Doe"
      },
      "internal_account_id": "d08922ee-dce1-45dc-b9cd-c83251fb9fc5",
      "external_account_id": "d08922ee-dce1-45dc-b9cd-c83251fb9fc5",
      "bank_data": {
        "file_id": "26f4ca1c-65b0-412f-b464-206721d1e6d8",
        "statement_id": "STS-C4RR9YPLL0HHIFFHR-D8CET1",
        "end_to_end_id": "2144F77DJZB5949E0B15A7Z8923TX1"
      },
      "created_at": "2022-01-03T00:11:07Z"
    }
  ]
}