id
string
required
date
string
required

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.

description
string
required
amountCents
number
required

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.

status
enum<string>
required
  • 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.
Available options:
pending,
posted,
failed
detailedStatus
enum<string>
required
  • 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 the refund status, and ACH returns, which use the returned 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 status settled for the ACH settling, and one transaction with status returned 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 status canceled.
  • dispute: Used for disputed card transactions.
Available options:
pending,
canceled,
failed,
settled,
declined,
refund,
reversed,
returned,
dispute
accountId
string
required

The account ID associated with the transaction

accountSubtype
enum<string>
required

For charge cards, specifies if the transaction belongs to the cash or credit account. For debit accounts, this field is always cash.

Available options:
cash,
credit
merchantDescription
string
deprecated

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.

merchantData
object

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.

cardId
string

The card ID associated with the transaction. If the transaction is not associated with a card, this field is not sent.

originalCurrency
object

The original currency of the transaction. This is only applicable to transactions. If this field is not sent, the original currency is in USD.

orderId
string

The order ID, as reported by the merchant, associated with the specific transaction.

referenceNumber
string

The reference number provided by Visa for this transaction.

authorizedAt
string

The UTC timestamp of when the transaction was authorized. Only exists for card transactions.

declineReason
string

The reason for the decline. Only exists for card transactions with detailedStatus = declined.