Create Refund

post https://global-api-sandbox.afterpay.com/v2/payments/{orderId}/refund

This endpoint performs a full or partial refund.

Log in to see full request history

📘
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.
Do not create refunds after 120 days from the date of purchase.

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, Afterpay-generated Refund ID.
`refundedAt`	string	The UTC timestamp of when the refund was completed, in ISO 8601 format.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

Errors

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_object`	The `refundMerchantReference` exceeded 128 characters.
422 Unprocessable Entity	`invalid_amount`	The `amount` requested exceeded the amount available.
422 Unprocessable Entity	`invalid_object`	The currency of the refund does not match the currency of the order (and the Merchant account).
422 Unprocessable Entity	`refund_timelimit_exceeded`	The refund exceeds the time limit of 120 days

Path Params

orderId

string

required

The unique Afterpay Order ID to apply the refund to.

Body Params

requestId

string

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

amount

object

required

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

merchantReference

string

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

refundMerchantReference

string

A unique reference for the individual refund event. If provided, the value will appear in the daily settlement file as "Payment Event ID". Limited to 128 characters.

Headers

Content-Type

string

required

Defaults to application/json

User-Agent

string

required

Defaults to Readme.io API Simulator

Accept

string

Defaults to application/json

Language

Credentials

Basic

base64


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://global-api-sandbox.afterpay.com/v2/payments/orderId/refund \
3
     --header 'Accept: application/json' \
4
     --header 'Content-Type: application/json' \
5
     --header 'User-Agent: Readme.io API Simulator' \
6
     --data '
7
{
8
  "amount": {
9
    "amount": "0.00",
10
    "currency": "USD"
11
  }
12
}
13
'

Click Try It! to start a request and see the response here!