Cancel Device Sale

Cancel Device Sale API allows partners to cancel and in-process on device sale transaction.

POST https://<Platform-host>/api/payment/cancel-device-sale

Request Body

Name	Type	Description
merchant_id*	string	Merchant ID
data.device_id*	string	Registered and connected device ID

200

Field Definitions

Field Name	Type	Description	Required?
id	string	Platform payment ID for the sale request when available	Optional
transaction_id	string	Unique transaction ID when available	Optional
merchant_id	string	Merchant ID	Required
device_id	string	Device ID from the request	Required
gateway_id	string	ID of the gateway through which the transaction is processed	Optional
cancel_device_sale_response.status	string	Cancellation Status PASSED | FAILED	Required
cancel_device_sale_response.response_message	string	Cancellation Response Message	Required

Request

{
    "merchant_id": "c03ce6ad-1e78-4bd7-ad35-e0d46b6b765d",
    "data": {        
        "device_id": "d9a63ebe-3036-4657-ba47-a4ad6e401b7c"
    }
}

Response

{
    "data": {
        "id": "d764f5a1-d269-43c8-bdeb-d3d469b2ada5",
        "transaction_id": "9732e3bd-008a-454e-b201-1d600ec95c3e",
        "merchant_id": "e6803b29-68a4-4c2a-b3ee-019dfad86c61",
        "device_id": "d9a63ebe-3036-4657-ba47-a4ad6e401b7c",
        "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
        "cancel_device_sale_response": {
            "status": "PASS",
            "response_message": "Transaction cancellation requested. If the transaction cannot be cancelled, you must process a void/refund request once the transaction is complete."
        }
    }
}

Webhook event: DEVICE_SALE_CANCEL

Webhook Payload Example

{
    "event_uid": "6452201be2d3597a92524b325e9b6282",
    "event": "DEVICE_SALE_CANCEL",
    "data": {
        "device_id": "08af6b55-03d9-4bdb-89cb-f895c22e1865",
        "account_id": "fdd24695-1298-496f-b997-89733fc17413",
        "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
        "payment_id": "9e037738-5731-4019-a212-42a97594258e",
        "merchant_id": "94f712c7-17fa-41c6-9c0a-8560db4fd225",
        "transaction_id": "9c5b1cb2-19d5-4aae-a246-987c9115da50",
        "cancel_device_sale_response": {
            "status": "PASS",
            "response_message": "Transaction cancellation requested. If the transaction cannot be cancelled, you must process a void/refund request once the transaction is complete."
        }
    }
}