Skip to main content

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.

AttributeLocationTypeRequiredDescription
statusquerystringNoavailable, in_progress or settled; default available
chainqueryintegerNoFilter by network ID
currencyquerystringNousdc or usdt
page_sizequeryintegerNoDefault 20; range 1–100
page_tokenquerystringNoPrior 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&currency=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":""}.

Business error codes