Returning a list of payouts
Learn how to get a list of payouts.
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 endingBefore parameter is an object identifier 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 to fetch the previous page of the list. |
startingAfter | Optional | A cursor for use in pagination. The startingAfter parameter is an object identifier 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 to fetch the next page of the list. |
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 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:
|
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 amount field. The value can be a string or it can be a dictionary with the following options:
|
Retrieve the details of payouts with a
GET
request:cURL
curl https://api.digitalriver.com/payouts
JSON
{
"hasMore": true,
"data": [
{
"id": "2000028600_1410_2019",
"createdTime": "2019-04-25T20:36:00Z",
"payoutTime": "2019-04-25T00:00:00Z",
"currency": "USD",
"amount": 1180.26,
"payerId": "1410",
"payerName": "DR globalTech, Inc.",
"payeeId": "0013900100",
"payeeName": "ACME, Inc.",
"liveMode": true
}
]
}
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.
A unique identifier for the payout.
The time at which the payout was created in the reporting environment.
The time when the payout was transacted.
The three-letter ISO currency code representing the type of currency used in the payout.
Represents the total payout amount.
The ID of payer.
The name of the payer.
The ID of the payee.
The name of the payee.
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 modified 5mo ago