Returning a list of payouts

Learn how to get a list of payouts.

Setting the payout query parameters

ParameterOptional/RequiredDescription

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:

  • gt–return values where the createdTime field is after this timestamp

  • gte–return values where the createdTime field is after or equal to this timestamp

  • lt–return values where the createdTime field is before this timestamp

  • lte–return values where the createdTime field is before or equal to this timestamp

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:

  • gt–return values where the payoutTime field is after this timestamp

  • gte–return values where the payoutTime field is after or equal to this timestamp

  • lt–return values where the payoutTime field is before this timestamp

  • lte–return values where the payoutTime field is before or equal to this timestamp

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:

  • gt–return values where the amount field is greater than this amount

  • gte–return values where the amount field is greater than or equal to this amount

  • lt–return values where the amount field is less than this amount

  • lte–return values where the amount field is less than or equal to this amount

Example get request and response

Retrieve the details of payouts with a GET request:

curl https://api.digitalriver.com/payouts

A 200 OK response returns an array of Payout objects:

{
  "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
    }
  ]
}

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