Invoice Cancellation

In order to cancel an invoice, you need to send a POST request.

Invoice cancellation

POST https://api.cryptocloud.plus/v2/invoice/merchant/canceled

To cancel an invoice, send a request specifying a unique identifier. The request will be successful only if the invoice has a status of created.

Request Body

Name	Type	Description
uuid*	string	Unique invoice identifier (INV-XXXXXXXX or XXXXXXXX)

200: OK Successful response: Invoice has been cancelled

{
    "status": "success",
    "result": [
        "ok"
    ]
}

400: Bad Request Error: Invoice is not created

{
    "status": "error",
    "result": {
        "validate_error": "Invoice is not created"
    }
}

400: Bad Request Error: uuid is required

{
    "status": "error",
    "result": {
        "validate_error": "uuid is required"
    }
}

Request examples

These examples show how you can submit a request to cancel an invoice. Note that you need to provide your API key in the Authorization header to successfully authorize the request.

cURL

curl -X POST https://api.cryptocloud.plus/v2/invoice/merchant/canceled \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"uuid":"INV-XXXXXXXX"}'

Python

import requests

url = "https://api.cryptocloud.plus/v2/invoice/merchant/canceled"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "uuid": "INV-XXXXXXXX"

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Fail:", response.status_code, response.text)

JavaScript

fetch('https://api.cryptocloud.plus/v2/invoice/merchant/canceled', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({ uuid: 'INV-XXXXXXXX' })
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Fail: ' + response.status + ' ' + response.statusText);
    }
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));

PHP

<?php

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.cryptocloud.plus/v2/invoice/merchant/canceled");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array("uuid" => "INV-XXXXXXXX")));
$headers = array(
    "Authorization: Token <API KEY>", 
    "Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {

    $statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($statusCode == 200) {
        echo "Success: " . $response;
    } else {
        echo "Fail: " . $statusCode . " " . $response;
    }
}
curl_close($ch);
?>