Skip to main content

List settlements

Merchant route confirmed. Check applicability.

Object and complete fields · Authentication, amounts and errors · Integration guide

GET /v1/settlements

List the current merchant's Settlements, ordered by descending creation time then descending ID. Default is all statuses; multiple filters apply together.

AttributeLocationTypeRequiredDescription
statusquerystringNopreparing, requires_action, processing, succeeded or failed
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.

Request:

GET /v1/settlements?status=succeeded&page_size=20
Authorization: Bearer inv_test_...

Response: 200 OK, complete Settlement objects in data:

{
"data": [
{
"id": "st_example",
"status": "succeeded",
"item_ids": ["si_example"],
"amount": "12.5",
"currency": "usdc",
"chain": 8453,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678",
"next_action": null,
"transaction_hash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"last_execution_error": null,
"created_at": "2026-10-27T08:00:00Z",
"updated_at": "2026-10-27T08:10:00Z",
"settled_at": "2026-10-27T08:10:00Z"
}
],
"next_page_token": ""
}

No matches returns {"data":[],"next_page_token":""}.

Business error codes