All Versions

Payout paid

EVENT payout.paid

Published when a Payout is complete.

Permissions

PAYOUTS_READ

SETTLEMENTS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target merchant associated with the event.
`location_id string`	The ID of the target location associated with the event.
`type string`	The type of event this represents, `"payout.paid"`.
`event_id string`	A unique ID for the event.
`created_at string`	Read only Timestamp of when the event was verified, in RFC 3339 format. 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
`data PayoutPaidSquareEventData`	Data associated with the event.

Examples

All Versions

{
  "merchant_id": "MLEWJTMNJN37Z",
  "location_id": "LRJNZCB190DTQ",
  "type": "payout.paid",
  "event_id": "7116e4a4-7622-42b0-b16c-c164d7ec7302",
  "created_at": "1970-01-01T00:20:28.481Z",
  "data": {
    "type": "payout",
    "id": "po_070431e4-e351-11eb-a8bb-02420a140009",
    "object": {
      "payout": {
        "amount_money": {
          "amount": 457,
          "currency_code": "EUR"
        },
        "arrival_date": "2021-07-13",
        "created_at": "2021-07-12T20:37:51Z",
        "destination": {
          "id": "bact:c164d7ec7302",
          "type": "BANK_ACCOUNT"
        },
        "id": "po_070431e4-e351-11eb-a8bb-02420a140009",
        "location_id": "LRJNZCB190DTQ",
        "status": "PAID",
        "type": "BATCH",
        "updated_at": "1970-01-01T00:20:28.481Z",
        "version": 2
      }
    }
  }
}