Listar documentos do chargeback
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "cbkd_y4bf4q9kn7nfbksmvfjiwc5ba",
"chargebackId": "cbk_v5wylkgvv2rls5tihmuybrz9v",
"type": "invoice",
"contentType": "application/pdf",
"size": 248512,
"description": "Nota fiscal da compra",
"createdAt": "2025-06-30T11:20:00.000Z",
"updatedAt": "2025-06-30T11:20:00.000Z"
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Document not found"
}
}Chargebacks
Listar documentos do chargeback
Retorna os documentos de contestação já enviados para um chargeback.
GET
/
chargebacks
/
{id}
/
documents
Listar documentos do chargeback
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "cbkd_y4bf4q9kn7nfbksmvfjiwc5ba",
"chargebackId": "cbk_v5wylkgvv2rls5tihmuybrz9v",
"type": "invoice",
"contentType": "application/pdf",
"size": 248512,
"description": "Nota fiscal da compra",
"createdAt": "2025-06-30T11:20:00.000Z",
"updatedAt": "2025-06-30T11:20:00.000Z"
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Document not found"
}
}GET /chargebacks/:id/documents
Faz parte do recurso Chargebacks — as etapas do caso e a janela de defesa
estão lá.
Retorna o que já foi enviado como prova. A coleção não pagina: um caso tem poucos documentos, e
a resposta traz todos em data.
A lista não traz o arquivo, e nem o caminho dele. Cada item descreve o documento —
type,
contentType, size — e é isso que você usa para saber o que já foi enviado.
Para obter o conteúdo, use
GET /chargebacks/:id/documents/:documentId/download,
que devolve uma URL assinada e temporária.type diz que prova é aquela, e os valores são fechados: invoice (nota fiscal),
delivery_proof (comprovante de entrega), signed_contract (contrato assinado), screenshot
(captura de tela) e other.A lista continua respondendo depois que a janela fecha. Consultar é sempre possível; o que
depende de
under_review e do deadlineAt é o
envio. Uma lista vazia num caso já julgado significa que nada
chegou a ser enviado — não que os documentos expiraram.