Refund transaction
Refunds a transaction, fully or partially.
If the transaction was not yet successfully captured, the refund will not be processed. Authorized transactions can be voided instead.
This endpoint requires the transactions.write
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID for the transaction to get the information for.
Body
A request to refund a transaction.
The amount requested to refund.
If omitted, a full refund will be requested for the main payment method.
When set, the amount must be lower than or equal to the remaining balance in the associated transaction. Negative and zero-amount refunds are not supported.
The target type to refund for. This can be used to target a gift card to refund to instead of the main payment method.
payment-method
, gift-card-redemption
The optional ID of the instrument to refund for. This is only required when
the target_type
is set to gift-card-redemption
.
An optional reason to attach extra context to the refund request.
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?