List All Payout Items

GET {{url}}/payout_items?payout={{payout}}

Returns a cursor-paginated list of items in the payout.

Get payout items API Docs

Request Params

KeyDatatypeRequiredDescription
payoutstringrequired Unique identifier, beginning with “PO”.
afternullCursor pointing to the start of the desired set.
beforestringCursor pointing to the end of the desired set.
include_2020_tax_cutovernullBoolean value indicating whether the API should return tax data for the cutover period of April to August 2020. Defaults to false.
limitnullNumber of records to return.

RESPONSES

status: OK

{"payout_items":[{"type":"payment_paid_out","amount":"10000.0","taxes":[],"links":{"payment":"PM00AGFDJYSEEQ"}},{"type":"payment_paid_out","amount":"1000.0","taxes":[],"links":{"payment":"PM00AGJHPN1WA0"}},{"type":"payment_paid_out","amount":"100000.0","taxes":[],"links":{"payment":"PM00AGJHPMTFWD"}}],"meta":{"cursors":{"before":null,"after":null},"limit":50}}