Payouts API

Get Payout

The GetPayout endpoint provides details about a specific payout. You need to pass the payout ID as an argument to this endpoint. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

If you do not specify a location, the main or default location is used.

Get Payout

curl https://connect.squareupsandbox.com/v2/payouts/{{PAYOUT_ID}} \
  -H 'Square-Version: 2023-03-15' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json'

The following is an example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "payout": {
    "id": "po_070431e4-e351-11eb-a8bb-02420a140009",
    "status": "SENT",
    "location_id": "{LOCATION_ID}",
    "created_at": "2021-07-12T20:37:51Z",
    "updated_at": "2021-07-12T20:37:51Z",
    "amount_money": {
      "amount": 457,
      "currency_code": "EUR"
    },
    "destination": {
      "type": "BANK_ACCOUNT",
      "id": "bact:cgvL1yv43VFjexample"
    },
    "version": 1,
    "type": "BATCH"
  }
}

Link to section
Related topics

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.

Docs

Get Payout

Link to section Related topics

Link to section
Related topics