Sign in
Payouts

List payouts

Get a paginated list of payouts with optional filtering

get/payouts

Query parameters

limitinteger

Number of items to return

afterstring

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestring

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

status'unspecified' | 'creating' | 'processing' | 'analyzing' | 'succeeded' | 'scheduled' | 'approved' | 'canceled' | 'pending' | 'failed'

Filter by payout status

customer_idstring

Filter by customer ID

invoice_idstring

Filter by invoice ID

start_datestring

Filter by start date (RFC3339 format)

end_datestring

Filter by end date (RFC3339 format)

Response

OK

end_cursorstring
has_next_pageboolean
has_previous_pageboolean
start_cursorstring

Example response

{
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}