For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • GETList Payments
      • POSTAuth
      • POSTCapture Full Payment
      • GETGet Payment By Order ID
      • PUTUpdate Payment by Order ID
      • POSTCapture Payment
      • PUTUpdate Shipping Courier
      • POSTCreate Refund
      • POSTVoid
      • GETGet Payment By Token
      • POSTReverse Payment By Token
LogoLogo
ReferencePayments

Create Refund

POST
/v2/payments/:orderId/refund
POST
/v2/payments/:orderId/refund
$curl -X POST https://global-api-sandbox.afterpay.com/v2/payments/orderId/refund \
>     -H "User-Agent: User-Agent" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "requestId": "49efce77-4bf2-4e41-86e8-c2b92f493c2a",
>  "amount": {
>    "amount": "10.00",
>    "currency": "AUD"
>  },
>  "merchantReference": "merchantRefundId-1234",
>  "refundMerchantReference": "merchantRefundId-1234",
>  "refundId": "67890123",
>  "refundedAt": "2023-01-01T00:00:00.000Z"
>}'
1{
2  "amount": {
3    "amount": "10.00",
4    "currency": "AUD"
5  },
6  "merchantReference": "merchantRefundId-1234",
7  "refundId": "67890123",
8  "refundMerchantReference": "merchantRefundId-1234",
9  "refundedAt": "2023-01-01T00:00:00.000Z",
10  "requestId": "49efce77-4bf2-4e41-86e8-c2b92f493c2a"
11}
This endpoint performs a full or partial refund. The refund operation is idempotent if a unique `requestId` and `merchantReference` are provided. If using the Deferred Payment Flow, be aware that only captured funds can be refunded. Do not create refunds after 120 days from the date of purchase. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 70 |
Was this page helpful?
Previous

Void

Next
Built with

This endpoint performs a full or partial refund. The refund operation is idempotent if a unique requestId and merchantReference are provided.

If using the Deferred Payment Flow, be aware that only captured funds can be refunded. Do not create refunds after 120 days from the date of purchase.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read70

Authentication

AuthorizationBasic

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

Path parameters

orderIdstringRequired
The unique Afterpay Order ID to apply the refund to.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Request

This endpoint expects an object.
requestIdstringOptional

Unique ID required for safe retries. Max length 64 (varchar).

amountobjectOptional
Object containing amount and currency
merchantReferencestringOptional

The merchant’s internal refund id/reference. This must be included along with the requestId to utilise idempotency. Max length 85 (varchar).

refundMerchantReferencestringOptional<=128 characters

A unique reference for the individual refund event. Max length 128 (varchar).

Response

Returns a Refund object in response. All request parameters are 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](https://www.iso.org/iso-8601-date-and-time-format.html) format. |
amountobject
Object containing amount and currency
merchantReferencestring

The merchant’s internal refund id/reference. This must be included along with the requestId to utilise idempotency. Max length 85 (varchar).

refundIdstringRead-only

The unique, permanent, Afterpay-generated Refund ID.

refundMerchantReferencestring<=128 characters

A unique reference for the individual refund event. Max length 128 (varchar).

refundedAtstringRead-only
requestIdstring

Unique ID required for safe retries. Max length 64 (varchar).

Errors

412
Precondition Failed Error
422
Unprocessable Entity Error

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

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