Any Dispute API to query whether funds are held?

Dear Team,

We noticed that in the case of dispute reported (and not resolved yet), Square sometimes will hold the fund from our bank account, and sometimes will not hold the fund (until the dispute is resolved and we lost); Currently we only can know whether the fund is held or not by the mail from Square, may I know whether any dispute API or any other API can be used to get that info?

The background is that we are trying to implement a finance report in our application showing the daily income, including the payment amount from our customers, and the dispute amount held by Square for the disputes, so that the final amount on the finance report can be consistent with the bank transferring amount for the day.

Thanks.

:wave: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Process Disputes
Payouts API
Square Developer

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

When a dispute is initiated, Square withholds the disputed funds from the seller’s Square account balance until the bank issues a final resolution on the case. If there are insufficient funds in the Square account balance, the funds are removed (debited) from the seller’s most recently linked bank account.

You can use the Disputes API to track the status of disputes. The Disputes API allows a seller to use your application to complete the steps of the disputes process. Your application should provide the seller with important information from the Dispute object, including the reason for the dispute, the current state of the dispute, and the due_at deadline by which the seller must respond (by accepting or challenging the dispute), so that the seller can make the most appropriate decision regarding the dispute.

However, the Disputes API does not provide information about whether the disputed funds have been withheld from the seller’s bank account. This information is not currently available through Square’s developer APIs.

This answer was reviewed by @Bryan-Square.

Thanks for reply. I would like to share some more which we found out recently.

When a dispute is initiated, Square withholds the disputed funds from the seller’s Square account balance until the bank issues a final resolution on the case.

Actually it’s not necessary, Square doesn’t always withhold the disputed funds when a disputed is initiated.

However, the Disputes API does not provide information about whether the disputed funds have been withheld from the seller’s bank account. This information is not currently available through Square’s developer APIs.

Noted.
But I also noticed there are payout APIs, that can query out whether dispute funds are withheld or not on a day, but only in the case bank transferring is made. (in details, payout API can query out the the details of bank transferring, which includes the dispute funds info if there are disputes initiated or resolved on the day). It doesn’t fully meet our requirement but can be as a backup plan.