transactions

Get a specific transaction

[Protected by the scope transactions_read] This endpoint allows you to retrieve the information of a transaction

get/transactions/{id}

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/transactions/{id}
  • Auth: OAuth (defined in the document in a form this page cannot read)

Path parameters

idstring required

Identifier of the transaction

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Response

Transaction successfully retrieved

account_idstring required

Unique identifier of the account related to this transaction

amountnumber required

Amount of the transaction represented by a floating number. Amount is a signed float with the dot as separator. Example: 1000000.45

original_trx_idstring

ID of the original transaction (For TRANSACTION origin)

check_numberstring

Number of the check when applicable. The check number is deducted from the transaction wording.

type'CREDIT' | 'DEBIT' | 'INTEREST' | 'DIVIDEND' | 'BANK_FEE' | 'DEPOSIT' | 'ATM' | 'POINT_OF_SALE' | 'CREDIT_CARD_PAYMENT' | 'INTERNAL_TRANSFER' | 'POTENTIAL_TRANSFER' | 'CHECK' | 'ELECTRONIC_PAYMENT' | 'CASH' | 'DIRECT_DEPOSIT' | 'DIRECT_DEBIT' | 'REPEATING_PAYMENT' | 'OTHER' required

The transaction type.

  • CREDIT - Default type when it is not possible to determine the type of a revenue entry.
  • DEBIT - Default type when it is not possible to determine the type of a disbursement of money.
  • INTEREST - Interest on a bank account.
  • DIVIDEND - Payment of a company to its shareholders.
  • BANK_FEE - Fees on a bank account.
  • DEPOSIT - Deposit of money in an agency.
  • ATM - Withdrawing money from an ATM.
  • POINT_OF_SALE - Payment with a credit card.
  • CREDIT_CARD_PAYMENT - Month-end debit on a deferred card.
  • INTERNAL_TRANSFER - Transfer of money between two bank accounts of the same connection.
  • POTENTIAL_TRANSFER - Default type when it is not possible to determine the source or destination of a transfer.
  • CHECK - Transaction made by check.
  • ELECTRONIC_PAYMENT - The transaction is a documentary collection.
  • CASH - Transaction carried out using a physical currency (notes and coins).
  • DIRECT_DEPOSIT - Deposit of money made by a payer directly into the payee's bank account.
  • DIRECT_DEBIT - Transaction in which one person (or company) withdraws funds from another person's bank account.
  • REPEATING_PAYMENT - Recurring direct debit.
  • OTHER - When a transaction does not correspond to any of these types.
origin'ORIGINAL' | 'UPCOMING' | 'TRANSACTION' | 'RECURRING' | 'SCHEDULED' required

The origin of the transaction. Currently, only TRANSACTION origin are supported.

  • ORIGINAL - Not supported. When a transaction is subdivided into several transactions, the ORIGINAL origin refers to the original transaction.
  • UPCOMING - Not supported. Upcoming transaction in the budget forecast.
  • TRANSACTION - Bank transaction retrieved by the aggregation system.
  • RECURRING - Not supported. Recurring transaction in the budget forecast.
  • SCHEDULED - Not supported. Scheduled transaction in the budget forecast.
category_idstring required

Opaque unique id of the category

datenumber required

Transaction date as UTC timestamp in seconds. The hour, minutes and seconds are set back to 0 (midnight).

import_datenumber

Import date as UTC timestamp in seconds

booking_datenumber required

Booking date of the transaction over the account as UTC timestamp in seconds. If the transaction is not yet booked, this field must be valued with a scheduled booking date

transaction_datenumber

Transaction date as UTC timestamp in seconds.

Rendered when used :

  • For card transaction: date of the transaction
  • For credit transfer: acquiring date of the transaction
  • For direct debit: receiving date of the transaction
value_datenumber

Value date of the transaction as UTC timestamp in seconds.

labelstring

Transaction label after processing by our aggregation service. Main text displayed by the provider's service.

notesstring

Notes of the transaction after processing by our aggregation service. Secondary text displayed by the provider's service.

sourceTransactionSource

Third party properties

currencystring required

Currency of the account in the ISO4217 format. (3 letters. Examples : "EUR", "USD")

remittance_informationstring[]

Transaction original remittance information, as found on the ASPSP's web site (scraping) or as returned by the ASPSP's PSD2 API. For transactions obtained through scraping, this is an array of 1 or 2 lines, depending on how transactions are displayed on the ASPSP's web site. Most ASPSP web sites display transaction labels on 1 or 2 lines: the remittance_information follows what is found on the ASPSP web site. For transactions obtained through a PSD2 API, the array matches what the API returned.

status'BOOKED' | 'PENDING' | 'OTHER' | 'EXPIRED' | 'REJECTED' | 'CANCELLED' | 'REFUNDED'

The transaction status. Possible values are:

  • BOOKED - The transaction is booked.
  • PENDING - The transaction is not booked yet. This status is part of the STET API. The STET API states PENDING transactions do affect the instant balance. This has not been implemented correctly by all STET APIs.
  • OTHER - The transaction is not booked yet. This status is part of the STET API. The STET API states OTHER transactions do NOT affect the instant balance. This has not been implemented correctly by all STET APIs.
  • EXPIRED - Authorization expired. This status is not part of the STET API.
  • REJECTED - The transaction was rejected. This status is not part of the STET API.
  • CANCELLED - The transaction was cancelled. This status is not part of the STET API.
  • REFUNDED - The transaction has been refunded. This status is not part of the STET API.
idstring required

The unique transaction identifier. The value of this property corresponds to the value provided in the URL.

Changes

No recorded changes to this operation across all 1 revision of this API.