List invoices

Project invoices, page by page.

GET/invoices

System information

API key: Required
Rate limit: ∞

Query parameters

Parameter	Type	Required	Description
limit	integer	No	How many items to return. Default 20, from 1 to 100.
offset	integer	No	How many items to skip. Default 0.

curl "https://api.atomic.wallet/api/v1/invoices?limit=20&offset=0" \
  -H "x-api-key: $API_KEY"

{
  "items": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectUuid": "73e68013-32f0-4248-95ac-46aed61e59b0",
      "coinCode": "USDT",
      "networkCode": "tron",
      "coinName": "Tether USD",
      "networkName": "TRON",
      "networkPrefix": "TRC-20",
      "amount": "100.000000",
      "sourceAmount": "100.00",
      "sourceCurrency": "USD",
      "sourceRate": "1.000000",
      "status": "pending",
      "confirmedAmount": "0.000000",
      "unconfirmedAmount": "0.000000",
      "remainingAmount": "100.000000",
      "overpaidAmount": "0.000000"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 42
  }
}

Response fields

Parameter	Type	Description
items	array	Invoices on the current page.
items[].uuid	string	Invoice UUID.
items[].projectUuid	string	Project UUID.
items[].coinCode	string	Cryptocurrency code.
items[].networkCode	string	Blockchain network code.
items[].coinName	string	Cryptocurrency name.
items[].networkName	string	Network name.
items[].networkPrefix	string	Token standard in the network, for example `TRC-20`.
items[].amount	string	Amount to pay in cryptocurrency.
items[].sourceAmount	string	Invoice amount in the source currency.
items[].sourceCurrency	string	Invoice source currency.
items[].sourceRate	string	Conversion rate from the source currency to cryptocurrency.
items[].status	string	Invoice status, see “Statuses”.
items[].confirmedAmount	string	Paid and confirmed amount.
items[].unconfirmedAmount	string	Received but not yet confirmed amount.
items[].remainingAmount	string	Amount left to pay.
items[].overpaidAmount	string	Overpaid amount.
pagination	object	Pagination details.
pagination.limit	integer	Page size.
pagination.offset	integer	Offset from the start of the list.
pagination.total	integer	Total number of records.

← PreviousCreate an invoice Next →Retrieve an invoice