Method ReverseOrder

ReverseOrder(AfterPayReverseOrderRequest, AfterPayCallContext)

Requests an order previously placed be reversed.

Declaration
public Task<AfterPayOrderReversal> ReverseOrder(AfterPayReverseOrderRequest request, AfterPayCallContext requestContext)
Parameters
Type Name Description
AfterPayReverseOrderRequest request

A AfterPayReverseOrderRequest containing details of the order to be reversed.
AfterPayCallContext requestContext

A AfterPayCallContext instance containing additional details required to make the request.
Returns
Type Description
Task<AfterPayOrderReversal>

An AfterPayOrderReversal containing details of the reversed order within the AfterPay system.
Implements
Remarks

This method is intended to ensure an order is cancelled when it's status is/was unknown at the time the customer was present. It should not be used for refunds, see RefundOrder(AfterPayCreateRefundRequest, AfterPayCallContext).

This method will keep retrying until success, or a non-409 response error is received. If an exception of any type other than AfterPayApiException, , is thrown by this method, a reversal should be retried later.

This method will automatically retry on timeout up to MinimumRetries. If the last retry times out, a will be thrown. On a 409 response it will retry until any other error or response is received.

Exceptions
Type Condition
AfterPayApiException

Thrown if the request is rejected by the AfterPay API.
System.ArgumentNullException

Thrown if request or requestContext is null.
System.UnauthorizedAccessException

Thrown if the system cannot obtain an authorisation token from AfterPay before making the request.
System.TimeoutException

Thrown if the request times out on the last retry attempt. . If this type of exception the reversal must be retried later.