Disputes

$disputesApi = $client->getDisputesApi();

Class Name

DisputesApi

Methods

List Disputes
Retrieve Dispute
Accept Dispute
List Dispute Evidence
Create Dispute Evidence File
Create Dispute Evidence Text
Delete Dispute Evidence
Retrieve Dispute Evidence
Submit Evidence

List Disputes

Returns a list of disputes associated with a particular account.

function listDisputes(?string $cursor = null, ?string $states = null, ?string $locationId = null): ApiResponse

Parameters

Parameter	Type	Tags	Description
`cursor`	`?string`	Query, Optional	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.
`states`	`?string (DisputeState)`	Query, Optional	The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
`locationId`	`?string`	Query, Optional	The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Response Type

ListDisputesResponse

Example Usage

$apiResponse = $disputesApi->listDisputes();

if ($apiResponse->isSuccess()) {
    $listDisputesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Dispute

Returns details about a specific dispute.

function retrieveDispute(string $disputeId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute you want more details about.

Response Type

RetrieveDisputeResponse

Example Usage

$disputeId = 'dispute_id2';

$apiResponse = $disputesApi->retrieveDispute($disputeId);

if ($apiResponse->isSuccess()) {
    $retrieveDisputeResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Accept Dispute

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.

function acceptDispute(string $disputeId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute you want to accept.

Response Type

AcceptDisputeResponse

Example Usage

$disputeId = 'dispute_id2';

$apiResponse = $disputesApi->acceptDispute($disputeId);

if ($apiResponse->isSuccess()) {
    $acceptDisputeResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

List Dispute Evidence

Returns a list of evidence associated with a dispute.

function listDisputeEvidence(string $disputeId, ?string $cursor = null): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute.
`cursor`	`?string`	Query, Optional	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.

Response Type

ListDisputeEvidenceResponse

Example Usage

$disputeId = 'dispute_id2';

$apiResponse = $disputesApi->listDisputeEvidence($disputeId);

if ($apiResponse->isSuccess()) {
    $listDisputeEvidenceResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Create Dispute Evidence File

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.

function createDisputeEvidenceFile(
    string $disputeId,
    ?CreateDisputeEvidenceFileRequest $request = null,
    ?FileWrapper $imageFile = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute for which you want to upload evidence.
`request`	`?CreateDisputeEvidenceFileRequest`	Form (JSON-Encoded), Optional	Defines the parameters for a `CreateDisputeEvidenceFile` request.
`imageFile`	`?FileWrapper`	Form, Optional	-

Response Type

CreateDisputeEvidenceFileResponse

Example Usage

$disputeId = 'dispute_id2';

$apiResponse = $disputesApi->createDisputeEvidenceFile($disputeId);

if ($apiResponse->isSuccess()) {
    $createDisputeEvidenceFileResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Create Dispute Evidence Text

Uploads text to use as evidence for a dispute challenge.

function createDisputeEvidenceText(string $disputeId, CreateDisputeEvidenceTextRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute for which you want to upload evidence.
`body`	`CreateDisputeEvidenceTextRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

CreateDisputeEvidenceTextResponse

Example Usage

$disputeId = 'dispute_id2';

$body = CreateDisputeEvidenceTextRequestBuilder::init(
    'ed3ee3933d946f1514d505d173c82648',
    '1Z8888888888888888'
)
    ->evidenceType(DisputeEvidenceType::TRACKING_NUMBER)
    ->build();

$apiResponse = $disputesApi->createDisputeEvidenceText(
    $disputeId,
    $body
);

if ($apiResponse->isSuccess()) {
    $createDisputeEvidenceTextResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Delete Dispute Evidence

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

function deleteDisputeEvidence(string $disputeId, string $evidenceId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute from which you want to remove evidence.
`evidenceId`	`string`	Template, Required	The ID of the evidence you want to remove.

Response Type

DeleteDisputeEvidenceResponse

Example Usage

$disputeId = 'dispute_id2';

$evidenceId = 'evidence_id2';

$apiResponse = $disputesApi->deleteDisputeEvidence(
    $disputeId,
    $evidenceId
);

if ($apiResponse->isSuccess()) {
    $deleteDisputeEvidenceResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Dispute Evidence

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.

function retrieveDisputeEvidence(string $disputeId, string $evidenceId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute from which you want to retrieve evidence metadata.
`evidenceId`	`string`	Template, Required	The ID of the evidence to retrieve.

Response Type

RetrieveDisputeEvidenceResponse

Example Usage

$disputeId = 'dispute_id2';

$evidenceId = 'evidence_id2';

$apiResponse = $disputesApi->retrieveDisputeEvidence(
    $disputeId,
    $evidenceId
);

if ($apiResponse->isSuccess()) {
    $retrieveDisputeEvidenceResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Submit Evidence

Submits evidence to the cardholder's bank.

The evidence submitted by this endpoint includes evidence uploaded using the CreateDisputeEvidenceFile and CreateDisputeEvidenceText endpoints and evidence automatically provided by Square, when available. Evidence cannot be removed from a dispute after submission.

function submitEvidence(string $disputeId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`disputeId`	`string`	Template, Required	The ID of the dispute for which you want to submit evidence.

Response Type

SubmitEvidenceResponse

Example Usage

$disputeId = 'dispute_id2';

$apiResponse = $disputesApi->submitEvidence($disputeId);

if ($apiResponse->isSuccess()) {
    $submitEvidenceResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Files

disputes.md

Latest commit

History

disputes.md

File metadata and controls

Disputes

Class Name

Methods

List Disputes

Parameters

Response Type

Example Usage

Retrieve Dispute

Parameters

Response Type

Example Usage

Accept Dispute

Parameters

Response Type

Example Usage

List Dispute Evidence

Parameters

Response Type

Example Usage

Create Dispute Evidence File

Parameters

Response Type

Example Usage

Create Dispute Evidence Text

Parameters

Response Type

Example Usage

Delete Dispute Evidence

Parameters

Response Type

Example Usage

Retrieve Dispute Evidence

Parameters

Response Type

Example Usage

Submit Evidence

Parameters

Response Type

Example Usage