List settlement items
Merchant route confirmed. Check applicability.
Object and complete fields · Authentication, amounts and errors · Integration guide
GET /v1/settlement-items
List the current merchant's items, defaulting to available. Sort by descending time first recognized as collectible, then descending ID. Multiple filters apply together.
| Attribute | Location | Type | Required | Description |
|---|---|---|---|---|
status | query | string | No | available, in_progress or settled; default available |
chain | query | integer | No | Filter by network ID |
currency | query | string | No | usdc or usdt |
page_size | query | integer | No | Default 20; range 1–100 |
page_token | query | string | No | Prior next_page_token; omit on first page |
No Idempotency-Key or body is required. Preserve filters when paginating. Results reflect query-time state; creation revalidates every selected item.
Request:
GET /v1/settlement-items?status=settled&chain=8453¤cy=usdc&page_size=20
Authorization: Bearer inv_test_...
Response: 200 OK, complete SettlementItem objects:
{
"data": [
{
"id": "si_example",
"status": "settled",
"amount": "12.5",
"currency": "usdc",
"chain": 8453,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678",
"settlement_id": "st_example",
"settled_at": "2026-10-27T08:10:00Z"
}
],
"next_page_token": ""
}
No matches returns {"data":[],"next_page_token":""}.