Statistics

To get your account statistics, send a POST request to the following URL:

Statistics of payments for particular period

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

You will receive invoice statistics for the specified period by submitting this request.

Request Body

{
    "status": "success",
    "result": {
        "count": {
            "all": 59,
            "created": 41,
            "paid": 16,
            "overpaid": 1,
            "partial": 1,
            "canceled": 0
        },
        "amount": {
            "all": 4683.83,
            "created": 3032.63,
            "paid": 1531.0,
            "overpaid": 100.2,
            "partial": 20.0,
            "canceled": 0
        }
    }
}

Response parameters description

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

  • count — an object that contains values for the number of invoices.

  • amount — an object that contains values for the invoice amounts in USD.

  • all — all invoices.

  • created — invoices with the status «Created».

  • paid — invoices with the status «Paid».

  • overpaid — invoices with the status «Overpaid».

  • partial — invoices with the status «Partially paid».

  • canceled — invoices with the status «Canceled».

Request examples

These examples show how you can submit a request to get statistics. 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/statistics \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"start":"01.01.2023","end":"31.01.2023"}'

Last updated