Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
transactions

Update transaction

Update a transaction.

post/transactions/{id}

Path parameters

idstring required

The ID of the transaction.

Request body

custom_fieldsCommonCustomFields

Custom fields in JSON key:value format. See Custom fields.

Response

200

idstring required

The UUID of the transaction.

object'transaction' required

Label used to identify this kind of object.

connected_account_idstring required

The ID of the connected account.

booking_datestring date required

The date when a transaction is registered on the account.

value_datestring date required

The date when a transaction is effectively credited or debited on the account.

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' required

The category of the transaction.

descriptionstring required

The description of the transaction.

direction'debit' | 'credit' required

The direction of the transaction, either debit or credit.

amountinteger required

The absolute value of the transaction, in the specified currency's smallest unit.

For euro transactions, the smallest unit is cents. €20 is represented as 2000.

currency'EUR' required

Currency in which an amount is expressed

virtual_account_numberstring required

The number of the virtual account linked to the transaction.

internal_account_idstring

The ID of the internal account linked to the transaction.

external_account_idstring

The ID of the external account linked to the transaction.

uetrstring uuid

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

custom_fieldsCommonCustomFields required

Custom fields in JSON key:value format. See Custom fields.

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

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

reconciled_amountinteger required

The amount of the transaction that is already reconciled. It is the sum of the amount of the reconciliations related to this transaction.

created_atstring date-time required

The UTC timestamp of the creation of this transaction.

Example response

{
  "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"
}