<- Object

Object

All versions ->

PayoutEntry

One or more PayoutEntries that make up a Payout.

Each one has a date, amount, and type of activity. The total amount of the payout will equal the sum of the payout entries for a batch payout

Link to section

Properties

Link to section

id

string

Required

A unique ID for the payout entry.

Link to section

payout_id

string

Required

The ID of the payout entries’ associated payout.

Link to section

effective_at

string

The timestamp of when the payout entry affected the balance, 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

type

string

The type of activity associated with this payout entry.

Link to section

gross_amount_money

The amount of money involved in this payout entry.

Link to section

fee_amount_money

The amount of Square fees associated with this payout entry.

Link to section

net_amount_money

The net proceeds from this transaction after any fees.

Link to section

type_app_fee_revenue_details

Details of any developer app fee revenue generated on a payment.

Link to section

type_app_fee_refund_details

Details of a refund for an app fee on a payment.

Link to section

type_automatic_savings_details

Details of any automatic transfer from the payment processing balance to the Square Savings account. These are, generally, proportional to the merchant's sales.

Link to section

type_automatic_savings_reversed_details

Details of any automatic transfer from the Square Savings account back to the processing balance. These are, generally, proportional to the merchant's refunds.

Link to section

type_charge_details

Details of credit card payment captures.

Link to section

type_deposit_fee_details

Details of any fees involved with deposits such as for instant deposits.

Link to section

type_deposit_fee_reversed_details

Details of any reversal or refund of fees involved with deposits such as for instant deposits.

Link to section

type_dispute_details

Details of any balance change due to a dispute event.

Link to section

type_fee_details

Details of adjustments due to the Square processing fee.

Link to section

type_free_processing_details

Square offers Free Payments Processing for a variety of business scenarios including seller referral or when Square wants to apologize for a bug, customer service, repricing complication, and so on. This entry represents details of any credit to the merchant for the purposes of Free Processing.

Link to section

type_hold_adjustment_details

Details of any adjustment made by Square related to the holding or releasing of a payment.

Link to section

type_open_dispute_details

Details of any open disputes.

Link to section

type_other_details

Details of any other type that does not belong in the rest of the types.

Link to section

type_other_adjustment_details

Details of any other type of adjustments that don't fall under existing types.

Link to section

type_refund_details

Details of a refund for an existing card payment.

Link to section

type_release_adjustment_details

Details of fees released for adjustments.

Link to section

type_reserve_hold_details

Details of fees paid for funding risk reserve.

Link to section

type_reserve_release_details

Details of fees released from risk reserve.

Link to section

type_square_capital_payment_details

Details of capital merchant cash advance (MCA) assessments. These are, generally, proportional to the merchant's sales but may be issued for other reasons related to the MCA.

Link to section

type_square_capital_reversed_payment_details

Details of capital merchant cash advance (MCA) assessment refunds. These are, generally, proportional to the merchant's refunds but may be issued for other reasons related to the MCA.

Link to section

type_tax_on_fee_details

Details of tax paid on fee amounts.

Link to section

type_third_party_fee_details

Details of fees collected by a 3rd party platform.

Link to section

type_third_party_fee_refund_details

Details of refunded fees from a 3rd party platform.

Link to section

type_square_payroll_transfer_details

Details of a payroll payment that was transferred to a team member’s bank account.

Link to section

type_square_payroll_transfer_reversed_details

Details of a payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square.