# List all completed settlements
curl "https://api.settlx.io/api/v1/settlements?status=completed" \
-H "Authorization: Bearer pk_live_your_api_key"
# Filter by chain and date range
curl "https://api.settlx.io/api/v1/settlements?chain=ethereum&from=2024-01-01T00:00:00Z" \
-H "Authorization: Bearer pk_live_your_api_key"
const params = new URLSearchParams({ status: 'completed', limit: '50' });
const response = await fetch(`https://api.settlx.io/api/v1/settlements?${params}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "d4e5f6a7-b8c9-0123-def0-456789012345",
"invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"amount": "98.49",
"grossAmount": "99.99",
"currency": "USDT",
"chain": "ethereum",
"transactionHash": "0x9f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c",
"merchantWallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1",
"status": "completed",
"initiatedAt": "2024-01-15T10:05:00.000Z",
"completedAt": "2024-01-15T10:06:30.000Z",
"failedAt": null,
"createdAt": "2024-01-15T10:04:30.000Z",
"updatedAt": "2024-01-15T10:06:30.000Z"
}
],
"pagination": {
"total": 87,
"page": 1,
"limit": 20,
"totalPages": 5
}
}
Settlements
List Settlements
Retrieve a paginated list of settlements for your merchant account
GET
/
api
/
v1
/
settlements
# List all completed settlements
curl "https://api.settlx.io/api/v1/settlements?status=completed" \
-H "Authorization: Bearer pk_live_your_api_key"
# Filter by chain and date range
curl "https://api.settlx.io/api/v1/settlements?chain=ethereum&from=2024-01-01T00:00:00Z" \
-H "Authorization: Bearer pk_live_your_api_key"
const params = new URLSearchParams({ status: 'completed', limit: '50' });
const response = await fetch(`https://api.settlx.io/api/v1/settlements?${params}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "d4e5f6a7-b8c9-0123-def0-456789012345",
"invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"amount": "98.49",
"grossAmount": "99.99",
"currency": "USDT",
"chain": "ethereum",
"transactionHash": "0x9f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c",
"merchantWallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1",
"status": "completed",
"initiatedAt": "2024-01-15T10:05:00.000Z",
"completedAt": "2024-01-15T10:06:30.000Z",
"failedAt": null,
"createdAt": "2024-01-15T10:04:30.000Z",
"updatedAt": "2024-01-15T10:06:30.000Z"
}
],
"pagination": {
"total": 87,
"page": 1,
"limit": 20,
"totalPages": 5
}
}
List Settlements
Returns a paginated list of settlements for your merchant account. Settlements are created automatically when a payment is confirmed and represent the transfer of funds to your settlement wallet.Query Parameters
string
Filter by settlement status. One of:
pending, submitted, completed, failed.| Status | Description |
|---|---|
pending | Settlement queued, not yet broadcast |
submitted | Transaction broadcast to the network, awaiting confirmation |
completed | Settlement confirmed on-chain, funds received |
failed | Settlement failed (will be retried) |
string
Filter by settlement chain (e.g.
ethereum, bsc).string
Filter settlements created on or after this date. ISO 8601 format.
string
Filter settlements created on or before this date. ISO 8601 format.
number
default:"20"
Number of results per page. Min:
1, Max: 100.number
default:"1"
Page number (1-indexed).
Response
array
Show Settlement objects
Show Settlement objects
string
UUID of the settlement
string
UUID of the associated invoice
string
Net amount sent to merchant wallet (after fees)
string | null
Gross amount before fees
string
Settlement currency (your preferred currency)
string
Settlement chain
string | null
On-chain transaction hash
string
Destination wallet address
string
Settlement status
string | null
When the transaction was broadcast
string | null
When the settlement was confirmed
string | null
When the settlement failed (if applicable)
string
ISO 8601 creation timestamp
string
ISO 8601 last-updated timestamp
object
Pagination metadata (same as List Invoices).
# List all completed settlements
curl "https://api.settlx.io/api/v1/settlements?status=completed" \
-H "Authorization: Bearer pk_live_your_api_key"
# Filter by chain and date range
curl "https://api.settlx.io/api/v1/settlements?chain=ethereum&from=2024-01-01T00:00:00Z" \
-H "Authorization: Bearer pk_live_your_api_key"
const params = new URLSearchParams({ status: 'completed', limit: '50' });
const response = await fetch(`https://api.settlx.io/api/v1/settlements?${params}`, {
headers: { 'Authorization': 'Bearer pk_live_your_api_key' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "d4e5f6a7-b8c9-0123-def0-456789012345",
"invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"amount": "98.49",
"grossAmount": "99.99",
"currency": "USDT",
"chain": "ethereum",
"transactionHash": "0x9f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c3a8b7e6d5f4c",
"merchantWallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1",
"status": "completed",
"initiatedAt": "2024-01-15T10:05:00.000Z",
"completedAt": "2024-01-15T10:06:30.000Z",
"failedAt": null,
"createdAt": "2024-01-15T10:04:30.000Z",
"updatedAt": "2024-01-15T10:06:30.000Z"
}
],
"pagination": {
"total": 87,
"page": 1,
"limit": 20,
"totalPages": 5
}
}
⌘I