Create Refund

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

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 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path parameters

orderIdstringRequired

The unique Cash App Afterpay Order ID to apply the refund to.

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

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, Cash App 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 or null

Object containing amount and currency

merchantReferencestring or null

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

refundIdstring or null

The unique, permanent, Cash App Afterpay-generated Refund ID.

refundMerchantReferencestring or null<=128 characters

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

refundedAtstring or null

requestIdstring or null

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

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/payments/orderId/refund"
4
5	payload = {
6	"requestId": "49efce77-4bf2-4e41-86e8-c2b92f493c2a",
7	"amount": {
8	"amount": "10.00",
9	"currency": "AUD"
10	},
11	"merchantReference": "merchantRefundId-1234",
12	"refundMerchantReference": "merchantRefundId-1234",
13	"refundId": "67890123",
14	"refundedAt": "2023-01-01T00:00:00.000Z"
15	}
16	headers = {
17	"User-Agent": "User-Agent",
18	"Authorization": "Basic <username>:<password>",
19	"Content-Type": "application/json"
20	}
21
22	response = requests.post(url, json=payload, headers=headers)
23
24	print(response.json())

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	}

Authentication

Path parameters

Headers

Request

Response

Errors