Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Payouts

Returns a list of payouts

Get all payouts.

get/payouts

Query parameters

createdTimeobject

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:

  • 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
endingBeforestring

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.

startingAfterstring

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.

idsstring[]

Only return objects with these IDs.

limitinteger

A limit on the number of objects returned. Limit can range between 1 and 5000, and the default is 10.

payoutTimeobject

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
payerIdstring

Only return payouts with this payer identifier

payerNamestring

Only return payouts with this payer name

payeeIdstring

Only return payouts with this payee identifier

payeeNamestring

Only return payouts with this payee name

currencystring

Only return payouts in the given currency

amountobject

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

Response

200 OK

hasMoreboolean

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example response

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