Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

A card transaction record.

​
id
string
required

The unique identifier for the card transaction.

​
usd_amount
number | null
required

The transaction amount in USD.

Example:

6.9

​
authorization_method
string | null
required

How the card was presented or authenticated for the purchase.

Example:

"ecommerce"

​
created_at
string<date-time>
required

The datetime the card transaction was created.

Example:

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

​
card_id
string
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_amount
number | null
required

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

Example:

6.9

​
currency
string | null
required

The ISO 4217 currency code for the transaction amount.

Example:

"USD"

​
declined_reason
string | null
required

The issuer-provided reason the transaction was declined.

Example:

"insufficient_funds"

​
international
boolean
required

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

​
local_amount
number | null
required

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

Example:

6.9

​
memo
string | null
required

A user-provided note attached to the transaction.

Example:

"Team dinner"

​
merchant_category
string | null
required

The enriched or raw category label for the merchant.

Example:

"Software"

​
merchant_category_code
string | null
required

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

Example:

"5734"

​
merchant_icon_url
string | null
required

A URL to the enriched merchant logo image.

Example:

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

​
merchant_name
string | null
required

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

Example:

"Acme Corporation"

​
posted_at
string<date-time> | null
required

When the transaction was settled by the card network.

Example:

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

​
status
enum<string>
required

The current lifecycle status of the transaction.

Available options:
pending,
completed,
reversed,
declined
​
transaction_type
string
required

The type of transaction.

Example:

"spend"