Invoice Cancellation

The method allows you to cancel a specific created invoice by sending a POST request.

What the method allows you to do

Cancels an invoice with the created status

Endpoint

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

Headers

Name

Type

Example

Description

Authorization*

string

Token eyJ0eXAiOiJK<...>4npi1ksS8tSY

Project API key

Request Body

Key parameters

Name

Type

Example

Description

uuid*

string

INV-89UX09KA

Unique invoice identifier

Request examples

These examples show how to send a request to cancel an invoice. Note that the invoice must have the created status.

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"}'

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)

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

$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);
?>

Response examples

A successful request returns a response with the status success and a result object.

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

Response parameters

A successful request returns a response with the status success and a result object.

Name

Type

Example

Description

status

string

success

Response status

result

string

An object describing a successful response or an error

PreviousInvoice Creation NextInvoice List

Last updated 9 hours ago

Was this helpful?

hashtagWhat the method allows you to do

hashtagEndpoint

hashtagHeaders

hashtagRequest Body

hashtagRequest examples

hashtagResponse examples

hashtagResponse parameters

What the method allows you to do

Endpoint

Headers

Request Body

Request examples

Response examples

Response parameters