Applies to: Payouts API | Orders API
Learn how to retrieve a list of payout entries associated with a specific payout.
The ListPayoutEntries endpoint provides a list of payout entries associated with a specific payout. You need to pass payout-entries as an argument to this endpoint. To call this endpoint, set PAYOUTS_READ for the OAuth scope.
Payout entries are the individual transactions that are part of each payout. Chargebacks, refunds, and disputes appear independently as payout entries. If a seller is paying for Square SaaS products, the subscription fee payment appears as a payout entry as well.
You can order the payout entries in ascending or descending order. You cannot, however, retrieve a specific payout entry.
Similar to the ListPayouts endpoint, the ListPayoutEntries endpoint supports pagination.
List payout entries
The following is an example response:
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2021-07-08T08:41:27Z",
"type": "CHARGE",
"gross_amount_money": {
"amount": 300,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 25,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 275,
"currency_code": "EUR"
},
"type_charge_details": {
"payment_id": "{payment_id}"
}
},
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2021-07-08T08:34:49Z",
"type": "CHARGE",
"gross_amount_money": {
"amount": 100,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 18,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 82,
"currency_code": "EUR"
},
"type_charge_details": {
"payment_id": "{payment_id}"
}
},
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2021-06-10T21:54:15Z",
"type": "ADJUSTMENT",
"gross_amount_money": {
"amount": 100,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 100,
"currency_code": "EUR"
}
}
]
}The type__details field in a payout entry contains information specific to the type of the payout entry.
For the following types of payout entries, you can call other APIs using the type__details IDs to get more information.
In the following example, the type_charge_details field represents a payout entry that captures a credit card payment.
To get details about the payment, you can use the payment_id with the Payments API.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-01-31T21:54:06Z",
"type": "CHARGE",
"gross_amount_money": {
"amount": 3500,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 88,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 3412,
"currency_code": "EUR"
},
"type_charge_details": {
"payment_id": "{payment_id}"
}
}In the following example, the type_open_dispute_details field represents a payout entry that is a balance change for a dispute that's been filed.
To get details about the payment, use the payment_id with the Payments API. To get details about the dispute, use the dispute_id with the Disputes API.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-01-31T19:27:14Z",
"type": "OPEN_DISPUTE",
"gross_amount_money": {
"amount": -3500,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": -3500,
"currency_code": "EUR"
},
"type_open_dispute_details": {
"payment_id": "{payment_id}",
"dispute_id": "{dispute_id}"
}
}In the following example, the type_refund_details field represents a payout entry that is a refund.
To get details about the payment, use the payment_id with the Payments API. To get details about the refund, use the refund_id with the Refunds API.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-01-26T21:11:22Z",
"type": "REFUND",
"gross_amount_money": {
"amount": -900,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": -22,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": -878,
"currency_code": "EUR"
},
"type_refund_details": {
"payment_id": "{payment_id}",
"refund_id": "{refund_id}"
}
}For a full list and definitions, see Payouts API Reference.
For charges or refunds, you can retrieve the total taxes and tip amounts, where applicable, using the additional details that you get back in a payout entry.
For example, in the following payout entry, the payment_id of F2eGGWCJZYf4sm4C3g9ial4sepWZY from the type_charge_details field represents the payment:
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-01-26T22:07:46Z",
"type": "CHARGE",
"gross_amount_money": {
"amount": 1000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 50,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 950,
"currency_code": "USD"
},
"type_charge_details": {
"payment_id": "F2eGGWCJZYf4sm4C3g9ial4sepWZY"
}
}You can retrieve the payment by using the v2/payments/F2eGGWCJZYf4sm4C3g9ial4sepWZY endpoint.
{ "payment": { "id": "{id}", "created_at": "2022-01-26T20:07:45.491Z", "updated_at": "2022-01-26T20:07:47.927Z", "amount_money": { "amount": 1000, "currency": "USD" }, ... "location_id": "{location_id}", "order_id": "vhZTpadtU5FPT4JaIWBMMEvVFFTZY", "processing_fee": [ { "effective_at": "2022-01-26T22:07:46.000Z", "type": "INITIAL", "amount_money": { "amount": 50, "currency": "USD" } } ], "customer_id": "{customer_id}", "total_money": { "amount": 1000, "currency": "USD" }, "approved_money": { "amount": 1000, "currency": "USD" }, ... } }
With the order ID from the Payment object, you can use the orders endpoint (v2/orders/vhZTpadtU5FPT4JaIWBMMEvVFFTZY) to retrieve the order information containing the taxes and tips. For more information, see RetrieveOrder.
The type field in a payout entry provides the type of activity associated with a payout entry for more accurate accounting.
The following payout entry types are supported:
A - G
ADJUSTMENT | APP_FEE_REFUND | APP_FEE_REVENUE | AUTOMATIC_BITCOIN_CONVERSIONS | AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED | AUTOMATIC_SAVINGS | AUTOMATIC_SAVINGS_REVERSED | BALANCE_FOLDERS_TRANSFER | BALANCE_FOLDERS_TRANSFER_REVERSED | CHARGE | CREDIT_CARD_REPAYMENT | CREDIT_CARD_REPAYMENT_REVERSED | DEPOSIT_FEE | DEPOSIT_FEE_REVERSED | DISPUTE | ESCHEATMENT | FEE | FREE_PROCESSING | GIFT_CARD_LOAD_FEE | GIFT_CARD_LOAD_FEE_REFUND | GIFT_CARD_POOL_TRANSFER | GIFT_CARD_POOL_TRANSFER_REVERSED |
H - P
HOLD_ADJUSTMENT | INITIAL_BALANCE_CHANGE | LOCAL_OFFERS_CASHBACK | LOCAL_OFFERS_FEE | MONEY_TRANSFER | MONEY_TRANSFER_REVERSAL | OPEN_DISPUTE | OTHER | OTHER_ADJUSTMENT | PAID_SERVICE_FEE | PAID_SERVICE_FEE_REFUND | PAYOUT | PERCENTAGE_PROCESSING_DEACTIVATION | PERCENTAGE_PROCESSING_ENROLLMENT | PERCENTAGE_PROCESSING_REPAYMENT | PERCENTAGE_PROCESSING_REPAYMENT_REVERSED | PROCESSING_FEE | PROCESSING_FEE_REFUND
R - Z
REDEMPTION_CODE | REFUND | RELEASE_ADJUSTMENT | RESERVE_HOLD | RESERVE_RELEASE | RETURNED_PAYOUT | SQUARE_CAPITAL_PAYMENT | SQUARE_CAPITAL_REVERSED_PAYMENT | SQUARE_PAYROLL_TRANSFER | SQUARE_PAYROLL_TRANSFER_REVERSED | SUBSCRIPTION_FEE | SUBSCRIPTION_FEE_PAID_REFUND | SUBSCRIPTION_FEE_REFUND | TAX_ON_FEE | THIRD_PARTY_FEE | THIRD_PARTY_FEE_REFUND | UNDO_GIFT_CARD_LOAD_FEE_REFUND | UNDO_PROCESSING_FEE_REFUND
A manual adjustment applied to the seller's account by Square.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-18T22:26:33Z",
"type": "ADJUSTMENT",
"gross_amount_money": {
"amount": -2500,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -2500,
"currency_code": "USD"
}
}A refund for an application fee on a payment.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "APP_FEE_REFUND",
"gross_amount_money": {
"amount": -40,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": -40,
"currency_code": "EUR"
},
"type_app_fee_refund_details": {
"payment_id": "{payment_id}",
"location_id": "{location_id}"
}
}Revenue generated from an application fee on a payment.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "APP_FEE_REVENUE",
"gross_amount_money": {
"amount": 100,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 100,
"currency_code": "EUR"
},
"type_app_fee_revenue_details": {
"payment_id": "{payment_id}",
"location_id": "{location_id}"
}
}Indicates that the portion of each payment withheld by Square was automatically converted into bitcoin using Cash App. The seller manages their bitcoin in their Cash App account.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-04T20:22:06Z",
"type": "AUTOMATIC_BITCOIN_CONVERSIONS",
"gross_amount_money": {
"amount": -858,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -858,
"currency_code": "USD"
}
}Indicates that a withheld payment, which was scheduled to be converted into bitcoin using Cash App, was deposited back to the Square payments balance.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-04T21:22:06Z",
"type": "AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED",
"gross_amount_money": {
"amount": 858,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 858,
"currency_code": "USD"
}
}An automatic transfer from the payment processing balance to the Square Savings account. These are generally proportional to the seller's sales.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-25T17:13:40Z",
"type": "AUTOMATIC_SAVINGS",
"gross_amount_money": {
"amount": -702,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -702,
"currency_code": "USD"
},
"type_automatic_savings_details": {
"payment_id": "{payment_id}",
"payout_id": "{payout_id}"
}
}An automatic transfer from the Square Savings account back to the processing balance. These are generally proportional to the seller's refunds.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-25T17:15:40Z",
"type": "AUTOMATIC_SAVINGS_REVERSED",
"gross_amount_money": {
"amount": 702,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 702,
"currency_code": "USD"
},
"type_automatic_savings_reversed_details": {
"payment_id": "{payment_id}",
"payout_id": "{payout_id}"
}
}A transfer of funds to a banking folder. In the United States, the folder name is 'Checking Folder'; in Canada, it's 'Balance Folder'.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-13T00:46:17Z",
"type": "BALANCE_FOLDERS_TRANSFER",
"gross_amount_money": {
"amount": -5,
"currency_code": "CAD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "CAD"
},
"net_amount_money": {
"amount": -5,
"currency_code": "CAD"
}
}
]
}The following is an example of a SIMPLE type payout:
{
"payout": {
"id": "{id}",
"status": "PAID",
"location_id": "{location_id}",
"created_at": "2024-02-12T00:44:14Z",
"updated_at": "2024-02-12T01:44:28.667Z",
"amount_money": {
"amount": 5,
"currency_code": "CAD"
},
"destination": {
"type": "SQUARE_STORED_BALANCE",
"id": ""
},
"version": 2,
"type": "SIMPLE",
"arrival_date": "2024-02-11",
"number_of_entries": 0
}
}A reversal of the transfer of funds from a banking folder. In the United States, the folder name is 'Checking Folder'; in Canada, it's 'Balance Folder'.
{
"payout_entries": [
...
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-13T00:46:17Z",
"type": "BALANCE_FOLDERS_TRANSFER_REVERSED",
"gross_amount_money": {
"amount": 5,
"currency_code": "CAD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "CAD"
},
"net_amount_money": {
"amount": 5,
"currency_code": "CAD"
}
}
]
}The following is an example of a SIMPLE type payout:
{
"payout": {
"id": "{id}",
"status": "PAID",
"location_id": "{location_id}",
"created_at": "2024-02-12T00:44:14Z",
"updated_at": "2024-02-12T01:44:28.667Z",
"amount_money": {
"amount": -5,
"currency_code": "CAD"
},
"destination": {
"type": "SQUARE_STORED_BALANCE",
"id": ""
},
"version": 2,
"type": "SIMPLE",
"arrival_date": "2024-02-11",
"number_of_entries": 0
}
}A credit card payment capture.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "CHARGE",
"gross_amount_money": {
"amount": 1000,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 54,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 946,
"currency_code": "EUR"
},
"type_charge_details": {
"payment_id": "{payment_id}"
}
}Indicates that a repayment toward the outstanding balance on the seller's Square credit card was made.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-28T22:13:30Z",
"type": "CREDIT_CARD_REPAYMENT",
"gross_amount_money": {
"amount": -1077,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -1077,
"currency_code": "USD"
}
}Indicates that a repayment toward the outstanding balance on the seller's Square credit card was reversed.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-28T22:23:30Z",
"type": "CREDIT_CARD_REPAYMENT_REVERSED",
"gross_amount_money": {
"amount": 1077,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 1077,
"currency_code": "USD"
}
}A fee assessed because of a deposit, such as an instant deposit.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-24T20:03:08Z",
"type": "DEPOSIT_FEE",
"gross_amount_money": {
"amount": -26,
"currency_code": "AUD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "AUD"
},
"net_amount_money": {
"amount": -26,
"currency_code": "AUD"
},
"type_deposit_fee_details": {
"payout_id": "{payout_id}"
}
}Indicates that Square returned a fee that was previously assessed because of a deposit, such as an instant deposit, back to the seller's account.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-24T20:03:08Z",
"type": "DEPOSIT_FEE_REVERSED",
"gross_amount_money": {
"amount": 26,
"currency_code": "AUD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "AUD"
},
"net_amount_money": {
"amount": 26,
"currency_code": "AUD"
},
"type_deposit_fee_reversed_details": {
"payout_id": "{payout_id}"
}
}The balance change due to a dispute event.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-18T21:37:37Z",
"type": "DISPUTE",
"gross_amount_money": {
"amount": 5000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 5000,
"currency_code": "USD"
},
"type_dispute_details": {
"payment_id": "{payment_id}"
}
}An escheatment entry for remittance.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-05-18T02:11:24Z",
"type": "ESCHEATMENT",
"gross_amount_money": {
"amount": -4022,
"currency_code": "AUD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "AUD"
},
"net_amount_money": {
"amount": -4022,
"currency_code": "AUD"
}
}The cost plus adjustment fee.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-18T11:00:02Z",
"type": "FEE",
"gross_amount_money": {
"amount": -5,
"currency_code": "CAD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "CAD"
},
"net_amount_money": {
"amount": -5,
"currency_code": "CAD"
},
"type_fee_details": {
"payment_id": "{payment_id}"
}
}Square offers free payments processing for a variety of business scenarios, including seller referrals or when Square wants to apologize (for example, for a bug, customer service, or repricing complication). This entry represents a credit to the seller for the purposes of free processing.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-07T20:52:22Z",
"type": "FREE_PROCESSING",
"gross_amount_money": {
"amount": 190,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 190,
"currency_code": "USD"
},
"type_free_processing_details": {
"payment_id": "{payment_id}"
}
}The fee collected during the sale or reload of a gift card. This fee, which is a portion of the amount loaded on the gift card, is deducted from the merchant's payment balance.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-09T20:44:05Z",
"type": "GIFT_CARD_LOAD_FEE",
"gross_amount_money": {
"amount": -125,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -125,
"currency_code": "USD"
}
},
]
}The refund for a fee charged during the sale or reload of a gift card.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-10T22:34:34Z",
"type": "GIFT_CARD_LOAD_FEE_REFUND",
"gross_amount_money": {
"amount": 28,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 28,
"currency_code": "USD"
}
}
]
}A transfer of gift card funds to a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-01-11T18:43:29Z",
"type": "GIFT_CARD_POOL_TRANSFER",
"gross_amount_money": {
"amount": -4700,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -4700,
"currency_code": "USD"
}
},
]
}A reversal of the transfer of gift card funds from a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-01-11T18:43:29Z",
"type": "GIFT_CARD_POOL_TRANSFER_REVERSED",
"gross_amount_money": {
"amount": 4700,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -4700,
"currency_code": "USD"
}
},
]
}An adjustment made by Square related to holding a payment.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-10T19:29:37Z",
"type": "HOLD_ADJUSTMENT",
"gross_amount_money": {
"amount": -1000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -1000,
"currency_code": "USD"
},
"type_hold_adjustment_details": {
"payment_id": "{payment_id}"
}
}An external change to a seller's balance (in the sense that it causes the creation of the other activity types, such as a hold and refund).
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-02-08T21:53:41Z",
"type": "INITIAL_BALANCE_CHANGE",
"gross_amount_money": {
"amount": 10000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 10000,
"currency_code": "USD"
}
}The cashback amount given by a Square Local Offers seller to their customer for a purchase.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-08T15:49:45Z",
"type": "LOCAL_OFFERS_CASHBACK",
"gross_amount_money": {
"amount": -50,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -50,
"currency_code": "USD"
}
}
]
}A commission fee paid by a Square Local Offers seller to Square for a purchase discovered through Square Local Offers.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-08T15:49:45Z",
"type": "LOCAL_OFFERS_FEE",
"gross_amount_money": {
"amount": -20,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -20,
"currency_code": "USD"
}
}
]
}The balance change from a money transfer.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-05-29T20:14:11Z",
"type": "MONEY_TRANSFER",
"gross_amount_money": {
"amount": 440,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 440,
"currency_code": "USD"
}
}The reversal of a money transfer.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-05-29T16:46:55Z",
"type": "MONEY_TRANSFER_REVERSAL",
"gross_amount_money": {
"amount": -440,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -440,
"currency_code": "USD"
}
}The balance change for a chargeback that's been filed.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-17T21:37:37Z",
"type": "OPEN_DISPUTE",
"gross_amount_money": {
"amount": -5000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -5000,
"currency_code": "USD"
},
"type_open_dispute_details": {
"payment_id": "{payment_id}",
"dispute_id": "{dispute_id}"
}
}Any other type that doesn't belong in the rest of the types.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-03-28T20:52:45Z",
"type": "OTHER",
"gross_amount_money": {
"amount": -30,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -30,
"currency_code": "USD"
},
"type_other_details": {
"payment_id": "{payment_id}"
}
}Any other type of adjustment that doesn't fall under existing types.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-02-22T10:23:15Z",
"type": "OTHER_ADJUSTMENT",
"gross_amount_money": {
"amount": 2426,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 2426,
"currency_code": "USD"
}
}A fee paid to a third-party seller.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-10-02T07:58:31Z",
"type": "PAID_SERVICE_FEE",
"gross_amount_money": {
"amount": -500,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -500,
"currency_code": "USD"
}
}A fee refunded to a third-party seller.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-10-18T17:20:45Z",
"type": "PAID_SERVICE_FEE_REFUND",
"gross_amount_money": {
"amount": 290,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 290,
"currency_code": "USD"
}
}The balance change due to a money transfer. Note that this type is never returned by the Payouts API.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-18T14:50:22Z",
"type": "PAYOUT",
"gross_amount_money": {
"amount": 1950,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": 1950,
"currency_code": "GBP"
}
}Deducting the outstanding Percentage Processing balance from the seller’s account. It's the final installment in repaying the dispute-induced negative balance through percentage processing.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-12-19T02:40:21Z",
"type": "PERCENTAGE_PROCESSING_DEACTIVATION",
"gross_amount_money": {
"amount": -91231,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": -91231,
"currency_code": "GBP"
}
}
]
}When activating Percentage Processing, a credit is applied to the seller’s account to offset any negative balance caused by a dispute.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-11-28T01:49:54Z",
"type": "PERCENTAGE_PROCESSING_ENROLLMENT",
"gross_amount_money": {
"amount": 81600,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": 81600,
"currency_code": "GBP"
}
}
]
}The withheld funds from a payment to cover a negative balance. It's an installment to repay the amount from a dispute that was offset during Percentage Processing enrollment.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-12-18T07:51:14Z",
"type": "PERCENTAGE_PROCESSING_REPAYMENT",
"gross_amount_money": {
"amount": -200,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": -200,
"currency_code": "GBP"
}
}
]
}The reversal of a Percentage Processing repayment that happens, for example, when a refund is issued for a payment.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-12-19T07:51:14Z",
"type": "PERCENTAGE_PROCESSING_REPAYMENT_REVERSED",
"gross_amount_money": {
"amount": 200,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": 200,
"currency_code": "GBP"
}
}
]
}The processing fee for a payment. If sellers opt for Gross Settlement (that is, a direct bank withdrawal instead of deducting fees from daily sales), the processing fee is recorded separately as a new payout entry, not as part of the CHARGE payout entry.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-09T21:06:44Z",
"type": "PROCESSING_FEE",
"gross_amount_money": {
"amount": -85,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -85,
"currency_code": "USD"
}
}
]
}The processing fee for a payment refund issued by sellers enrolled in Gross Settlement. The refunded processing fee is recorded separately as a new payout entry, not as part of the REFUND payout entry.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-09T21:10:21Z",
"type": "PROCESSING_FEE_REFUND",
"gross_amount_money": {
"amount": 85,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 85,
"currency_code": "USD"
}
}
]
}A repayment for a redemption code.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-03-17T19:35:22Z",
"type": "REDEMPTION_CODE",
"gross_amount_money": {
"amount": 1000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 1000,
"currency_code": "USD"
}
}A refund for an existing card payment.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "REFUND",
"gross_amount_money": {
"amount": -400,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": -12,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": -388,
"currency_code": "EUR"
},
"type_refund_details": {
"payment_id": "{payment_id}",
"refund_id": "{refund_id}"
}
}An adjustment made by Square related to releasing a payment.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-21T18:00:00Z",
"type": "RELEASE_ADJUSTMENT",
"gross_amount_money": {
"amount": 87,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 87,
"currency_code": "USD"
},
"type_release_adjustment_details": {
"payment_id": "{payment_id}"
}
}Fees paid for a funding risk reserve.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-21T22:54:31Z",
"type": "RESERVE_HOLD",
"gross_amount_money": {
"amount": -5000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -5000,
"currency_code": "USD"
},
"type_reserve_hold_details": {
"payment_id": "{payment_id}"
}
}Fees released from a risk reserve.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-14T18:00:09Z",
"type": "RESERVE_RELEASE",
"gross_amount_money": {
"amount": 2000,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 2000,
"currency_code": "USD"
},
"type_reserve_release_details": {
"payment_id": "{payment_id}"
}
}An entry created when Square receives a response for the ACH file that Square sent indicating that the settlement of the original entry failed.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-18T14:50:22Z",
"type": "RETURNED_PAYOUT",
"gross_amount_money": {
"amount": 1950,
"currency_code": "GBP"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "GBP"
},
"net_amount_money": {
"amount": 1950,
"currency_code": "GBP"
}
}A capital merchant cash advance (MCA) assessment. These are generally proportional to the merchant's sales but can be issued for other reasons related to the MCA.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-25T17:13:40Z",
"type": "SQUARE_CAPITAL_PAYMENT",
"gross_amount_money": {
"amount": -2808,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -2808,
"currency_code": "USD"
},
"type_square_capital_payment_details": {
"payment_id": "{payment_id}"
}
}A capital merchant cash advance (MCA) assessment refund. These are generally proportional to the merchant's refunds but can be issued for other reasons related to the MCA.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-17T21:39:50Z",
"type": "SQUARE_CAPITAL_REVERSED_PAYMENT",
"gross_amount_money": {
"amount": 162,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 162,
"currency_code": "USD"
},
"type_square_capital_reversed_payment_details": {
"payment_id": "{payment_id}"
}
}A payroll payment that was transferred to a team member's bank account.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-17T21:39:50Z",
"type": "SQUARE_PAYROLL_TRANSFER",
"gross_amount_money": {
"amount": -858,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -858,
"currency_code": "USD"
},
"type_square_payroll_transfer_details": {
"payment_id": "{payment_id}"
}
}A payroll payment to a team member's bank account was deposited back to the seller's account by Square.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-17T21:39:50Z",
"type": "SQUARE_PAYROLL_TRANSFER_REVERSED",
"gross_amount_money": {
"amount": 858,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 858,
"currency_code": "USD"
},
"type_square_payroll_transfer_reversed_details": {
"payment_id": "{payment_id}"
}
}A fee charged for subscription to a Square product.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-09-01T15:01:23Z",
"type": "SUBSCRIPTION_FEE",
"gross_amount_money": {
"amount": -3261,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -3261,
"currency_code": "USD"
}
}A Square subscription fee that's been refunded.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2022-02-18T14:34:35Z",
"type": "SUBSCRIPTION_FEE_PAID_REFUND",
"gross_amount_money": {
"amount": 980,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 980,
"currency_code": "USD"
}
}The refund of a previously charged Square product subscription fee.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-16T15:00:22Z",
"type": "SUBSCRIPTION_FEE_REFUND",
"gross_amount_money": {
"amount": 1900,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": 1900,
"currency_code": "USD"
}
}The tax paid on fee amounts.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-04-23T04:30:05Z",
"type": "TAX_ON_FEE",
"gross_amount_money": {
"amount": -1,
"currency_code": "AUD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "AUD"
},
"net_amount_money": {
"amount": -1,
"currency_code": "AUD"
},
"type_tax_on_fee_details": {
"payment_id": "{payment_id}"
}
}Fees collected by a third-party platform.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "THIRD_PARTY_FEE",
"gross_amount_money": {
"amount": -100,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": -100,
"currency_code": "EUR"
},
"type_third_party_fee_details": {
"payment_id": "{payment_id}"
}
}Refunded fees from a third-party platform.
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2023-01-05T18:20:44Z",
"type": "THIRD_PARTY_FEE_REFUND",
"gross_amount_money": {
"amount": 40,
"currency_code": "EUR"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "EUR"
},
"net_amount_money": {
"amount": 40,
"currency_code": "EUR"
},
"type_third_party_fee_refund_details": {
"payment_id": "{payment_id}"
}
}The undoing of a refund for a fee charged during the sale or reload of a gift card.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-01-11T19:22:33Z",
"type": "UNDO_GIFT_CARD_LOAD_FEE_REFUND",
"gross_amount_money": {
"amount": -25,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -25,
"currency_code": "USD"
},
"type_other_details": {
"payment_id": "BulHgSvkhNVMG4vqqbZI1q6O58YZY"
}
}
]
}When undoing a processing fee refund in a Gross Settlement payment, this payout entry type is used.
{
"payout_entries": [
{
"id": "{id}",
"payout_id": "{payout_id}",
"effective_at": "2024-02-09T21:13:04Z",
"type": "UNDO_PROCESSING_FEE_REFUND",
"gross_amount_money": {
"amount": -85,
"currency_code": "USD"
},
"fee_amount_money": {
"amount": 0,
"currency_code": "USD"
},
"net_amount_money": {
"amount": -85,
"currency_code": "USD"
}
}
]
}