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 |
limit | Int | This is the number of the last record you want to receive. For example, if |
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 | 0 |
limit | Int | This is the number of the last record you want to receive. For example, if | 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
для успешной авторизации запроса.
Last updated