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.
The type_<payout entry 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_<payout entry type>_details IDs to get more information:
Link to section
Charge
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.
Link to section
Open Dispute
In the following example, the type_open_dispute_details field represents a payout entry that is a balance change for a dispute that has 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.
Link to section
Refund
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.
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:
You can retrieve the payment by using the v2/payments/F2eGGWCJZYf4sm4C3g9ial4sepWZY endpoint.
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.