Disputes
Provide dispute evidence
Adds supporting evidence to a dispute. Before using this endpoint, you first need to upload your files using the file uploader. You will receive a file id (prefixed by file_) which you can then use in your request. Note that this only attaches the evidence to the dispute, it does not send it to us. Once ready, you will need to submit it. You must provide at least one evidence type in the body of your request.
put/disputes/{dispute_id}/evidence
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesdisputes, disputes:provide-evidence
- or API key in header Authorization
- TypeScripthttps://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/disputes/:dispute_id/evidence/put.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
dispute_idstring required
The dispute identifier.
Request body
Example request
{
"proof_of_delivery_or_service_file": "file_jmbfgkjromvcrn9t4qu4",
"proof_of_delivery_or_service_text": "Description of evidence available at: http://checkout.com/evidenceDocument.pdf",
"proof_of_delivery_or_service_date_file": "file_jmbfgkjromvcrn9t4qu4",
"proof_of_delivery_or_service_date_text": "Copy of the customer receipt showing the merchandise was delivered on 2018-12-20",
"invoice_or_receipt_file": "file_jmbfgkjromvcrn9t4qu4",
"invoice_or_receipt_text": "Copy of the invoice",
"invoice_showing_distinct_transactions_file": "file_jmbfgkjromvcrn9t4qu4",
"invoice_showing_distinct_transactions_text": "Copy of invoice #1244 showing two transactions",
"customer_communication_file": "file_jmbfgkjromvcrn9t4qu4",
"customer_communication_text": "Copy of an email exchange with the cardholder",
"refund_or_cancellation_policy_file": "file_jmbfgkjromvcrn9t4qu4",
"refund_or_cancellation_policy_text": "Copy of the refund policy",
"recurring_transaction_agreement_file": "file_jmbfgkjromvcrn9t4qu4",
"recurring_transaction_agreement_text": "Copy of the recurring transaction agreement",
"additional_evidence_file": "file_jmbfgkjromvcrn9t4qu4",
"additional_evidence_text": "Scanned document",
"arbitration_no_review_files": [
"file_jmbfgkjromvcrn9t4qu4",
"file_kmbfgkjromvcrn9t4qu5"
],
"arbitration_no_review_text": "Evidence for arbitration",
"arbitration_review_required_files": [
"file_jmbfgkjromvcrn9t4qu4",
"file_kmbfgkjromvcrn9t4qu5"
],
"arbitration_review_required_text": "Evidence for arbitration",
"compelling_evidence": {
"merchandise_or_service": "Merchandise",
"merchandise_or_service_desc": "Subscription payment",
"merchandise_or_service_provided_date": "2024-07-25T11:23:06.0000000+00:00",
"shipping_delivery_status": "shipped",
"tracking_information": "129481229312",
"user_id": "user@cko.com",
"ip_address": "192.168.1.150",
"device_id": "device_123_x_1220",
"shipping_address": {
"country": "826"
}
},
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/disputes/dsp_rbhwd2qrg13uhrp2newf12/evidence"
},
"parent": {
"href": "https://{prefix}.api.checkout.com/disputes/dsp_rbhwd2qrg13uhrp2newf12"
}
}
}Response
Dispute evidence provided successfully
Changes
No recorded changes to this operation across all 1 revision of this API.