Skip to main content
GET
List payouts

Authorizations

x-api-key
string
header
required

Introw API key shown once when the credential is created.

Query Parameters

limit
integer
default:25

Maximum number of payouts to return.

Required range: 1 <= x <= 100
cursor
string

Cursor returned by a previous list response.

stage
enum<string>

Filter payouts by stage.

Available options:
DRAFT,
PENDING_REVIEW,
PENDING_INVOICE,
APPROVED,
SCHEDULED,
PENDING_PAYMENT,
PAID,
DECLINED,
POSTPONED,
BLOCKED,
FAILED
partnerId
string

Filter payouts for a single partner.

periodStart
string<date-time>

Filter payouts with a period starting on or after this date.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
periodEnd
string<date-time>

Filter payouts with a period ending on or before this date.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

Payout page returned successfully.

data
object[]
required
pagination
object
required