API docs

Card transactions

Permission: card_transactions (read only).

A shop can run card payments through its card processor (Payroc). Every attempt at the processor is a card transaction:

  • terminal sales at the register
  • charges to a saved card, such as membership dues
  • pay-link payments
  • reversals and refunds

Declines, cancellations and failures are included too. Use this resource to reconcile against the processor's settlement reports. Card numbers and card tokens are never included.

Shops without card processing record card payments by hand and have no card transactions. Their card payments appear only on orders.

List

GET /v1/card-transactions (read). Oldest first, cursor-paginated.

Filter Notes
status One status (see the field table)
kind charge or refund
order_id The transactions behind one order
location_id One store
updated_since ISO-8601 date-time

GET /v1/card-transactions/{id} returns one transaction.

{
  "object": "card_transaction",
  "id": 204,
  "kind": "charge",
  "purpose": "sale",
  "mode": "terminal",
  "processor": "payroc",
  "status": "approved",
  "amount_cents": 4193,
  "approved_cents": 4193,
  "refunded_cents": 0,
  "card_brand": "visa",
  "card_last4": "0011",
  "entry_method": "contactless",
  "approval_code": "7A89FB",
  "message": "APPROVAL",
  "processor_ref": "M2MJOG6O2Y",
  "parent_id": null,
  "order_id": 9131,
  "account_payment_id": null,
  "membership_charge_id": null,
  "customer_id": 1402,
  "location_id": 3,
  "register_id": 5,
  "attached": true,
  "created_at": "2026-09-26T18:02:11Z",
  "completed_at": "2026-09-26T18:02:19Z",
  "updated_at": "2026-09-26T18:02:19Z"
}
Field Values / notes
kind charge or refund
purpose sale, account_payment, membership or invoice_link
mode terminal, token (a saved card), link (a pay link) or reference (a refund against a charge)
processor payroc, or simulator in a shop testing without a processor account
status pending, approved, declined, cancelled, failed, reversing, reversed (an unused charge given back), refunded (fully refunded)
processor_ref The processor's own id (the Payroc payment id) for matching settlement reports
parent_id On a refund, the charge it gives money back on
attached An approved charge has been attached to an order, account payment or dues charge. An approved charge left unattached for 10 minutes (for example, the register closed mid-sale) is reversed automatically, so the customer is never charged for a sale the shop didn't record.