<- Object

Object

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.

Link to section

Properties

Link to section

id

string

Required

A unique ID for the payout.

Min Length
1
Link to section

status

string

Indicates the payout status.

Link to section

location_id

string

Required

The ID of the location associated with the payout.

Min Length
1
Link to section

created_at

string

The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, 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

Link to section

updated_at

string

The timestamp of when the payout was last updated, 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

Link to section

amount_money

The amount of money involved in the payout. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero.

Link to section

destination

Information about the banking destination (such as a bank account, Square checking account, or debit card) against which the payout was made.

Link to section

version

integer(32-bit)

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.

Link to section

type

string

Indicates the payout type.

Link to section

payout_fee

A list of transfer fees and any taxes on the fees assessed by Square for this payout.

Link to section

arrival_date

string

The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.

Link to section

end_to_end_id

string

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.