Invoice List

The method allows you to retrieve a list of all invoices by sending a POST request.

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

What the method allows you to do

Returns a list of all invoices
Maximum number of records per request — 100
By default, the response contains 10 records

Endpoint

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

Headers

Name

Type

Example

Description

Authorization*

string

Token eyJ0eXAiOiJK<...>4npi1ksS8tSY

Project API key

Request Body

Key parameters

Name

Type

Example

Description

start*

string

01.01.2026

Date in format «dd.mm.yyyyy»

end*

string

31.01.2026

Date in format «dd.mm.yyyyy». Must be later or equal to start.

offset

int

This is the index of the starting record from which data retrieval begins.

For example, if offset=10, the data will start from the 11th record.

limit

int

This is the number of the last record you want to retrieve.

For example, if limit=20, you will receive records up to and including the 20th, starting from the one specified in offset.

Request examples

These examples show how to send a request to retrieve a list of invoices within the specified limits.

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

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)

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

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

Response examples

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

{
    "status": "success",
    "result": [
       {
           "uuid": "INV-89UX09KA",
           "created": "2026-01-01 09:03:58.958133",
           "address": "0xb07427fc721C23674c48233ffE93D3846ee58B63",
           "currency": {
               "id": 3,
               "code": "ETH",
               "fullcode": "ETH",
               "network": {
                   "code": "ERC20",
                   "id": 3,
                   "icon": "https://cdn.cryptocloud.plus/img/network/ERC.svg",
                   "fullname": "Ethereum"
               },
               "name": "Ethereum",
               "is_email_required": false,
               "stablecoin": false,
               "icon_base": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",
               "icon_network": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",
               "icon_qr": "https://cdn.cryptocloud.plus/img/stroke/ETH_STROKE.svg",
               "order": 9
           },
           "date_finished": "2026-01-01 19:27:37.258735",
           "expiry_date": "2026-01-02 09:03:57.493361",
           "side_commission": "client",
           "side_commission_cc": "merchant",
           "type_payments": "crypto",
           "status": "paid",
           "invoice_status": "success",
           "is_email_required": false,
           "project": {
               "id": 1,
               "name": "Test",
               "fail": "None",
               "success": "None",
               "logo": null
           },
           "tx_list": [
               "0x4d52dc2d2fa8555ab10211bd6c9a7aed13e6f9e1901090b03e7bf74603178c15",
                          ],
           "test_mode": false,
           "type": "up",
           "user_email": "a**********[email protected]",
           "pay_url": "None",
           "phone": "",
           "order_id": "None",
           "amount_in_crypto": null,
           "amount_in_fiat": 1.0,
           "amount": 0.000693,
           "amount_usd": 1.0,
           "amount_to_pay": 0.000694,
           "amount_to_pay_usd": 2.03,
           "amount_paid": 0.000694,
           "amount_paid_usd": 2.03,
           "fee": 1e-06,
           "fee_usd": 0.0,
           "service_fee": 1.2e-05,
           "service_fee_usd": 0.04,
           "received": 0.000681,
           "received_usd": 1.99,
           "to_surcharge": 0.0,
           "to_surcharge_usd": 0.0
       }

    ],
    "all_count": 2
}

Response parameters

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

The result object contains:

Name

Type

Example

Description

uuid

string

INV-89UX09KA

Unique invoice identifier with the INV prefix

created

string

2026-01-01 12:00:00.000000

Invoice creation time in UTC+0 format: YYYY-MM-DD HH:MI:SS.FFFFFF

address

string

0xb07427<...>E93D3846ee58B63

Payment address

expiry_date

string

2026-01-02 12:00:00.000000

Invoice expiration date in UTC+0 format: YYYY-MM-DD HH:MI:SS.FFFFFF.

After the expiration time, the invoice status will change to canceled if payment has not been received.

side_commission

string

client

Transfer fee payer

side_commission_cc

string

client

Service fee payer

amount

float

0.033366

Invoice amount in the selected cryptocurrency

amount_usd

float

100.0

Invoice amount in USD

amount_in_fiat

float

100.0

Invoice amount in the creation currency (depends on the currency parameter)

fee

float

4.500000159168849e-06

Transfer fee

fee_usd

float

0.01

Transfer fee in USD

service_fee

float

0.000634

Service fee

service_fee_usd

float

1.9

Service fee in USD

fiat_currency

string

USD

Fiat currency code in which the invoice was created

status

string

created

Invoice status

When a create-invoice request is sent, the status is always created.

Other possible statuses: paid (paid), partial (partially paid), overpaid (overpaid), and canceled (canceled).

is_email_required

bool

false

Parameter for requiring the payer’s email in the invoice

link

string

pay.cryptocloud.plus/89UX09KA

Link to the invoice page

currency

dict

"currency": {

"id": 3,

"code": "ETH",

"fullcode": "ETH",

"network": {

"code": "ERC20",

"id": 3,

"icon": "https://cdn.cryptocloud.plus/img/network/ERC.svg",

"fullname": "Ethereum"

"name": "Ethereum",

"is_email_required": false,

"stablecoin": false,

"icon_base": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",

"icon_network": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",

"icon_qr": "https://cdn.cryptocloud.plus/img/stroke/ETH_STROKE.svg",

"order": 9

}

Object of the selected cryptocurrency in the invoice.

Also contains the network object — information about the selected currency network.

project

dict

"project": {

"id": 0,

"name": "MyShop",

"fail": "https://test.com/failed-payment",

"success": "https://test.com/successful-payment",

"logo": "https://static.cryptocloud.plus/logo/logo.jpg"

}

Object containing project information

test_mode

bool

false

Test invoice sign

received

float

0.00206

Amount credited to the balance in cryptocurrency

received_usd

float

0.26

Amount credited to the balance in USD

to_surcharge

float

0.001172

Amount remaining to be paid in cryptocurrency

to_surcharge_usd

float

0.08

Amount remaining to be paid in USD

PreviousInvoice Cancellation NextInvoice Information

Last updated 1 day 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