Reverse Payment By Token

This endpoint performs a reversal of the checkout that is used to initiate the Afterpay payment process. This will cancel the order asynchronously as soon as it is created without the need of an additional call to the void endpoint. In order for a payment to be eligible, the order must be in a Captured state and must be issued within 10 minutes of the order being created. If this is called after a timeout is received from [`v1/payments/capture`](Capture-Payment.v1.yaml/paths/~1v1~1payments~1capture/post), and `v1/payments/capture` eventually completes successfully, the order will end up in a `REVERSED` state. This is similar to a call to the [`v1/payments/refund`](Create-Refund.v1.yaml/paths/~1v1~1payments~1{orderId}~1refund) endpoint except that merchant fees are not paid to Afterpay and the capture and refund will not show up in the settlement file. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 70 |

Authentication

AuthorizationBasic

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

Path Parameters

environmentstringRequiredDefaults to api-sandbox

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

tokenstringRequired
Order token that was used to complete payment.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Response

The Reversal endpoint indicates a successful response with a 204 status code response. Returns no content in the response.

Errors