Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.75 KB

payout.md

File metadata and controls

44 lines (35 loc) · 2.75 KB
Raw

Payout

An accounting of the amount owed the seller and record of the actual transfer to their external bank account or to the Square balance.

Structure

Payout

Fields

Name Type Tags Description
id string Required A unique ID for the payout.
Constraints: Minimum Length: 1
status string | undefined Optional Payout status types
locationId string Required The ID of the location associated with the payout.
Constraints: Minimum Length: 1
createdAt string | undefined Optional The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format.
updatedAt string | undefined Optional The timestamp of when the payout was last updated, in RFC 3339 format.
amountMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
destination Destination | undefined Optional Information about the destination against which the payout was made.
version number | undefined Optional The version number, which is incremented each time an update is made to this payout record.
The version number helps developers receive event notifications or feeds out of order.
type string | undefined Optional The type of payout: “BATCH” or “SIMPLE”.
BATCH payouts include a list of payout entries that can be considered settled.
SIMPLE payouts do not have any payout entries associated with them
and will show up as one of the payout entries in a future BATCH payout.
payoutFee PayoutFee[] | undefined Optional A list of transfer fees and any taxes on the fees assessed by Square for this payout.
arrivalDate string | undefined Optional The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.

Example (as JSON)

{
  "id": "id0",
  "status": null,
  "location_id": "location_id4",
  "created_at": null,
  "updated_at": null,
  "amount_money": null,
  "destination": null,
  "version": null,
  "type": null,
  "payout_fee": null,
  "arrival_date": null
}