Disputes
Disputes are created when we recieve a dispute (chargeback or inquiry) from the cardholder's bank. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
Repond to disputes by submitting evidence to the cardholder’s bank.
The Dispute object
- Name
object
- Type
- "dispute",
- Description
- Literal representing the object’s type.
- Name
id
- Type
- string,
- Description
- Unique identifier for the object.
- Name
live
- Type
- boolean,
- Description
- Has the value
true
if the object exists in a production environment or the valuefalse
if the object exists in a sandbox environment.
- Name
created_at
- Type
- integer,
- Description
- Time at which the object was created. Measured in milliseconds since the Unix epoch.
- Name
amount
- Type
- integer,
- Description
- The disputed amount.
- Name
evidence
- Type
- empty object,
- Child properties
- Name
evidence_details
- Type
- empty object,
- Child properties
- Name
metadata
- Type
- object,
- Description
- Metadata about the dispute.
- Name
payment
- Type
- string or Payment or null,
- Description
- Expandable. The payment that is disputed.
null
only if the dispute was expanded from a payment object.
- Name
payment_method_details
- Type
- empty object,
- Child properties
- Name
reason
- Type
- enum,
- Description
- The cardholder's stated reason for dispute.
- Array item properties
- Name
status
- Type
- enum,
- Description
- The status of the dispute.
- Array item properties
The Dispute object
Get a dispute
Retrieve a dispute by its ID.
Optional parameters
- Name
expand
- Type
- empty object,
- Child properties
Returns
Returns the dispute object.
Retrieve a dispute
Response example
List all disputes
Retrieve a paginated list of disputes.
Optional parameters
- Name
expand
- Type
- empty object,
- Child properties
- Name
ending_before
- Type
- string,
- Name
starting_after
- Type
- string,
- Name
limit
- Type
- number, at least 1, at most 1000, default is 50
- Description
- Maximum number of objects to return.
- Name
filters
- Type
- ,
- Child properties
Returns
Returns a list of dispute objects.
List all disputes
Response example
Update a dispute
Update a dispute’s evidence and metadata, optionally submitting the evidence for review by the cardholder’s bank.
Optional parameters
- Name
evidence
- Type
- empty object,
- Child properties
- Name
metadata
- Type
- object or null,
- Name
submit
- Type
- boolean, default is false
- Description
- Submit the provided dispute evidence to the cardholder’s bank. Once submitted, you will not be able to update the dispute evidence.
Returns
Returns the dispute object.