Transactions
The Transactions API lets you read payments captured by your store and issue refunds against them.
Overview
The Transactions API provides endpoints to:
A transaction is a captured payment — a record exists only once a payment has settled, so every transaction has a settlement date. Reads are otherwise read-only; the only write is issuing a refund.
Refund state
There is no pending / failed / succeeded status on a transaction (a transaction record is itself a successful payment). Instead, each transaction exposes a derived refund state computed from how much of it has been refunded:
| Refund state | Meaning |
|---|---|
none | No refunds have been issued |
partial | Refunded less than the total |
full | Refunded the whole total (or more) |
The list endpoint's status filter accepts these values.
Refunds are recorded asynchronously
Issuing a refund initiates it at the payment provider and returns
202 Accepted. The refund record, its tax split, and the customer
notification are written later when the provider confirms the refund via
webhook. See Issue a refund for details.