Skip to content

Cancel Order

The CancelOrder method can be sent to void the authorization before any payment on an order have been made (CaptureOrder or auto-settled InitiatePayment). This is only supported for card payments, and may not be supported by all banks.

CURL
curl -X POST \
  https://api.test.payments.worldline.com/api/v2/merchants/1570616552/orders/order_example_1/cancels \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'
  -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172'
REST API
POST /api/v2/merchants/1570616552/orders/order_example_1/cancels HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172
Web Service
<CancelOrderRequest>
    <OrderInfo>
        <OrderId>order_example_1</OrderId>
    </OrderInfo>
    <RequestInfo>
        <TransactionChannel>Web Online</TransactionChannel>
    </RequestInfo>
    <MerchantInfo>
        <MerchantId>1570616552</MerchantId>
    </MerchantInfo>
</CancelOrderRequest>

CancelOrder retry support

The CancelOrder method supports retries. i.e., the request can be sent multiple times with the same parameters without any side effects, until a terminal response is received. This is useful if e.g., the response from the bank is delayed, not received at all or pending, but a terminal response is still required by the merchant.

In order to use the retry capability, the merchant defined requestId parameter must be included in the first and all subsequent retried CancelOrder requests within the same scope. The RequestId must be unique per MerchantId.

CURL
TBD
REST API
TBD
Web Service
TBD
Back to top