A refund is a resource used to reverse a charge (partially or entirely) to a customer. This can be due to reasons such as fraud, an erroneous order, or a duplicate charge. A refund must be requested in the same currency that the charge was made in, and the amount refunded must be less then or equal to the amount of the charge. Multiple refunds can be made on the same charge as long as the total refund amount does not exceed the charge amount.
Refunds are processed asynchronously. When created, they will start in the
pending state and then automatically update to a
error status. To be notified of the final state of a refund, you can register a webhook for the
When a refund is made, the transaction fee for the refunded charge is still charged to the merchant.
Please refer to the test card numbers for test data information.
The refund object
The unique identifier of the refund.
The unique identifier of the store that the charge belongs to.
The unique identifier of the charge that is being refunded.
The status of the refund. One of
The amount to be refunded.
The currency of the amount to be refunded.
The amount that was refunded formatted to include a decimal place if there is a minor currency unit.
The reason for refunding the customer. Must be one of
chargeback status cannot be set by a merchant and happens when the charge is rejected by the card company at a later time.
An additional message on why the refund was made.
The error code of why a charge failed or errored.
A short description of why a a charge failed
Additional details of why a charge failed
Any user defined metadata associated with the refund.
The date the refund was created on.