Get a settlement

GET

/v2/payments/collect/settlements/{id}

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns one settlement with its totals and status. The settlement must belong to your business.

Parameters

Path Parameters

id*

Settlement ID: a payout run ID for a scheduled payout, or a payout ID for an instant payout.

Type

string

Required

Example"c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f"

Pattern

"^[A-Za-z0-9._-]{1,64}$"

Responses

OK

Content-Type

application/json

{

"id": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f",

"currency": "USDC",

"totalAmount": "1240.75",

"settledAmount": "1240.75",

"paymentCount": 23,

"status": "SETTLED",

"settledAt": 1792684950000,

"receivedAt": 1792676400000

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The settlement ID is longer than 64 characters, contains characters other than letters, digits, ., _ and -, or is only dots.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No settlement with this ID exists in your business.
500	INTERNAL_ERROR	Unexpected error in the payments service.
502	-16097EXCHANGE_API_ERROR	The payments service failed to process the request.
502	EXCHANGE_API_ERROR	The payments service couldn't complete the request. Try again later.
503	-16099PAYMENTS_BACKEND_PROXY_DISABLED	Payments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.