Invoice List

To get a list of all invoices, send a POST request to the following URL:

Invoice list

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

When you send this request, you will receive a list of invoices for the specified period. The maximum number of records per request is 100. By default, the response will contain 10 records.

Request Body

Name	Type	Description
start*	String	Date in format «dd.mm.yyyyy»
end*	String	Date in format «dd.mm.yyyyy». Must be later or equal to start.
offset	Int	This is the number of the initial record from which data output will start. For example, if you set offset=10, the data will start to be displayed from the 11th record.
limit	Int	This is the number of the last record you want to receive. For example, if limit=20, you will get records up to and including the 20th, starting from the one specified in offset

200: OK Successful response

{
    "status": "success",
    "result": [
        {
            "uuid": "INV-XXXXXXXX",
            "created": "2023-01-01 12:00:00.000000",
            "address": "",
            "currency": {
                "id": 4,
                "code": "USDT",
                "fullcode": "USDT_TRC20",
                "network": {
                    "code": "TRC20",
                    "id": 4,
                    "icon": "https://cdn.cryptocloud.plus/currency/crypto/TRX.svg",
                    "fullname": "Tron"
                },
                "name": "Tether",
                "is_email_required": false,
                "stablecoin": true,
                "icon_base": "https://cdn.cryptocloud.plus/currency/icons/main/usdt.svg",
                "icon_network": "https://cdn.cryptocloud.plus/icons-currency/USDT-TRC20.svg",
                "icon_qr": "https://cdn.cryptocloud.plus/currency/icons/stroke/usdt.svg",
                "order": 1
            },
            "date_finished": null,
            "expiry_date": "2023-01-02 12:00:00",
            "side_commission": "client",
            "side_commission_cc": "merchant",
            "type_payments": "crypto",
            "status": "created",
            "is_email_required": false,
            "project": {
                "id": 1,
                "name": "My store",
                "fail": "https://test.com/fail?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "success": "https://test.com/success?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "logo": "None"
            },
            "tx_list": [],
            "test_mode": false,
            "type": "up",
            "user_email": "",
            "pay_url": "None",
            "phone": "",
            "order_id": "1111",
            "amount_in_crypto": null,
            "amount_in_fiat": 100,
            "amount": 100.0,
            "amount_usd": 100.0,
            "amount_to_pay": 101.4,
            "amount_to_pay_usd": 101.4,
            "amount_paid": 0.0,
            "amount_paid_usd": 0.0,
            "fee": 1.4,
            "fee_usd": 1.4,
            "service_fee": 0,
            "service_fee_usd": 1.9,
            "received": 0.0,
            "received_usd": 0.0,
            "to_surcharge": 0.0,
            "to_surcharge_usd": 0.0
        },
        {...},
        {...},
        {...},
        {...},
        {...},
    ],
    "all_count": 100
}

400: Bad Request Error: No mandatory parameters passed

{
    "status": "error",
    "result": {
        "start": "start not passed.",
        "end": "end not passed."
    }
}

403: Forbidden Error: API KEY not passed

{
    "detail": "Credentials were not provided"
}

403: Forbidden Error: Incorrect API KEY

{
    "detail": "Invalid header padding"
}

or

{
    "detail": "Signature verification failed"
}

Parameters description

Parameter name	Data type	Description	Example
start	String	Date in format «dd.mm.yyyyy»	01.01.2024
end	String	Date in format «dd.mm.yyyyy»	31.01.2024
offset	Int	This is the number of the initial record from which data output will start. For example, if you set offset=10, the data will start to be displayed from the 11th record. Default value is 0.	0
limit	Int	This is the number of the last record you want to receive. For example, if limit=20, you will get records up to and including the 20th, starting from the one specified in offset. Default value is 10.	10

Response parameters description

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

• uuid — unique identifier of the invoice with the prefix INV.

• created — time of invoice creation in UTC +0 in format YYYYY-MM-DD HH:MI:SS.FFFFFF.

• address — payment address. It will be pre-filled only in case of selecting cryptocurrency for payment. To select the currency for the client, it is necessary to specify the currency available in the project in add_fields.cryptocurrency.

• expiry_date — expiration date of the invoice in UTC +0 in the format YYYY-MM-DD HH:MI:SS.FFFFFFFF. After the expiry date invoice will be transferred to the status canceled, if no payment has been received.

• side_commission — transfer fee payment side.

• side_commission_ss — service fee payment side.

• amount — invoice amount.

• amount_usd — invoice amount in USD.

• amount_in_fiat — invoice amount in creation currency (depends on currency parameter).

• fee — invoice transfer commission.

• fee_usd — invoice transfer commission in USD.

• service_fee — service commission.

• service_fee_usd — service commission in USD.

• fiat_currency — code of fiat currency in which the invoice was created.

• status — invoice status. When sending a request for invoice creation it is always created. There are also paid, partial, overpaid and canceled statuses.

• is_email_required — parameter for mandatory email filling in the invoice.

• link — link to the invoice page.

• currency — object of the selected cryptocurrency in the invoice. It also contains the object network — information about the selected currency network.

• project — information about the project.

• test_mode — test invoice sign.

• received — amount in cryptocurrency credited to the balance.

• received_usd — amount in USD credited to the balance.

• to_surcharge — amount to be additionally paid in cryptocurrency.

• to_surcharge_usd — amount to be additionally paid in USD.

Request examples

Эти примеры показывают, как можно отправить запрос для получения списка счетов. Обратите внимание, что необходимо предоставить ваш API ключ в заголовке Authorization для успешной авторизации запроса.

cURL

curl -X POST https://api.cryptocloud.plus/v2/invoice/merchant/list \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"start":"01.01.2023","end":"31.01.2023","offset":0,"limit":10}'

Python

import requests

url = "https://api.cryptocloud.plus/v2/invoice/merchant/list"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "start": "01.01.2023",
    "end": "31.01.2023",
    "offset": 0,
    "limit": 10
}

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/list', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        start: '01.01.2023',
        end: '31.01.2023',
        offset: 0,
        limit: 10
    })
})
.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/list");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    "start" => "01.01.2023",
    "end" => "31.01.2023",
    "offset" => 0,
    "limit" => 10
)));

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