Get Invoice List

OpenAPI block

Get Invoice List

GET v1/invoices

Returns all invoices for your store, with pagination

Headers

Name	Value
Content-Type	application/json
Authorization	HMAC <merchant_id>:<sinature>

Query Parameters:

Name	Type	Required	Description
Limit	integer	No	Number of invoices (1–100; default 10)
Offset	integer	No	Pagination offset (≥ 0; default 0)

Example

GET v1/invoices?limit=10&offset=0
Date: Tue, 09 Apr 2025 12:00:00 GMT
Authorization: HMAC merchant_001:abc123xyz456

Response 200 (ok)

Field	Type	Description
offset	Integer	Returned offset
limit	Integer	Returned limit
count	Integer	Total matching invoices
data	Array	List of invoice objects

Response

200

{
  "offset": 0,
  "limit": 10,
  "count": 3,
  "data": [
    {
      "id": "67f79168a707a1b35bc74e9e",
      "status": "paid",
      "address": "0x0...1",
      "blockchain": "tron",
      "tokenSymbol": "USDT",
      "amount": 100.252,
      "orderId": "418229696d28428f",
      "merchantId": "67f78bc0567f7134ffcfd0a9",
      "expiresAt": "2025-04-10T09:31:44.156Z",
      "createdAt": "2025-04-10T09:26:44.158Z",
      "transaction": {
        "transactionHash": "0xabcdef...7890",
        "date": "2025-04-10T09:27:00.000Z",
        "amount": 100.252
      },
  
    {
      "id": "67f78e81a707a1b35bc74e9c",
      "status": "pending",
      "address": "0x0...1",
      "blockchain": "tron",
      "tokenSymbol": "USDT",
      "amount": 100.251,
      "orderId": "418229696d28428c",
      "merchantId": "67f78bc0567f7134ffcfd0a9",
      "expiresAt": "2025-04-10T09:30:21.015Z",
      "createdAt": "2025-04-10T09:25:21.017Z"
    }
  ]
}

Empty

Errors:

400	Invalid parameters	limit/offset validation failed
403	Unauthorized	HMAC signature error or expired
500	Internal server error	Server-side problem

Each invoice

Field	Type	Description
id	String	Unique invoice ID
status	String	"pending", "paid", "expired", "refunded"
address	String	Wallet address
blockchain	String	Blockchain network
tokenSymbol	String	"USDT" or "USDC"
amount	Number	Unique payment amount
orderId	String	Client order ID
merchantId	String	Your merchant ID
expiresAt	String (ISO 8601)	Invoice expiration timestamp
createdAt	String (ISO 8601)	Invoice creation timestamp
transaction	Object (optional)	{ transactionHash, date, amount }

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.