Upload dispute evidence
curl --request POST \
--url https://checkout.kalixo.io/v1/disputes/{id}/evidence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"document_type": "proof_of_delivery",
"file_name": "<string>",
"content_base64": "<string>",
"description": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
document_type: 'proof_of_delivery',
file_name: '<string>',
content_base64: '<string>',
description: '<string>'
})
};
fetch('https://checkout.kalixo.io/v1/disputes/{id}/evidence', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://checkout.kalixo.io/v1/disputes/{id}/evidence"
payload = {
"document_type": "proof_of_delivery",
"file_name": "<string>",
"content_base64": "<string>",
"description": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://checkout.kalixo.io/v1/disputes/{id}/evidence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_type' => 'proof_of_delivery',
'file_name' => '<string>',
'content_base64' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "dp_01JABCDEF",
"object": "dispute",
"payment": "<string>",
"status": "needs_response",
"amount": 1,
"currency": "EUR",
"created_at": "2023-11-07T05:31:56Z",
"reason_code": "<string>",
"reason": "<string>",
"evidence_due_by": "2023-11-07T05:31:56Z",
"evidence": [
{
"id": "<string>",
"document_type": "<string>",
"file_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"type": "invalid_request_error",
"code": "amount_locked",
"message": "<string>",
"request_id": "<string>",
"decline_code": "<string>",
"param": "<string>"
}
}Disputes
Upload dispute evidence
Uploads one evidence document. Kalixo ops review the evidence and decide
whether to defend the dispute. Allowed types: application/pdf (max 2 MB),
image/jpeg and image/tiff (max 10 MB). Documents must not contain card
numbers or identity documents.
POST
/
v1
/
disputes
/
{id}
/
evidence
Upload dispute evidence
curl --request POST \
--url https://checkout.kalixo.io/v1/disputes/{id}/evidence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"document_type": "proof_of_delivery",
"file_name": "<string>",
"content_base64": "<string>",
"description": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
document_type: 'proof_of_delivery',
file_name: '<string>',
content_base64: '<string>',
description: '<string>'
})
};
fetch('https://checkout.kalixo.io/v1/disputes/{id}/evidence', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://checkout.kalixo.io/v1/disputes/{id}/evidence"
payload = {
"document_type": "proof_of_delivery",
"file_name": "<string>",
"content_base64": "<string>",
"description": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://checkout.kalixo.io/v1/disputes/{id}/evidence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_type' => 'proof_of_delivery',
'file_name' => '<string>',
'content_base64' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "dp_01JABCDEF",
"object": "dispute",
"payment": "<string>",
"status": "needs_response",
"amount": 1,
"currency": "EUR",
"created_at": "2023-11-07T05:31:56Z",
"reason_code": "<string>",
"reason": "<string>",
"evidence_due_by": "2023-11-07T05:31:56Z",
"evidence": [
{
"id": "<string>",
"document_type": "<string>",
"file_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"type": "invalid_request_error",
"code": "amount_locked",
"message": "<string>",
"request_id": "<string>",
"decline_code": "<string>",
"param": "<string>"
}
}Authorizations
Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.
Headers
Unique key per logical request, reused on retries. 1 to 255 characters.
Required string length:
1 - 255Path Parameters
Body
application/json
Examples:
"proof_of_delivery"
"customer_communication"
"invoice"
"terms_and_conditions"
"other"
Maximum string length:
200Available options:
application/pdf, image/jpeg, image/tiff Maximum string length:
1000Response
The dispute with the new evidence document.
Example:
"dp_01JABCDEF"
Allowed value:
"dispute"Available options:
needs_response, under_review, funds_withdrawn, won, lost, accepted Amount in the currency's minor unit.
Required range:
x >= 0ISO 4217 currency code, uppercase.
Pattern:
^[A-Z]{3}$Example:
"EUR"
Show child attributes
Show child attributes