Invoice Information

To get invoice status information, send a POST request to the following URL:

Invoice information

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

A request to get information about invoices by unique identifiers.

The maximum number of identifiers in one request is 100.

Request Body

NameTypeDescription

uuids*

array

List of invoice identifiers (INV-XXXXXXXX or XXXXXXXX)

{
    "status": "success",
    "result": [
        {
            "uuid": "INV-XXXXXXXX",
            "address": "",
            "expiry_date": "2023-01-01 12:00:00.000000",
            "side_commission": "client",
            "side_commission_cc": "client",
            "amount": 100.2,
            "amount_usd": 100.2,
            "received": 100.2,
            "received_usd": 100.2,
            "fee": 1.4,
            "fee_usd": 1.4,
            "service_fee": 0,
            "service_fee_usd": 1.9,
            "status": "overpaid",
            "order_id": "1111",
            "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
            },
            "project": {
                "id": 1,
                "name": "MyStore",
                "fail": "https://test.com?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "success": "https://test.com?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "logo": null
            },
            "test_mode": false
        },
        {
            "uuid": "INV-XXXXXXXX",
            "address": "",
            "expiry_date": "2023-01-01 12:00:00.000000",
            "side_commission": "client",
            "side_commission_cc": "client",
            "amount": 100.0,
            "amount_usd": 100.0,
            "received": 0,
            "received_usd": 0,
            "fee": 1.4,
            "fee_usd": 1.4,
            "service_fee": 1.9,
            "service_fee_usd": 1.9,
            "status": "created",
            "order_id": "1111",
            "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
            },

            "project": {
                "id": 1,
                "name": "MyStore",
                "fail": "https://test.com?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "success": "https://test.com?order_id=1111&invoice_uuid=INV-XXXXXXXX",
                "logo": null
            },
            "test_mode": false
        }
    ]
}

Request examples

These examples show how you can run a request to get invoice information by its INV number. Note that you need to provide your API key in the Authorization header to successfully authorize the request.

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

Last updated