Skip to main content

Retrieve card payments

Retrieve card payments for the logged-in customer as aggregated lifecycle records. Each card payment bundles its authorization, settlements, and any later events under one id. To walk the individual events instead, see card payment events.

Get all card payments

GET/card_paymentsTry it

Returns the card payments for the logged-in customer, most recent first by default.

Query parameters

ParameterTypeNotes
cardIdstringFilter by the 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. the payment belongs to.
statusarrayFilter by one or more card payment statuses (SETTLEMENT_IN_PROGRESS, SETTLED, DECLINED, CANCELLED, EXPIRED).
typearrayFilter by one or more card payment types (PURCHASE, REFUND, ORIGINAL_CREDIT, ACCOUNT_FUNDING, CASH_WITHDRAWAL, BALANCE_INQUIRY).
subtypearrayFilter by one or more event subtypes, matched against the events timeline.
merchantNamestringPartial, case-insensitive match against the merchant name.
amountFrom, amountTointegerFilter by displayAmount.amount, in minor units.
relatedCardPaymentIdstringFilter for payments related to the given parent id.
creationTimestampFrom, creationTimestampTointegerFilter by creation time, in epoch milliseconds.
lastUpdatedTimestampFrom, lastUpdatedTimestampTointegerFilter by last-updated time, in epoch milliseconds.
offset, limitintegerStandard paging. limit is capped at 100.
sortOrderstringASC or DESC, on creationTimestamp. ASC is oldest first.

The card payment object

Each item in the response is a CardPayment:

FieldPurpose
idStable identifier across the entire payment lifecycle.
typeHigh-level type of the payment, derived from its first event.
statusLifecycle status of the payment.
displayAmountThe headline amount to show for the payment, as a { currency, amount } pair (amount in minor units).
cardThe 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. the payment was made with.
merchantThe merchant the payment was made to, including enhanced merchant data such as name, category code, address, website, and logo.
relatedCardPaymentIdLink to the parent payment this one derives from — set on a refund or a reversal, for example.
eventsThe ordered event stream for the payment. Use displayAmount for headline display, and walk events when you need the detail.
creationTimestampWhen the first event for the payment was received, in epoch milliseconds.
lastUpdatedTimestampWhen the most recent event was received, in epoch milliseconds.

A settled purchase looks like this (events abbreviated — see card payment events for the full event shape):

{
"id": "118000000000000000",
"type": "PURCHASE",
"status": "SETTLED",
"displayAmount": { "currency": "EUR", "amount": 4250 },
"card": { "id": "115000000000000000" },
"merchant": {
"name": "Amazon IT",
"categoryCode": "5942",
"country": "IT"
},
"events": [
{ "type": "AUTHORISATION", "reversal": false },
{ "type": "SETTLEMENT", "reversal": false }
],
"creationTimestamp": 1747000000000,
"lastUpdatedTimestamp": 1747200000000
}

Get a single card payment

GET/card_payments/{id}Try it

Returns a single card payment by id, including its full events array.

Response formats

Set the Accept header to choose the format: application/json for programmatic use, application/pdf for a rendered document, or text/csv for export.