Transactions

The transactions resource is a merged list of charges and refunds into a single timeline. It is designed to allow the user to have a filterable “feed” of activity that debits or credits money.

It is recommended to use this resource instead of the list charge and list refund routes.

The transaction history object

Fields
merchant_idstring (UUID)
The unique identifier for the merchant the charge was made to.
merchant_namestring
The name of the merchant.
store_idstring (UUID)
The unique identifier for the store the charge was made to.
store_namestring
The store of the merchant.
resource_idstring (UUID)
The unique identifier for the resource this entry refers to. If the type is charge it is is the id of the charge, if it is refund, it is the id for the refund.
amountnumber
The amount of money that was charged/refunded.
amount_formattedstring
The amount that was charged/refunded formatted
to include a decimal place if there is a minor currency unit.
currencystring (ISO-4217)
The currency of the transaction.
typestring
One of charge or refund.
statusstring
One of the charge or refund statuses.
payment_typestring
The type of payment method for the transaction
modestring
live or test.
metadatajson
The metadata associated with the charge.
bank_transfer_latest_deposit_datestring (ISO-8601)
The date of deposit for bank_transfer payment type charges.
bank_transfer_payment_statusstring
The payment status for bank_transfer payment type charges. One of unpaid, insufficient, exact, exceeded.
created_onstring (ISO-8601)
The date the refund was created on.