Skip to content

Latest commit

 

History

History
374 lines (247 loc) · 10.6 KB

disputes.md

File metadata and controls

374 lines (247 loc) · 10.6 KB
Raw

Disputes

disputes_api = client.disputes

Class Name

DisputesApi

Methods

List Disputes

Returns a list of disputes associated with a particular account.

def list_disputes(cursor: nil,
                  states: nil,
                  location_id: nil)

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 (Dispute State) Query, Optional The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
location_id 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

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type List Disputes Response Hash.

Example Usage

result = disputes_api.list_disputes

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Dispute

Returns details about a specific dispute.

def retrieve_dispute(dispute_id:)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute you want more details about.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Dispute Response Hash.

Example Usage

dispute_id = 'dispute_id2'


result = disputes_api.retrieve_dispute(dispute_id: dispute_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

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.

def accept_dispute(dispute_id:)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute you want to accept.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Accept Dispute Response Hash.

Example Usage

dispute_id = 'dispute_id2'


result = disputes_api.accept_dispute(dispute_id: dispute_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

List Dispute Evidence

Returns a list of evidence associated with a dispute.

def list_dispute_evidence(dispute_id:,
                          cursor: nil)

Parameters

Parameter Type Tags Description
dispute_id 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

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type List Dispute Evidence Response Hash.

Example Usage

dispute_id = 'dispute_id2'


result = disputes_api.list_dispute_evidence(dispute_id: dispute_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

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.

def create_dispute_evidence_file(dispute_id:,
                                 request: nil,
                                 image_file: nil)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute for which you want to upload evidence.
request Create Dispute Evidence File Request Hash Form (JSON-Encoded), Optional Defines the parameters for a CreateDisputeEvidenceFile request.
image_file File | UploadIO Form, Optional -

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Create Dispute Evidence File Response Hash.

Example Usage

dispute_id = 'dispute_id2'


result = disputes_api.create_dispute_evidence_file(dispute_id: dispute_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Create Dispute Evidence Text

Uploads text to use as evidence for a dispute challenge.

def create_dispute_evidence_text(dispute_id:,
                                 body:)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute for which you want to upload evidence.
body Create Dispute Evidence Text Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Create Dispute Evidence Text Response Hash.

Example Usage

dispute_id = 'dispute_id2'

body = {
  :idempotency_key => 'ed3ee3933d946f1514d505d173c82648',
  :evidence_text => '1Z8888888888888888',
  :evidence_type => 'TRACKING_NUMBER'
}


result = disputes_api.create_dispute_evidence_text(
  dispute_id: dispute_id,
  body: body
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Delete Dispute Evidence

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

def delete_dispute_evidence(dispute_id:,
                            evidence_id:)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute from which you want to remove evidence.
evidence_id String Template, Required The ID of the evidence you want to remove.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Delete Dispute Evidence Response Hash.

Example Usage

dispute_id = 'dispute_id2'

evidence_id = 'evidence_id2'


result = disputes_api.delete_dispute_evidence(
  dispute_id: dispute_id,
  evidence_id: evidence_id
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

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.

def retrieve_dispute_evidence(dispute_id:,
                              evidence_id:)

Parameters

Parameter Type Tags Description
dispute_id String Template, Required The ID of the dispute from which you want to retrieve evidence metadata.
evidence_id String Template, Required The ID of the evidence to retrieve.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Dispute Evidence Response Hash.

Example Usage

dispute_id = 'dispute_id2'

evidence_id = 'evidence_id2'


result = disputes_api.retrieve_dispute_evidence(
  dispute_id: dispute_id,
  evidence_id: evidence_id
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

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.

def submit_evidence(dispute_id:)

Parameters

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

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Submit Evidence Response Hash.

Example Usage

dispute_id = 'dispute_id2'


result = disputes_api.submit_evidence(dispute_id: dispute_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end