Transactions

GET /v1/transactions

Newest first, paged. Response: { "data": [Transaction], "meta": { "limit", "offset", "total" } }. Amounts are major-unit strings.

QueryDefaultDescription
limit10Page size (minimum 1, maximum 100)
offset0Rows to skip
startDate, endDate—Inclusive ISO 8601 bounds
status—For example settled, pending, completed
currency—ISO 4217 code
direction—incoming or outgoing
accountId—Internal account id or banking-partner account id
search—Free text. It never matches the banking partner's fee, and never a column your credential withholds
customerReference—Transactions carrying exactly this reference. LEGACY_UNSET returns older payout transactions Enovipay marked
customerId—Transactions linked to exactly this customer id

Filtering by customerReference or customerId is 403 FIELD_EXCLUDED when that field is withheld from your transaction reads.

transactionType includes inbound_external, payout, internal_transfer, fee_debit, return, fx, other.

meta.total counts every row that matches your filters and your credential's scope.

Expected deposits (pending)

While a declaration is open and your credential may read Deposit, the list also returns it as a pending incoming line:

FieldValue
statuspending
directionincoming
transactionTypeinbound_external
id and depositIdthe declaration id
lorumTransactionIdnull
matchStatusnull
amountthe declared amount, not yet credited

status=pending returns these lines. status=settled omits them. After a match the pending line leaves the list and the booked payment arrives under a new id. A credential without read Deposit sees booked rows only. These lines are not ledger rows and do not change your balance.

Customer and matching

Each booked row carries customer, matchStatus and depositId.

FieldDescription
customer.customerReferenceThe reference stored on the transaction. For a matched payment, the declaration's reference. It never changes once set
customer.customerIdThe linked customer, or null
matchStatusmatched, matched_amount_mismatch or unmatched for an incoming payment from a customer's bank. null for payouts, returns, internal transfers, and payments booked before matching existed
depositIdThe declaration the payment matched, or null

customer is always an object, with both fields null when the transaction has neither. amount is the amount credited to your account. Provider fee fields are not returned.

A withheld transaction field is absent. When the account read hides iban, accountIban is absent too.

GET /v1/transactions/:id

The same object as a list row, plus parentTransactionId and platform-fee fields when this row is a fee or a parent that has one. 404 if the id is unknown or belongs to another merchant. An open declaration's id is not a transaction id; read it with GET /v1/deposits/:id.


Did this page help you?