com.squareup.square.api

Interface DisputesApi

All Known Implementing Classes:

DefaultDisputesApi

public interface DisputesApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
AcceptDisputeResponse	acceptDispute(String disputeId) Accepts the loss on a dispute.
CompletableFuture<AcceptDisputeResponse>	acceptDisputeAsync(String disputeId) Accepts the loss on a dispute.
CreateDisputeEvidenceFileResponse	createDisputeEvidenceFile(String disputeId, CreateDisputeEvidenceFileRequest request, FileWrapper imageFile) Uploads a file to use as evidence in a dispute challenge.
CompletableFuture<CreateDisputeEvidenceFileResponse>	createDisputeEvidenceFileAsync(String disputeId, CreateDisputeEvidenceFileRequest request, FileWrapper imageFile) Uploads a file to use as evidence in a dispute challenge.
CreateDisputeEvidenceTextResponse	createDisputeEvidenceText(String disputeId, CreateDisputeEvidenceTextRequest body) Uploads text to use as evidence for a dispute challenge.
CompletableFuture<CreateDisputeEvidenceTextResponse>	createDisputeEvidenceTextAsync(String disputeId, CreateDisputeEvidenceTextRequest body) Uploads text to use as evidence for a dispute challenge.
DeleteDisputeEvidenceResponse	deleteDisputeEvidence(String disputeId, String evidenceId) Removes specified evidence from a dispute.
CompletableFuture<DeleteDisputeEvidenceResponse>	deleteDisputeEvidenceAsync(String disputeId, String evidenceId) Removes specified evidence from a dispute.
ListDisputeEvidenceResponse	listDisputeEvidence(String disputeId, String cursor) Returns a list of evidence associated with a dispute.
CompletableFuture<ListDisputeEvidenceResponse>	listDisputeEvidenceAsync(String disputeId, String cursor) Returns a list of evidence associated with a dispute.
ListDisputesResponse	listDisputes(String cursor, String states, String locationId) Returns a list of disputes associated with a particular account.
CompletableFuture<ListDisputesResponse>	listDisputesAsync(String cursor, String states, String locationId) Returns a list of disputes associated with a particular account.
RetrieveDisputeResponse	retrieveDispute(String disputeId) Returns details about a specific dispute.
CompletableFuture<RetrieveDisputeResponse>	retrieveDisputeAsync(String disputeId) Returns details about a specific dispute.
RetrieveDisputeEvidenceResponse	retrieveDisputeEvidence(String disputeId, String evidenceId) Returns the metadata for the evidence specified in the request URL path.
CompletableFuture<RetrieveDisputeEvidenceResponse>	retrieveDisputeEvidenceAsync(String disputeId, String evidenceId) Returns the metadata for the evidence specified in the request URL path.
SubmitEvidenceResponse	submitEvidence(String disputeId) Submits evidence to the cardholder's bank.
CompletableFuture<SubmitEvidenceResponse>	submitEvidenceAsync(String disputeId) Submits evidence to the cardholder's bank.

Method Detail

listDisputes

ListDisputesResponse listDisputes(String cursor,
                                  String states,
                                  String locationId)
                           throws ApiException,
                                  IOException

Returns a list of disputes associated with a particular account.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

states - Optional parameter: The dispute states used to filter the result. If not specified, the endpoint returns all disputes.

locationId - Optional parameter: The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Returns:

Returns the ListDisputesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listDisputesAsync

CompletableFuture<ListDisputesResponse> listDisputesAsync(String cursor,
                                                          String states,
                                                          String locationId)

Returns a list of disputes associated with a particular account.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

states - Optional parameter: The dispute states used to filter the result. If not specified, the endpoint returns all disputes.

locationId - Optional parameter: The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Returns:

Returns the ListDisputesResponse response from the API call

retrieveDispute

RetrieveDisputeResponse retrieveDispute(String disputeId)
                                 throws ApiException,
                                        IOException

Returns details about a specific dispute.

Parameters:

disputeId - Required parameter: The ID of the dispute you want more details about.

Returns:

Returns the RetrieveDisputeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveDisputeAsync

CompletableFuture<RetrieveDisputeResponse> retrieveDisputeAsync(String disputeId)

Returns details about a specific dispute.

Parameters:

disputeId - Required parameter: The ID of the dispute you want more details about.

Returns:

Returns the RetrieveDisputeResponse response from the API call

acceptDispute

AcceptDisputeResponse acceptDispute(String disputeId)
                             throws ApiException,
                                    IOException

Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Square debits the disputed amount from the seller’s Square account. If the Square account does not have sufficient funds, Square debits the associated bank account.

Parameters:

disputeId - Required parameter: The ID of the dispute you want to accept.

Returns:

Returns the AcceptDisputeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

acceptDisputeAsync

CompletableFuture<AcceptDisputeResponse> acceptDisputeAsync(String disputeId)

Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Square debits the disputed amount from the seller’s Square account. If the Square account does not have sufficient funds, Square debits the associated bank account.

Parameters:

disputeId - Required parameter: The ID of the dispute you want to accept.

Returns:

Returns the AcceptDisputeResponse response from the API call

