Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Payouts

ListPayoutEntries

Retrieves a list of all payout entries for a specific payout. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

get/v2/payouts/{payout_id}/payout-entries

Path parameters

payout_idstring required

The ID of the payout to retrieve the information for.

Query parameters

sort_order'DESC' | 'ASC'

The order (e.g., chronological or alphabetical) in which results from a request are returned.

The order in which payout entries are listed.

cursorstring

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see Pagination. If request parameters change between requests, subsequent results may contain duplicates or missing records.

limitinteger

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: 100

Response

Success

cursorstring

The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see Pagination.

Example response

{
  "cursor": "TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO",
  "payout_entries": [
    {
      "effective_at": "2021-12-14T23:31:49Z",
      "fee_amount_money": {
        "amount": -2,
        "currency_code": "USD"
      },
      "gross_amount_money": {
        "amount": -50,
        "currency_code": "USD"
      },
      "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk",
      "net_amount_money": {
        "amount": -48,
        "currency_code": "USD"
      },
      "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
      "type": "REFUND",
      "type_refund_details": {
        "payment_id": "HVdG62HeMlti8YYf94oxrN",
        "refund_id": "HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY"
      }
    },
    {
      "effective_at": "2021-12-14T23:31:49Z",
      "fee_amount_money": {
        "amount": 19,
        "currency_code": "USD"
      },
      "gross_amount_money": {
        "amount": 100,
        "currency_code": "USD"
      },
      "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk",
      "net_amount_money": {
        "amount": 81,
        "currency_code": "USD"
      },
      "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
      "type": "CHARGE",
      "type_charge_details": {
        "payment_id": "HVdG62H5K3291d0SGJS6IWd4cSi8YY"
      }
    }
  ]
}