Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 3.26 KB

payout.md

File metadata and controls

47 lines (38 loc) · 3.26 KB

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 Getter
Id String Required A unique ID for the payout.
Constraints: Minimum Length: 1		 String getId()
Status String Optional Payout status types String getStatus()
LocationId String Required The ID of the location associated with the payout.
Constraints: Minimum Length: 1		 String getLocationId()
CreatedAt String Optional The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. String getCreatedAt()
UpdatedAt String Optional The timestamp of when the payout was last updated, in RFC 3339 format. String getUpdatedAt()
AmountMoney Money 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.		 Money getAmountMoney()
Destination Destination Optional Information about the destination against which the payout was made. Destination getDestination()
Version Integer 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.		 Integer getVersion()
Type String 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.		 String getType()
PayoutFee List<PayoutFee> Optional A list of transfer fees and any taxes on the fees assessed by Square for this payout. List getPayoutFee()
ArrivalDate String Optional The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. String getArrivalDate()
EndToEndId String Optional A unique ID for each Payout object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement. String getEndToEndId()

Example (as JSON)

{
  "id": "id4",
  "status": "SENT",
  "location_id": "location_id8",
  "created_at": "created_at2",
  "updated_at": "updated_at0",
  "amount_money": {
    "amount": 186,
    "currency": "AUD"
  },
  "destination": {
    "type": "BANK_ACCOUNT",
    "id": "id4"
  }
}