listDisputeEvidence

ListDisputeEvidenceResponse listDisputeEvidence(String disputeId,
                                                String cursor)
                                         throws ApiException,
                                                IOException

Returns a list of evidence associated with a dispute.

Parameters:

disputeId - Required parameter: The ID of the dispute.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListDisputeEvidenceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listDisputeEvidenceAsync

CompletableFuture<ListDisputeEvidenceResponse> listDisputeEvidenceAsync(String disputeId,
                                                                        String cursor)

Returns a list of evidence associated with a dispute.

Parameters:

disputeId - Required parameter: The ID of the dispute.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListDisputeEvidenceResponse response from the API call

createDisputeEvidenceFile

CreateDisputeEvidenceFileResponse createDisputeEvidenceFile(String disputeId,
                                                            CreateDisputeEvidenceFileRequest request,
                                                            FileWrapper imageFile)
                                                     throws ApiException,
                                                            IOException

Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to upload evidence.

request - Optional parameter: Defines the parameters for a `CreateDisputeEvidenceFile` request.

imageFile - Optional parameter: Example:

Returns:

Returns the CreateDisputeEvidenceFileResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createDisputeEvidenceFileAsync

CompletableFuture<CreateDisputeEvidenceFileResponse> createDisputeEvidenceFileAsync(String disputeId,
                                                                                    CreateDisputeEvidenceFileRequest request,
                                                                                    FileWrapper imageFile)

Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to upload evidence.

request - Optional parameter: Defines the parameters for a `CreateDisputeEvidenceFile` request.

imageFile - Optional parameter: Example:

Returns:

Returns the CreateDisputeEvidenceFileResponse response from the API call

createDisputeEvidenceText

CreateDisputeEvidenceTextResponse createDisputeEvidenceText(String disputeId,
                                                            CreateDisputeEvidenceTextRequest body)
                                                     throws ApiException,
                                                            IOException

Uploads text to use as evidence for a dispute challenge.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to upload evidence.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateDisputeEvidenceTextResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createDisputeEvidenceTextAsync

CompletableFuture<CreateDisputeEvidenceTextResponse> createDisputeEvidenceTextAsync(String disputeId,
                                                                                    CreateDisputeEvidenceTextRequest body)

Uploads text to use as evidence for a dispute challenge.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to upload evidence.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateDisputeEvidenceTextResponse response from the API call

deleteDisputeEvidence

DeleteDisputeEvidenceResponse deleteDisputeEvidence(String disputeId,
                                                    String evidenceId)
                                             throws ApiException,
                                                    IOException

Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed.

Parameters:

disputeId - Required parameter: The ID of the dispute from which you want to remove evidence.

evidenceId - Required parameter: The ID of the evidence you want to remove.

Returns:

Returns the DeleteDisputeEvidenceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteDisputeEvidenceAsync

CompletableFuture<DeleteDisputeEvidenceResponse> deleteDisputeEvidenceAsync(String disputeId,
                                                                            String evidenceId)

Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed.

Parameters:

disputeId - Required parameter: The ID of the dispute from which you want to remove evidence.

evidenceId - Required parameter: The ID of the evidence you want to remove.

Returns:

Returns the DeleteDisputeEvidenceResponse response from the API call

retrieveDisputeEvidence

RetrieveDisputeEvidenceResponse retrieveDisputeEvidence(String disputeId,
                                                        String evidenceId)
                                                 throws ApiException,
                                                        IOException

Returns the metadata for the evidence specified in the request URL path. You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.

Parameters:

disputeId - Required parameter: The ID of the dispute from which you want to retrieve evidence metadata.

evidenceId - Required parameter: The ID of the evidence to retrieve.

Returns:

Returns the RetrieveDisputeEvidenceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveDisputeEvidenceAsync

CompletableFuture<RetrieveDisputeEvidenceResponse> retrieveDisputeEvidenceAsync(String disputeId,
                                                                                String evidenceId)

Returns the metadata for the evidence specified in the request URL path. You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.

Parameters:

disputeId - Required parameter: The ID of the dispute from which you want to retrieve evidence metadata.

evidenceId - Required parameter: The ID of the evidence to retrieve.

Returns:

Returns the RetrieveDisputeEvidenceResponse response from the API call

submitEvidence

SubmitEvidenceResponse submitEvidence(String disputeId)
                               throws ApiException,
                                      IOException

Submits evidence to the cardholder's bank. The evidence submitted by this endpoint includes evidence uploaded using the [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText) endpoints and evidence automatically provided by Square, when available. Evidence cannot be removed from a dispute after submission.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to submit evidence.

Returns:

Returns the SubmitEvidenceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

submitEvidenceAsync

CompletableFuture<SubmitEvidenceResponse> submitEvidenceAsync(String disputeId)

Submits evidence to the cardholder's bank. The evidence submitted by this endpoint includes evidence uploaded using the [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText) endpoints and evidence automatically provided by Square, when available. Evidence cannot be removed from a dispute after submission.

Parameters:

disputeId - Required parameter: The ID of the dispute for which you want to submit evidence.

Returns:

Returns the SubmitEvidenceResponse response from the API call