• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List payout entries

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

Retrieves a list of all payout entries for a specific payout.

To call this endpoint, set PAYOUTS_READ for the OAuth scope.

Name Description
payout_id
string

Required

The ID of the payout to retrieve the information for.

Name Description
sort_order
string

The order in which payout entries are listed.

cursor
string

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.

limit
integer (32-bit)

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 Fields

Name Description
payout_entries
PayoutEntry [ ]

The requested list of payout entries, ordered with the given or default sort order.

cursor
string

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

errors
Error [ ]

Information about errors encountered during the request.

Examples

You are viewing an old version of the API
GET /v2/payouts/{payout_id}/payout-entries
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/payouts/payout_id0/payout-entries \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payout_entries": [
    {
      "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk",
      "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
      "effective_at": "2021-12-14T23:31:49Z",
      "type": "REFUND",
      "gross_amount_money": {
        "amount": -50,
        "currency_code": "USD"
      },
      "fee_amount_money": {
        "amount": -2,
        "currency_code": "USD"
      },
      "net_amount_money": {
        "amount": -48,
        "currency_code": "USD"
      },
      "type_refund_details": {
        "payment_id": "HVdG62HeMlti8YYf94oxrN",
        "refund_id": "HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY"
      }
    },
    {
      "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk",
      "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
      "effective_at": "2021-12-14T23:31:49Z",
      "type": "CHARGE",
      "gross_amount_money": {
        "amount": 100,
        "currency_code": "USD"
      },
      "fee_amount_money": {
        "amount": 19,
        "currency_code": "USD"
      },
      "net_amount_money": {
        "amount": 81,
        "currency_code": "USD"
      },
      "type_charge_details": {
        "payment_id": "HVdG62H5K3291d0SGJS6IWd4cSi8YY"
      }
    }
  ],
  "cursor": "TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO"
}