Payouts
Last updated
Last updated
The Payouts resource lets you list all payouts, retrieve an individual payout, and list the payout transactions for a payout. Payouts are made on varying schedules, depending on your country and industry.
Get all payouts.
/payouts
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
createdTime[gt]=2020-09-22T12:09:44ZA cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
Only return objects with these IDs.
A limit on the number of objects returned. Limit can range between 1 and 5000, and the default is 10.
A filter on the list based on the payout payoutTime field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZOnly return payouts with this payer identifier
Only return payouts with this payer name
Only return payouts with this payee identifier
Only return payouts with this payee name
Only return payouts in the given currency
A filter on the list based on the payout amount field. The value can be a string or it can be a dictionary with the following options:
20.99Retrieves the details of a payout. Supply the unique identifier of the payout.
/payouts/{id}
Payout ID
Retrieves the details of the payout transactions for a payout. Supply the unique identifier of the payout.
/payouts/{id}/transactions
Payout ID
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 5000, and the default is 10.