• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
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

Properties

Name Description
id
string

Required

A unique ID for the payout entry.

Min Length 1
payout_id
string

Required

The ID of the payout entries’ associated payout.

Min Length 1
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

type
string

The type of activity associated with this payout entry.

gross_amount_money
Money

The amount of money involved in this payout entry.

fee_amount_money
Money

The amount of Square fees associated with this payout entry.

net_amount_money
Money

The net proceeds from this transaction after any fees.

type_automatic_savings_details
PaymentBalanceActivityAutomaticSavingsDetail

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

type_automatic_savings_reversed_details
PaymentBalanceActivityAutomaticSavingsReversedDetail

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

type_charge_details
PaymentBalanceActivityChargeDetail

Details of credit card payment captures.

type_deposit_fee_details
PaymentBalanceActivityDepositFeeDetail

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

type_dispute_details
PaymentBalanceActivityDisputeDetail

Details of any balance change due to a dispute event.

type_fee_details
PaymentBalanceActivityFeeDetail

Details of adjustments due to the Square processing fee.

type_free_processing_details
PaymentBalanceActivityFreeProcessingDetail

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.

type_hold_adjustment_details
PaymentBalanceActivityHoldAdjustmentDetail

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

type_open_dispute_details
PaymentBalanceActivityOpenDisputeDetail

Details of any open disputes.

type_other_details
PaymentBalanceActivityOtherDetail

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

type_other_adjustment_details
PaymentBalanceActivityOtherAdjustmentDetail

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

type_refund_details
PaymentBalanceActivityRefundDetail

Details of a refund for an existing card payment.

type_release_adjustment_details
PaymentBalanceActivityReleaseAdjustmentDetail

Details of fees released for adjustments.

type_reserve_hold_details
PaymentBalanceActivityReserveHoldDetail

Details of fees paid for funding risk reserve.

type_reserve_release_details
PaymentBalanceActivityReserveReleaseDetail

Details of fees released from risk reserve.

type_square_capital_payment_details
PaymentBalanceActivitySquareCapitalPaymentDetail

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.

type_square_capital_reversed_payment_details
PaymentBalanceActivitySquareCapitalReversedPaymentDetail

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.

type_tax_on_fee_details
PaymentBalanceActivityTaxOnFeeDetail

Details of tax paid on fee amounts.

type_third_party_fee_details
PaymentBalanceActivityThirdPartyFeeDetail

Details of fees collected by a 3rd party platform.

type_third_party_fee_refund_details
PaymentBalanceActivityThirdPartyFeeRefundDetail

Details of refunded fees from a 3rd party platform.