List payout runs

GET

/v2/payments/collect/runs/history

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns scheduled payout runs, latest scheduled time first, across every payout schedule in your business.

Parameters

Query Parameters

currency

Only include runs that pay out in this currency. Use the upper-case code, e.g. USDC.

Type

string

Example"USDC"

limit

Maximum number of runs to return.

Type

integer

Example50

Default

50

offset

Number of runs to skip, for paging.

Type

integer

Example0

Default

0

Responses

OK

Content-Type

application/json

{

"items": [

{

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

"scheduledFor": 1792684800000,

"cutoffAt": 1792677600000,

"status": "DONE",

"totalAmount": "1240.75",

"currency": "USDC",

"createdAt": 1792598405000

}

],

"total": 1,

"limit": 50,

"offset": 0

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
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.