Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

The card transaction ID, prefixed citx_.

Forespørgselsparametre

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.

Svar

card transaction found

card_id
string
påkrævet

The card this transaction was charged to, prefixed icrd_.

Eksempel:

"icrd_xxxxxxxxxxxxxx"

cardholder_id
string | null
påkrævet

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

Eksempel:

"user_xxxxxxxxxxxxxx"

cashback_usd_amount
number | null
påkrævet

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

Eksempel:

0.25

created_at
string
påkrævet

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

Eksempel:

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

currency
string | null
påkrævet

ISO 4217 currency code the merchant charged in.

Eksempel:

"EUR"

declined_reason
string | null
påkrævet

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

Eksempel:

"account_credit_limit_exceeded"

id
string
påkrævet

Card transaction ID, prefixed citx_.

Eksempel:

"citx_xxxxxxxxxxxxxx"

international
boolean
påkrævet

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

Eksempel:

true

levels_points
number | null
påkrævet

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.

Eksempel:

null

local_amount
number | null
påkrævet

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

Eksempel:

22.5

merchant_category
string | null
påkrævet

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

Eksempel:

"Car Care Supplies"

merchant_category_code
string | null
påkrævet

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

Eksempel:

"5533"

merchant_icon_url
string | null
påkrævet

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

Eksempel:

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

merchant_name
string | null
påkrævet

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

Eksempel:

"Lone Star Detail Supply"

posted_at
string | null
påkrævet

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

Eksempel:

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

status
enum<string>
påkrævet

Current status of the transaction.

Tilgængelige muligheder:
pending,
completed,
reversed,
declined
Eksempel:

"completed"

transaction_type
enum<string>
påkrævet

The kind of card transaction. Always spend today.

Tilgængelige muligheder:
spend
Eksempel:

"spend"

usd_amount
number | null
påkrævet

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

Eksempel:

24.99