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

You are viewing an old version of the API
Get payout

GET /v2/payouts/{payout_id}

Retrieves details of a specific payout identified by a payout ID.

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.

Response Fields

Name Description
payout
Payout

The requested payout.

errors
Error [ ]

Information about errors encountered during the request.

Examples

You are viewing an old version of the API
GET /v2/payouts/{payout_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/payouts/po_f3c0fb38-a5ce-427d-b858-52b925b72e45 \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payout": {
    "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"
  }
}