Method ReverseOrder
ReverseOrder(AfterPayReverseOrderRequest, AfterPayCallContext)
Requests an order previously placed be reversed.
Declaration
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. |
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).
Exceptions
Type | Condition |
---|---|
AfterPayApiException | Thrown if the request is rejected by the AfterPay API. |
System.ArgumentNullException | Thrown if |