Object Index
You are viewing an old version of the API
PayoutEntry
Object Index
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
Required
|
A unique ID for the payout entry. |
payout_
Required
|
The ID of the payout entries’ associated payout. |
effective_
|
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
|
The type of activity associated with this payout entry. |
gross_
|
The amount of money involved in this payout entry. |
fee_
|
The amount of Square fees associated with this payout entry. |
net_
|
The net proceeds from this transaction after any fees. |
type_
|
Details of any developer app fee revenue generated on a payment. |
type_
|
Details of a refund for an app fee on a payment. |
type_
|
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_
|
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_
|
Details of credit card payment captures. |
type_
|
Details of any fees involved with deposits such as for instant deposits. |
type_
|
Details of any balance change due to a dispute event. |
type_
|
Details of adjustments due to the Square processing fee. |
type_
|
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_
|
Details of any adjustment made by Square related to the holding or releasing of a payment. |
type_
|
Details of any open disputes. |
type_
|
Details of any other type that does not belong in the rest of the types. |
type_
|
Details of any other type of adjustments that don't fall under existing types. |
type_
|
Details of a refund for an existing card payment. |
type_
|
Details of fees released for adjustments. |
type_
|
Details of fees paid for funding risk reserve. |
type_
|
Details of fees released from risk reserve. |
type_
|
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_
|
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_
|
Details of tax paid on fee amounts. |
type_
|
Details of fees collected by a 3rd party platform. |
type_
|
Details of refunded fees from a 3rd party platform. |