Skip to main content
A card transaction represents one card use end-to-end: an in-store purchase, an online checkout, an ATM withdrawal, or a third-party push to the card. Reap captures every authorization, clearing, reversal, refund, and decline that the card network sends, and exposes the result as a single transaction resource that evolves over time. You do not poll the card network or reconcile authorizations against clearings yourself. Reap does that, and you read the current state through the API or react to it through webhooks.

Anatomy of a transaction

Every transaction carries the same envelope of identifying fields, plus a status-specific amount shape and a chronological event log.
FieldDescription
idThe transaction ID. Stable across the full lifecycle.
accountId, cardIdThe account and card the transaction was made on.
statusPENDING, CLEARED, DECLINED, or VOID. See Lifecycle.
channelHow the transaction was initiated: POS, ECOMMERCE, ATM, or VISA_DIRECT.
digitalWalletAPPLE_PAY, GOOGLE_PAY, MERCHANT_TOKEN (the merchant stored the card for a recurring or saved-card payment), or null if no digital wallet was used.
merchantMerchant name, city, country, MCC code, and MCC category.
currencyThe card’s billing currency. Always USD.
originalCurrencyThe currency the merchant charged in. Equal to currency for same-currency transactions, otherwise the merchant’s local currency.
amount, originalAmountAmount charged to the cardholder (in currency) and amount the merchant charged (in originalCurrency). The shape of these fields varies by status. See Amounts.
conversionRateEffective rate Reap applied to convert originalAmount to amount. Present on PENDING and CLEARED; absent on VOID and DECLINED.
eventsChronological log of every lifecycle event (authorization, clearing, reversal, refund, decline). Oldest first.
declineReasonPresent only on DECLINED transactions. See Decline reasons.
occurredAtWhen the underlying card activity happened.
createdAt, updatedAtWhen Reap first recorded the transaction and last modified it.
The response shape is a discriminated union on status. DECLINED transactions carry a declineReason and a flat originalAmount. PENDING, CLEARED, and VOID carry breakdowns instead, because their amounts can move as reversals, clearings, or refunds arrive. See Amounts for the per-status field shapes and Lifecycle for how they change.

Retrieving transactions

There are two endpoints, used for different jobs.

List activities

Use List activities to fetch a user’s card history. This is the primary way to read transactions, because card transactions are part of a unified activity feed that also contains crypto deposits and (in Program-Funded programs) virtual asset postings. The feed is chronologically ordered and paginated, which matches what most product surfaces (transaction history screens, statements, exports) actually need. To scope the feed to card transactions:
  • type=CARD_TRANSACTION returns only card transactions.
  • accountId=<id> scopes to one account (typically a user).
  • cardId=<id> scopes to a specific card.
  • cardTransactionStatus=PENDING,CLEARED filters by status (comma-separated).
Each item in the response carries the full card transaction object under data, identical to what Get a card transaction by ID returns.

Get a card transaction by ID

Use Get a card transaction by ID when you already have a transaction ID and want its current state. Common cases: rendering a transaction detail screen or refreshing a single row in your UI. The response schema is identical to items returned by the activities endpoint.

Reacting to changes

Subscribe to webhooks instead of polling.
EventWhen it fires
CARD_TRANSACTION_CREATEDA new transaction is recorded for the first time (a new authorization, a decline, or a standalone refund).
CARD_TRANSACTION_UPDATEDAn existing transaction receives a new lifecycle event (clearing, reversal, refund, or a previously pending transaction transitioning to declined).
Both events carry the full transaction object. The events array on the payload always reflects the complete history at the time of delivery, so you do not need to stitch events together across deliveries. Use the event id for idempotency. See Webhooks for delivery, retries, and signature verification.

Next

Lifecycle

The four statuses and the scenarios that drive them.

Amounts

Per-status amount fields, currency, and conversion rate.

Decline reasons

Every code that can appear on a declined transaction.