Returning a list of payouts
Learn how to get a list of payouts.
Setting the payout query parameters
Parameter | Optional/Required | Description |
---|---|---|
createdTime | Optional | A filter on the list based on the createdTime field. The value can be a string with an ISO-601 UTC format datetime, or it can be a dictionary with the following options:
|
endingBefore | Optional | A cursor for use in pagination. The |
startingAfter | Optional | A cursor for use in pagination. The |
limit | Optional | A limit on the number of objects returned. The limit can range between 1 and 100, and the default is 10. |
ids | Optional | Only return objects with these identifiers. |
payoutTime | Optional | A filter on the list based on the payout
|
payerId | Optional | Only return payouts with this payer identifier. |
payerName | Optional | Only return payouts with this payer name. |
payeeId | Optional | Only return payouts with this payee identifier. |
payeeName | Optional | Only return payouts with this payee name. |
currency | Optional | Only return sales transactions in this currency. |
amount | Optional | A filter on the list based on the payout
|
Example get request and response
Retrieve the details of payouts with a GET
request:
A 200 OK
response returns an array of Payout objects:
Key payout attributes
The following information provides details on the key attributes returned in response to a request for payout information. For a complete list, refer to the Payouts API reference.
id
A unique identifier for the payout.
createdTime
The time at which the payout was created in the reporting environment.
payoutTime
The time when the payout was transacted.
currency
The three-letter ISO currency code representing the type of currency used in the payout.
amount
Represents the total payout amount.
payerId
The ID of payer.
payerName
The name of the payer.
payeeId
The ID of the payee.
payeeName
The name of the payee.
liveMode
If the value is True, the object exists in live mode. If the value is False, the object exists in test mode. Only live mode is supported.
Last updated