Overview
Entities
Legal Entity
Virtual Account
Transaction
Card
Card Group
Get transaction fee details
Fetch breakdown of a fee transaction
Authentication from public API requests
Authorizations
Authentication from public API requests
Path Parameters
Response
The date in UTC time when the transaction was posted. If the transaction is pending or failed, this is the date the transaction was created.
The amount of the transaction in cents in USD. If the transaction amount is negative, the transaction is a debit. If the transaction amount is positive, the transaction is a credit.
pending
: The transaction is pending and has not been posted to the account yet (the account's posted balance doesn't reflect the transaction yet, but the account's available balance does).posted
: The transaction has been posted to the account and the account's posted balance and available balances both reflect the transaction.failed
: The transaction failed to post to the account and no longer affects the account's available or posted balances.
pending
, posted
, failed
pending
: Used for any transaction type that has not posted to the account yet, but is affecting the account's available balance.canceled
: Used for any transaction that was canceled.failed
: Used for any transaction that failed to post to the account.settled
: Used for any transaction that has posted to the account, except for card refunds, which use therefund
status, and ACH returns, which use thereturned
status.declined
: Used for card transactions that were declined.refund
: Used for card transactions that were refunded, increasing the account's available and posted balances.reversed
: Used for card transactions that were authorized, but reversed by the merchant.returned
: Used for ACH returns. In the case of an ACH return, there are two possibilities: (1) if the ACH settled and then returned, then there will be one transaction with statussettled
for the ACH settling, and one transaction with statusreturned
for the ACH return. Both of these are posted transactions. (2) if the ACH returned before settling, then there will only be one transaction with statuscanceled
.dispute
: Used for disputed card transactions.
pending
, canceled
, failed
, settled
, declined
, refund
, reversed
, returned
, dispute
The account ID associated with the transaction
For charge cards, specifies if the transaction belongs to the cash or credit account. For debit accounts, this field is always cash.
cash
, credit
DEPRECATED. Use merchantData.description
instead. For card transactions, the description of the transaction as reported by the merchant. For other transactions, this field is undefined.
For card transactions, contains description of the transaction as reported by the merchant, merchant category code, and location of the merchant or origin of the transaction. For other transactions, this field is undefined.
The raw description provided by the merchant for the transaction.
The merchant's category code (MCC)
Location details for the merchant/transaction.
The city of the merchant.
The state/province of the merchant.
The country of the merchant.
The ZIP/postal code of the merchant.
The card ID associated with the transaction. If the transaction is not associated with a card, this field is not sent.
The original currency of the transaction. This is only applicable to transactions. If this field is not sent, the original currency is in USD.
The original currency code of the transaction
The amount of the transaction in its original currency in cents.
The conversion rate used to convert the transaction amount from its original currency to the account currency. The currency rate is computed at the time of the transaction.
The order ID, as reported by the merchant, associated with the specific transaction.
The reference number provided by Visa for this transaction.
The UTC timestamp of when the transaction was authorized. Only exists for card transactions.
The reason for the decline. Only exists for card transactions with detailedStatus
= declined
.
The account that this card is associated with
The last 4 digits of the card number
The name assigned to the card that appears on the user dashboard
The month the card expires formatted as MM (01, 02, ..., 12)
The year the card expires formatted as YYYY (2024, 2025, ...)
The status of the card
active
, paused
, inactive
, closed
When true, a physical card has been issued. Otherwise, this is a virtual card.
The virtual account that this card is associated with
When true, the card will be automatically closed after a single authorization attempt. Note that the card will be closed even if the authorization declines or drops
This field contains the full PAN which will only be sent on a request for a single card when you set the query param "include_pan" to "true"
This field will contain full CVV which will only be sent on a request for a single card when you set the query param "include_pan" to "true"
The card group the card belongs to.
The spending constraint applied to the card
Arbitrary information that can be attached to the card. See the PATCH /card/{cardId}
endpoint for more details on how to add user data.
The ID of the card product this card was created with.