Create Refund

POST

https://global-api-sandbox.afterpay.com/v1/payments/:orderId/refund

POST

https://global-api-sandbox.afterpay.com/v1/payments/:orderId/refund

This endpoint performs a full or partial refund.

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

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:

Attribute	Type	Description
`refundId`	string	The unique, permanent, Clearpay-generated Refund ID.
`refundedAt`	string	The UTC timestamp of when the refund was completed, in ISO 8601 format.

Timeout	Time (Seconds)
Open	10
Read	70

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

HTTP Status Code	errorCode	Description
412 Precondition Failed	`precondition_failed`	The `orderId` is invalid, does not exist, or is not eligible for a refund. For example, the order was declined.
422 Unprocessable Entity	`invalid_amount`	The `amount` requested exceeded the amount available.
422 Unprocessable Entity	`unsupported_currency`	The currency of the refund does not match the currency of the order (and the Merchant account).

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

orderIdstringRequired

The unique Clearpay Order ID to apply the refund to.

This endpoint expects an object.

amountobjectRequired

The refund amount. The refund amount can not exceed the payment total.

requestIdstringOptional

A unique request ID, required for safe retries. It is recommended that the merchant generate a UUID for each unique refund.

merchantReferencestringOptional

The merchant’s internal refund id/reference. This must be included along with the requestId to utilise idempotency.

$	curl -X POST https://global-api-sandbox.afterpay.com/v1/payments/orderId/refund \
>	-H "User-Agent: User-Agent" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"amount": {
>	"amount": "0.00",
>	"currency": "GBP"
>	}
>	}'

$	curl -X POST https://global-api-sandbox.afterpay.com/v1/payments/orderId/refund \
>	-H "User-Agent: User-Agent" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"amount": {
>	"amount": "0.00",
>	"currency": "GBP"
>	}
>	}'