Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:account:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The card transaction ID, prefixed citx_.

Queryparameters

account_id
string

The account that owns the transaction, prefixed biz_. Provide this or user_id. Defaults to the credential's account.

user_id
string

The user that owns the transaction, prefixed user_. Provide this or account_id. Only that user can read it.

Respons

card transaction found

card_id
string
vereist

The card this transaction was charged to, prefixed icrd_.

Voorbeeld:

"icrd_xxxxxxxxxxxxxx"

cardholder_id
string | null
vereist

The user the card is assigned to, prefixed user_. Null when the card has no assigned cardholder.

Voorbeeld:

"user_xxxxxxxxxxxxxx"

cashback_usd_amount
number | null
vereist

Cashback earned on this transaction as a USD amount. Zero for declined or ineligible transactions, and null when cashback has not been computed yet.

Voorbeeld:

0.25

created_at
string
vereist

When the transaction was authorized, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

currency
string | null
vereist

ISO 4217 currency code the merchant charged in.

Voorbeeld:

"EUR"

declined_reason
string | null
vereist

Why the transaction was declined. Null unless status is declined.

Voorbeeld:

"account_credit_limit_exceeded"

id
string
vereist

Card transaction ID, prefixed citx_.

Voorbeeld:

"citx_xxxxxxxxxxxxxx"

international
boolean
vereist

True when the merchant is outside the card's home country.

Voorbeeld:

true

levels_points
number | null
vereist

Whop Levels points this transaction earned for the business. Negative for a refund that takes them back. For a pending transaction, the points it will earn once it settles. Null when it earns none, such as a declined transaction.

Voorbeeld:

null

local_amount
number | null
vereist

Amount the merchant charged in their own currency. Pair with currency.

Voorbeeld:

22.5

merchant_category
string | null
vereist

Merchant category label, enriched where available and otherwise as the card network reported it.

Voorbeeld:

"Car Care Supplies"

merchant_category_code
string | null
vereist

Four-digit ISO 18245 merchant category code (MCC).

Voorbeeld:

"5533"

merchant_icon_url
string | null
vereist

URL of the enriched merchant logo. Null when no logo was matched.

Voorbeeld:

"https://shinetime.example/icons/lone-star-detail-supply.png"

merchant_name
string | null
vereist

Merchant name, enriched where available and otherwise as the card network reported it.

Voorbeeld:

"Lone Star Detail Supply"

posted_at
string | null
vereist

When the card network settled the transaction, as an ISO 8601 timestamp. Null until it settles.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

status
enum<string>
vereist

Current status of the transaction.

Beschikbare opties:
pending,
completed,
reversed,
declined
Voorbeeld:

"completed"

transaction_type
enum<string>
vereist

The kind of card transaction. Always spend today.

Beschikbare opties:
spend
Voorbeeld:

"spend"

usd_amount
number | null
vereist

Amount charged in USD. Negative when the merchant refunded the card.

Voorbeeld:

24.99