Get a payout run

GET

/v2/payments/collect/runs/{id}

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns one scheduled payout run with its timing, status and total. The run must belong to one of your business's payout schedules.

Parameters

Path Parameters

id*

Payout run ID.

Type

string

Required

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

Format

"uuid"

Responses

OK

Content-Type

application/json

{

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

"scheduledFor": 1792684800000,

"cutoffAt": 1792677600000,

"status": "DONE",

"totalAmount": "1240.75",

"currency": "USDC",

"createdAt": 1792598405000

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The run ID isn't a valid UUID.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No payout run with this ID exists on your business's payout schedules.
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.