Cancels

---

Use Cancels to stop a payment by canceling card authorization before the payment process has been completed. Only card payments can be cancelled, and some card issuing banks do not support cancelation of card payments.

Endpoints

POST /api/v2/merchants/{mid}/cancels/{orderId}

Cancels the payment authorization for a specified payment order.

Request parameters

Path parameter	Requirement	Description	Type
mid	Required	The merchant account reference number.	Number
orderId	Required	The reference to uniquely identify a payment.	String

Sample request

CURL

curl -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172' \
    https://    /api/v2/merchants/1570616552/orders/order_example_1/cancels

Sample response

REST API

{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderDetailDescription": "detailed desc",
    "orderDescription": "description",
    "orderAmount": 00.00,
    "fulfilmentAmount": 00.00,
    "capturedAmount": 0.00,
    "refundedAmount": 0.00,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 00.00,
    "baseFulfilmentAmount": 00.00,
    "baseCapturedAmount": 0.00,
    "baseRefundedAmount": 0.00,
    "capturable": true,
    "cancelable": true,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "transactionReferences": [
        {
            "transactionId": 5986908782,
            "transactionTypeId": 4,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "Cancel",
            "transactionDate": "2019-10-04T14:05:26.927Z",
            "refTransactionId": 5986909891,
            "transactionDesc": "Transaction Accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.50,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "acquirerAnswerCode": "00",
            "maskedAccountNumber": "411111xxxxxx1111",
            "cardExpiryDate": "12-2024",
            "cvResponse": "",
            "cvAnswerCode": 4,
            "avsResponse": "",
            "avsAnswerCode": 4
        }
    ]
}