Get Invoice Details

OpenAPI block

Get Invoice details

GET v1/invoices:id

Returns information about a specific invoice by its ID.

Headers

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

Path Parameter:

Parameter	Type	Required	Description
id	String	Yes	Invoice ID

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 /invoice/65e8b2f8c90e9e6b2a123456
Date: Tue, 09 Apr 2025 12:00:00 GMT
Authorization: HMAC merchant_001:abc123xyz456

Response (200 OK):

Field	Type	Description
id	String	Invoice ID
status	String	"pending", "paid", "expired", "refunded"
address	String	Wallet address
blockchain	String	Blockchain network
tokenSymbol	String	Payment token
amount	Number	Unique payment amount
orderId	String	Client order ID
merchantId	String	Your merchant ID
expiresAt	String (ISO 8601)	Expiration timestamp
createdAt	String (ISO 8601)	Creation timestamp
transaction	Object	Optional
{
amount,	Number
date,	String
transactionHash	String
}

Response

Pending

{
  "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"
}

Paid

Error

Errors:

Code	Description	Reason
400	Invalid parameters	id not a valid ObjectId
403	Unauthorized	HMAC signature error or expired
404	Invoice not found	No invoice with given id
500	Internal server error	Server-side problem

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