This endpoint performs a full or partial refund.

📘

Note

The refund operation is idempotent if a unique requestId and merchantReference are provided.

📘

Note

If using the Deferred Payment Flow, please be aware that only captured funds can be refunded.

Successful Response (201)

Returns a Refund object in response. All request parameters will be echoed in the response. In addition, the response includes the following:

AttributeTypeDescription
refundIdstringThe unique, permanent, Clearpay-generated Refund ID.
refundedAtstringThe UTC timestamp of when the refund was completed, in ISO 8601 format.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Create Refund:

HTTP Status CodeerrorCodeDescription
412
Precondition Failed
precondition_failedThe orderId is invalid, does not exist, or is not eligible for a refund. For example, the order was declined.
422
Unprocessable Entity
invalid_objectThe refundMerchantReference exceeded 128 characters.
422
Unprocessable Entity
invalid_amountThe amount requested exceeded the amount available.
422
Unprocessable Entity
invalid_objectThe currency of the refund does not match the currency of the order (and the Merchant account).
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!