The Respond to the Dispute endpoint allows a merchant to submit evidence for the dispute. This is only allowed if the dispute is the state `needs_response`.
A successful response submits the merchant's challenge immediately and changes the dispute status to `under_review`. There is no separate finalize step.
Merchants only have one opportunity to submit evidence. Once a 200 response is received, this information cannot be updated or changed.
Request
This endpoint expects an object.
idstringOptional
A unique ID given to a dispute.
evidenceobjectOptional
Evidence for the dispute. Note that there should be at least one valid field.
Response
When successful, returns the updated dispute object
idstring
Dispute identifier
orderstring
The token of the order that the dispute is for.
amountstring
The amount of the dispute
currencystring
The ISO 4217 currency code of the dispute.
reasonenum
The reason for the dispute.
statusenum
The current state of the dispute. Values depend on how the dispute state machine is modeled.
openbooleanDefaults to true
True if a final decision on the dispute hasn’t been made yet.
responseDueByinteger
Deadline by which the merchant must respond to the dispute. (Epoch timestamp in seconds, timezone UTC +0.00)
createdAtinteger
A timestamp indicating when the dispute was created. (Epoch timestamp in seconds, timezone UTC +0.00)
openingNotestring
Text from the customer describing why the dispute was opened or the reason for the complaint. While dispute category codes are helpful at informing what a merchant should present, it doesn’t provide reasoning behind the customer’s complaint. In some cases, this can help merchants troubleshoot the dispute directly with their customers.
closingReasonenum or null
A reason indicating how the final decision on the dispute was reached. Recommended possible values listed in Closing Reasons.
merchantOrderIdstring or null
The identifier for the transaction on the merchant side.
transactionDateinteger or null
The timestamp of the order created by the customer. (Epoch timestamp in seconds, timezone UTC +0.00)
settlementAmountstring or null
The settlementAmount for audit usage.
openingNoteAttachmentslist of stringsOptional
Attachments to supplement the openingNote if the customer provided photos or screenshots as part of their dispute description.
updatedAtinteger or nullOptional
Timestamp when the dispute was updated. (Epoch timestamp in seconds, timezone UTC +0.00)
closingNotestring or nullOptional
Text describing in detail how the final decision on the dispute was reached. This supplements the closingReason.
partialRefundAmountstring or nullOptional
The amount partially refunded for the disputed order, if applicable.
metaobjectOptional
The extra information for merchants to match payment.
