curl https://api.settlx.io/api/v1/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer pk_live_your_api_key"
const invoiceId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const response = await fetch(`https://api.settlx.io/api/v1/invoices/${invoiceId}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data } = await response.json();
console.log(data.status);
import httpx
client = httpx.Client(headers={"Authorization": "Bearer pk_live_your_api_key"})
invoice_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
response = client.get(f"https://api.settlx.io/api/v1/invoices/{invoice_id}")
invoice = response.json()["data"]
print(invoice["status"])
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"merchantId": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"amount": "99.99",
"currency": "USD",
"status": "confirmed",
"description": "Order #1234",
"expiresAt": "2024-01-15T10:30:00.000Z",
"webhookUrl": "https://yoursite.com/webhooks/settlx",
"paymentUrl": "https://api.settlx.io/checkout/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"addresses": [
{
"currency": "USDT",
"chain": "ethereum",
"address": "0xABCDEF1234567890abcdef1234567890ABCDEF12",
"qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
],
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:03:00.000Z"
}
}
{
"error": "Not Found",
"message": "Invoice not found"
}
Invoices
Get Invoice
Retrieve a single invoice by ID, including any generated payment addresses
GET
/
api
/
v1
/
invoices
/
{id}
curl https://api.settlx.io/api/v1/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer pk_live_your_api_key"
const invoiceId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const response = await fetch(`https://api.settlx.io/api/v1/invoices/${invoiceId}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data } = await response.json();
console.log(data.status);
import httpx
client = httpx.Client(headers={"Authorization": "Bearer pk_live_your_api_key"})
invoice_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
response = client.get(f"https://api.settlx.io/api/v1/invoices/{invoice_id}")
invoice = response.json()["data"]
print(invoice["status"])
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"merchantId": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"amount": "99.99",
"currency": "USD",
"status": "confirmed",
"description": "Order #1234",
"expiresAt": "2024-01-15T10:30:00.000Z",
"webhookUrl": "https://yoursite.com/webhooks/settlx",
"paymentUrl": "https://api.settlx.io/checkout/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"addresses": [
{
"currency": "USDT",
"chain": "ethereum",
"address": "0xABCDEF1234567890abcdef1234567890ABCDEF12",
"qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
],
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:03:00.000Z"
}
}
{
"error": "Not Found",
"message": "Invoice not found"
}
Get Invoice
Retrieves a single invoice by its ID. The response includes any payment addresses that have been generated for this invoice (i.e., chains/tokens the customer has selected on the checkout page).Path Parameters
string
required
UUID of the invoice.
Response
object
Show Invoice object with addresses
Show Invoice object with addresses
string
UUID of the invoice
string
UUID of your merchant account
string
Invoice amount
string
Invoice currency
string
Current invoice status. One of:
pending, confirmed, settled, expiredstring | null
Invoice description
string | null
ISO 8601 expiry timestamp
string | null
Webhook URL
string
Hosted checkout URL
array
Payment addresses generated for this invoice. One entry per chain/token combination selected by the customer.Each address object contains:
currency— token symbol (e.g.USDT)chain— chain name (e.g.ethereum)address— payment addressqrCode— base64-encoded QR code PNG
string
ISO 8601 creation timestamp
string
ISO 8601 last-updated timestamp
curl https://api.settlx.io/api/v1/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer pk_live_your_api_key"
const invoiceId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const response = await fetch(`https://api.settlx.io/api/v1/invoices/${invoiceId}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data } = await response.json();
console.log(data.status);
import httpx
client = httpx.Client(headers={"Authorization": "Bearer pk_live_your_api_key"})
invoice_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
response = client.get(f"https://api.settlx.io/api/v1/invoices/{invoice_id}")
invoice = response.json()["data"]
print(invoice["status"])
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"merchantId": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"amount": "99.99",
"currency": "USD",
"status": "confirmed",
"description": "Order #1234",
"expiresAt": "2024-01-15T10:30:00.000Z",
"webhookUrl": "https://yoursite.com/webhooks/settlx",
"paymentUrl": "https://api.settlx.io/checkout/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"addresses": [
{
"currency": "USDT",
"chain": "ethereum",
"address": "0xABCDEF1234567890abcdef1234567890ABCDEF12",
"qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
],
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:03:00.000Z"
}
}
{
"error": "Not Found",
"message": "Invoice not found"
}
⌘I