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

You are viewing an old version of the API
List payouts

GET /v2/payouts

Retrieves a list of all payouts for the default location.

You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

Name Description
location_id
string

The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

status
string

If provided, only payouts with the given status are returned.

begin_time
string

The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

end_time
string

The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

sort_order
string

The order in which payouts 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
payouts
Payout [ ]

The requested list of payouts.

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
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/payouts \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payouts": [
    {
      "id": "po_b345d2c7-90b3-4f0b-a2aa-df1def7f8afc",
      "status": "PAID",
      "location_id": "L88917AVBK2S5",
      "created_at": "2022-03-29T16:12:31Z",
      "updated_at": "2022-03-30T01:07:22.875Z",
      "amount_money": {
        "amount": 6259,
        "currency_code": "USD"
      },
      "destination": {
        "type": "CARD",
        "id": "ccof:ZPp3oedR3AeEUNd3z7"
      },
      "version": 2,
      "type": "BATCH",
      "payout_fee": [
        {
          "amount_money": {
            "amount": 95,
            "currency_code": "USD"
          },
          "effective_at": "2022-03-29T16:12:31Z",
          "type": "TRANSFER_FEE"
        }
      ],
      "arrival_date": "2022-03-29"
    },
    {
      "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
      "status": "PAID",
      "location_id": "L88917AVBK2S5",
      "created_at": "2022-03-24T03:07:09Z",
      "updated_at": "2022-03-24T03:07:09Z",
      "amount_money": {
        "amount": -103,
        "currency_code": "USD"
      },
      "destination": {
        "type": "BANK_ACCOUNT",
        "id": "bact:ZPp3oedR3AeEUNd3z7"
      },
      "version": 1,
      "type": "BATCH",
      "arrival_date": "2022-03-24"
    }
  ],
  "cursor": "EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU"
}