Sign in
Card transactions

Retrieve card transaction

Retrieves a single card transaction by ID.

Required permissions:

  • payout:account:read
get/card_transactions/{id}

Path parameters

idstring required

The card transaction ID (citx_xxx).

Response

A successful response

authorization_methodstring nullable required

How the card was presented or authenticated for the purchase.

card_idstring required

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

cashback_usd_amountnumber nullable required

The cashback reward amount earned on this transaction, in USD.

created_atstring date-time required

The datetime the card transaction was created.

currencystring nullable required

The ISO 4217 currency code for the transaction amount.

declined_reasonstring nullable required

The issuer-provided reason the transaction was declined.

idstring required

The unique identifier for the card transaction.

internationalboolean required

Whether the transaction was made with a merchant outside the card's home country.

local_amountnumber nullable required

The transaction amount in the merchant's local currency before conversion.

memostring nullable required

A user-provided note attached to the transaction.

merchant_categorystring nullable required

The enriched or raw category label for the merchant.

merchant_category_codestring nullable required

The four-digit ISO 18245 merchant category code (MCC).

merchant_icon_urlstring nullable required

A URL to the enriched merchant logo image.

merchant_namestring nullable required

The enriched or raw name of the merchant where the purchase was made.

posted_atstring date-time nullable required

When the transaction was settled by the card network.

status'pending' | 'completed' | 'reversed' | 'declined' required

The lifecycle status of a card transaction.

transaction_typestring required

The type of transaction.

usd_amountnumber nullable required

The transaction amount in USD.

Example response

{
  "authorization_method": "ecommerce",
  "cashback_usd_amount": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "currency": "USD",
  "declined_reason": "insufficient_funds",
  "local_amount": 6.9,
  "memo": "Team dinner",
  "merchant_category": "Software",
  "merchant_category_code": "5734",
  "merchant_icon_url": "https://logo.clearbit.com/example.com",
  "merchant_name": "Acme Corporation",
  "posted_at": "2023-12-01T05:00:00.401Z",
  "transaction_type": "spend",
  "usd_amount": 6.9
}

Changes