Skip to main content

Card payment events

Every card payment is made up of an ordered stream of events — one for each scheme message in its lifecycle. The aggregated payment gives you the headline view; the events give you the detail behind it: each authorization, settlement, refund, and reversal, with the amounts, fees, and merchant data that came with it.

You can read the events inline from a card payment's events array, or query a flat, chronological timeline across many payments with the events endpoint.

Event types

Each event has a type, and a reversal flag that distinguishes an original action from its reversal:

TypeDescription
AUTHORISATIONA request to hold funds. Carries the authorization result.
SETTLEMENTA confirmation that moves the held funds to the merchant.
REFUNDA return of funds to the cardholder from the merchant.
ORIGINAL_CREDITA pushed credit to the card.

A reversal: true event reverses a prior event of the same kind in the lifecycle — for example a merchant void or expiry against an authorization, or a reversal of a settlement, refund, or original credit. The subtype field carries the card-scheme network classification of the underlying transaction, such as sale_purchases, cash_withdrawals, mail_or_telephone_orders, purchase_refunds, or original_credit_transactions.

Event fields

All events share a common set of fields:

FieldPurpose
idIdentifier for the event.
type, subtype, reversalWhat kind of event this is, its network classification, and whether it reverses a prior one.
cardPaymentIdThe parent card payment this event belongs to.
transactionAmountThe amount in the transaction currency.
billingAmountThe amount in the card's billing currency.
userAmount, userExchangeRateThe amount and rate presented to the cardholder. When the card has a user currency set, they are expressed in that currency.
authCodeThe issuer authorization code, echoed by later events in the same payment.
feesFees applied as part of this specific event, such as a forex markup.
timestampWhen the event occurred at the point of interaction, in epoch milliseconds.
processedTimestampWhen the platform processed the event, in epoch milliseconds.
card, merchantThe card and merchant context for the event.

Some fields are specific to the event type:

  • Authorization events add result (APPROVED or DECLINED), authorisationCategory (PRE_AUTH or FINAL_AUTH), forex (the rate applied and the cushion held for rate movement before settlement), authForwardingDetails, and — when declined — a declineReason (for example INSUFFICIENT_BALANCE, SCA_REQUIRED, or AUTH_RULE_CHECKS_FAILED).
  • Settlement events add settlementState (PENDING or COMPLETED) and the settlement exchangeRate.
  • Refund and original credit events add a network reasonCode and the exchangeRate.

Get all card payment events

GET/card_payment_eventsTry it

Returns a flat, chronological list of events across one or more card payments. Each entry carries the event together with its parent card payment context — the card and merchant.

Query parameters

ParameterTypeNotes
cardPaymentIdstringFilter events to a single card payment.
cardIdstringFilter events to those on a single managed cardManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User..
typearrayFilter by one or more event types.
subtypearrayFilter by one or more network subtypes.
reversalbooleanFilter by the reversal flag.
timestampFrom, timestampTointegerFilter by event time, in epoch milliseconds.
offset, limitintegerStandard paging. limit is capped at 100.
sortOrderstringASC or DESC, on the event timestamp. Defaults to DESC (most recent first).

The events endpoint supports the same Accept formats as the card payments endpoint: application/json, application/pdf, and text/csv.

When to use which

Use GET /card_payments when you want payments as whole units — a list to show a customer, or a single payment with its lifecycle. Use GET /card_payment_events when you need the message-level detail across payments, for reconciliation, investigation, or a card-level activity feed.