Skip to main content
GET
Retrieve card transaction
This page documents the Legacy API. For new integrations, use Retrieve Card Transaction in the Current API.
Required permissions:
  • payout:account:read

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

payout:account:read

Parámetros de ruta

id
string
requerido

The card transaction ID (citx_xxx).

Respuesta

A successful response

A card transaction record.

authorization_method
string | null
requerido

How the card was presented or authenticated for the purchase.

Ejemplo:

"ecommerce"

card_id
string
requerido

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_amount
number | null
requerido

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

Ejemplo:

6.9

created_at
string<date-time>
requerido

The datetime the card transaction was created.

Ejemplo:

"2023-12-01T05:00:00.401Z"

currency
string | null
requerido

The ISO 4217 currency code for the transaction amount.

Ejemplo:

"USD"

declined_reason
string | null
requerido

The issuer-provided reason the transaction was declined.

Ejemplo:

"insufficient_funds"

id
string
requerido

The unique identifier for the card transaction.

international
boolean
requerido

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

local_amount
number | null
requerido

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

Ejemplo:

6.9

memo
string | null
requerido

A user-provided note attached to the transaction.

Ejemplo:

"Team dinner"

merchant_category
string | null
requerido

The enriched or raw category label for the merchant.

Ejemplo:

"Software"

merchant_category_code
string | null
requerido

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

Ejemplo:

"5734"

merchant_icon_url
string | null
requerido

A URL to the enriched merchant logo image.

Ejemplo:

"https://logo.clearbit.com/example.com"

merchant_name
string | null
requerido

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

Ejemplo:

"Acme Corporation"

posted_at
string<date-time> | null
requerido

When the transaction was settled by the card network.

Ejemplo:

"2023-12-01T05:00:00.401Z"

status
enum<string>
requerido

The current lifecycle status of the transaction.

Opciones disponibles:
pending,
completed,
reversed,
declined
transaction_type
string
requerido

The type of transaction.

Ejemplo:

"spend"

usd_amount
number | null
requerido

The transaction amount in USD.

Ejemplo:

6.9