Create Refund

This endpoint performs a full or partial refund.

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

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

This endpoint performs a full or partial refund. The refund operation is [idempotent](../../docs/online-api/idempotent-requests.md) if a unique requestId and merchantReference are provided. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 70 |

Authentication

AuthorizationBasic

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

Path parameters

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

orderIdstringRequired

The unique Afterpay Order ID to apply the refund to.

Request

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.

Response

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](http://www.iso.org/iso/home/standards/iso8601.htm) format. |

Errors

412

Precondition Failed Error

422

Unprocessable Entity Error

This endpoint performs a full or partial refund.

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

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

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

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

The unique Afterpay Order ID to apply the refund to.

This endpoint expects an object.

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

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

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

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.

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.

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

Connection Timeouts

Authentication

Path parameters

Headers

Request

Response

Errors

Connection Timeouts

Authentication

Path parameters

Headers

Request

Response

Errors