Get refund
Gets information about a refund.
This endpoint requires the transactions.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID of the refund.
Response
A refund record.
A refund is always associated with a single transaction, while a transaction can potentially have several refunds.
The type of this resource. Is always refund
.
refund
The unique ID of the refund.
The ID of the transaction associated with this refund.
The payment service's unique ID for the refund.
The status of the refund. It may change over time as asynchronous processing events occur.
processing
- The refund is being processed.succeeded
- The refund was successful.declined
- The refund was declined by the underlying PSP.failed
- The refund could not proceed due to a technical issue.voided
- The refund was voided and will not proceed.
processing
, succeeded
, declined
, failed
, voided
The currency code for this refund. Will always match that of the associated transaction.
The amount requested for this refund.
The reason for this refund. Could be a multiline string.
The date and time when this refund was created.
The date and time when this refund was last updated.
The type of the instrument that was refunded.
payment-method
, gift-card-redemption
The optional ID of the instrument that was refunded. This may be null
if
the instrument was not stored.
Was this page helpful?