Endpoint
Requires authentication. See Authentication.
Path parameters
The invoice UUID returned when the invoice was created.
Response
Returns 200 OK with the invoice object. The addresses array contains every deposit address that has been generated for this invoice so far. If the customer has not yet selected a chain and token on the checkout page, addresses will be empty.
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"merchantId": "9f8e7d6c-5b4a-3c2d-1e0f-ba9876543210",
"amount": "49.99",
"currency": "USD",
"status": "pending",
"description": "Pro Plan - Monthly",
"expiresAt": "2026-04-12T11:00:00.000Z",
"webhookUrl": "https://your-backend.com/webhooks/settlx",
"paymentUrl": "https://api.settlx.io/checkout/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"addresses": [
{
"currency": "USDT",
"chain": "polygon",
"address": "0xAbCd1234...",
"qrCode": "data:image/png;base64,iVBORw0KGgo..."
}
],
"createdAt": "2026-04-12T10:00:00.000Z",
"updatedAt": "2026-04-12T10:00:00.000Z"
}
}
Response fields
| Field | Type | Description |
|---|
id | string (UUID) | Unique invoice identifier |
merchantId | string (UUID) | Your merchant account ID |
amount | string | Invoice amount |
currency | string | Invoice currency |
status | string | Current invoice status. See Invoice statuses |
description | string | null | Description passed at creation |
expiresAt | string | null | ISO 8601 expiry timestamp, or null if no expiry |
webhookUrl | string | null | Webhook URL for this invoice |
paymentUrl | string | Hosted checkout URL |
addresses | array | Deposit addresses generated for this invoice. Empty until the customer selects a chain and token |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last-updated timestamp |
Address object
| Field | Type | Description |
|---|
currency | string | Token the customer is paying with (e.g. USDT, ETH) |
chain | string | Chain the address is on (e.g. polygon, ethereum) |
address | string | On-chain deposit address |
qrCode | string | Base64-encoded PNG QR code for the address |
Invoice statuses
| Status | Description |
|---|
pending | Awaiting payment |
partial | An underpayment was received — less than the invoiced amount |
confirmed | Full payment confirmed on-chain — settlement in progress |
settled | Funds are in your wallet — terminal |
expired | Invoice expired before full payment was received — terminal |
failed | Payment processing failed — terminal |
Code examples
curl https://api.settlx.io/api/v1/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer pgk_live_xxxxxxxx"
Errors
| Status | Message | Reason |
|---|
401 | Missing or invalid Authorization header | API key not provided or malformed |
401 | Invalid API key | Key not found or has been revoked |
404 | Invoice not found | No invoice with that ID exists under your account |
