Transaction object

Learn how to use transactions in Mambu Payments (formerly Numeral)

A transaction is a debit or credit transaction booked on a connected account. Mambu Payments (formerly Numeral) connects to your bank to retrieve account statements and extract transactions.

Attribute

Description

id
string

The transaction ID

object
string

Always transaction.

connected_account_id
string

The ID of the connected account where the transaction has been booked.

booking_date
date

The transaction booking date.

value_date
date

The transaction value date.

category
string

The transaction category. Existing transaction categories include:

  • credit_transfer
  • credit_transfer_return
  • cash_concentration
  • direct_debit
  • direct_debit_return
  • 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

description
string

The transaction description.

direction
string

The transaction debit or credit direction.

amount
integer

The payment amount, in the currency's smallest unit.

For instance, euro smallest unit is cents and €20 is thus represented as 2000.

currency
string

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

external_account
object

The external account having sent or received the transaction. The account is either the debtor or the creditor, depending on the transaction direction.

The external_account object includes the following attributes:

  • account_number: the account number of the external account
  • holder_name: the name of the company or individual holding the account

external_account_id
string

When an external account has been detected on the transaction, this property holds the ID of the external account object.

internal_account_id
string

The ID of the internal account of type virtual, when a virtual account has been detected on the transaction.

internal_account
object

When a virtual account has been detected on the transaction, the property contains the details of the internal details account of type virtual. It can contain an account_number sub-property containing the detected virtual account number.

uetr
string

Unique end-to-end transaction reference

(UETR). Can be used to track payments with Swift GPI.

reconciliation_status
string

The reconciliation status of the transaction. Either unreconciled, reconciled, partially_reconciled or excluded. See Reconciliations for more details.

reconciled_amount
integer

The amount reconciled, calculated as the sum of the reconciliations created for this transaction.

bank_data
object

Bank data, such as message and transaction IDs, in JSON key:value format.

custom_fields
object

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

created_at
datetime

The UTC timestamp of the creation of this transaction.

Below is an example of a transaction:

{
   "id": "f6ada630-1774-46c1-a27f-1ce2f5fb8647",
   "object": "transaction",
   "connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
   "booking_date": "2025-01-18",
   "value_date": "2025-01-18",
   "category": "credit_transfer",
   "description": "MyCompany Invoice 5678",
   "direction": "credit",
   "amount": 2000,
   "currency": "EUR",
   "external_account": {
      "account_number": "FR5412739000504811631858C47",
      "holder_name": "Jane Doe"
   },
   "external_account_id": null,
   "internal_account": {
      "account_number": "FR4714508000301359366727T71"
   },
   "internal_account_id": null,
   "uetr": "e8a0e25e-8d56-4033-842d-9e2280a855f9",
   "reconciliation_status": "unreconciled",
   "reconciled_amount": 0,
   "bank_data": {
      "file_id": "26f4ca1c-65b0-412f-b464-206721d1e6d8",
      "statement_id": "STS-C4RR9YPLL0HHIFFHR-D8CET1",
      "end_to_end_id": "2144F77DJZB5949E0B15A7Z8923TX1"
   },
   "custom_fields": {},
   "created_at": "2025-01-19T00:11:07Z"
}