Cards

List Card Transactions

Returns transactions for the cards you have access to. A purchase produces several entries: an authorization when the merchant places the hold, a clearing when the money moves, and a refund or reversal if it comes back. Entries that share a trace_id are the same purchase; it can be absent, in which case an entry stands alone. Every amount is positive and type carries the direction, so to total actual spend take the clearing entries minus the refund and reversal entries: an authorization and its clearing are the same money, so counting both doubles the purchase. Filter by card, status, merchant, date range, or amount.

get/cards/transactions

Request

Query parameters

card_idstring uuid nullable

Only transactions on this card.

statusesCardTransactionStatus[] nullable

Only transactions in these states.

merchant_namestring nullable

Only transactions whose merchant matches.

trace_idstring nullable

All entries of one purchase, by its trace_id.

from_authorized_atstring date-time nullable

Only transactions authorized at or after this.

to_authorized_atstring date-time nullable

Only transactions authorized at or before this.

Transaction filters. Every field is optional.

{
  "trace_id": "card_24692111234567890123456"
}
limitinteger

Maximum number of results to return.

offsetstring nullable

Opaque offset identifier for pagination. Use the nextOffset from a previous response.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

Example response

{
  "data": [
    {
      "card_last_four": "4242",
      "description": "WHISKER ROASTERS  PORTLAND OR",
      "amount": "48.20",
      "merchant_amount": "44.15",
      "merchant": {
        "name": "Whisker Roasters",
        "website": "https://whiskerroasters.com"
      },
      "memo": "Team lunch with the Catnip Coffee Co buyers",
      "trace_id": "card_24692111234567890123456"
    }
  ],
  "page": {
    "nextOffset": "qwer123454q2f"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.