Submit a full or partial refund for an order that has been captured.
A successful synchronous response to this request does not mean the refund has been successfully executed, but rather that the refund has been added to the system and will be attempted. If the refund cannot be added to the system an error will be synchronously returned in the response to this message. Once the refund has been attempted, a notification will be sent indicating success or failure of the refund attempt.
Error Codes
Code | Description |
|---|---|
OrderStateInvalid | The specified order is not in the correct state and therefore refunds cannot be registered against it. |
AmountInvalid | The Amount did not meet the requirements documented for the request. |
RefundLimitExceeded | The refund could not be registered because doing so would cause the sum of refund amounts to exceed the original order amount. |
ReferenceIdMismatch | The ReferenceId specified in the request already exists for the order specified in the request and the remaining parameters do not match the existing refund. |
ReferenceIdInvalid | The ReferenceId is invalid because it begins with the reserved prefix. |
RefundPeriodEnded | The period in which the merchant is allowed to submit refunds for the order has ended. |
ChargebackExists | A refund cannot be submitted because there is a chargeback issued against the order. |