Download de documento
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents/{documentId}/download \
--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/{documentId}/download', 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/{documentId}/download"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"url": "https://storage.z2pay.com.br/chargebacks/cbk_v5wylkgvv2rls5tihmuybrz9v/cbkd_h4rk29xw1m8qzv3f7pnsldk29.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=a1b2c3d4e5f6"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Document not found"
}
}Chargebacks
Baixar documento
Gera uma URL assinada e temporária para baixar um documento de contestação já enviado.
GET
/
chargebacks
/
{id}
/
documents
/
{documentId}
/
download
Download de documento
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/chargebacks/{id}/documents/{documentId}/download \
--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/{documentId}/download', 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/{documentId}/download"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"url": "https://storage.z2pay.com.br/chargebacks/cbk_v5wylkgvv2rls5tihmuybrz9v/cbkd_h4rk29xw1m8qzv3f7pnsldk29.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=a1b2c3d4e5f6"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Document not found"
}
}GET /chargebacks/:id/documents/:documentId/download
Faz parte do recurso Chargebacks — as etapas do caso e a janela de defesa
estão lá.
A resposta não é o arquivo: é um JSON com uma url assinada, que você usa para baixá-lo.
A URL vale por 1 hora e dispensa autenticação. Ela já carrega a assinatura, então quem a
receber baixa o arquivo sem
x-api-key — dá para entregá-la direto ao navegador do usuário. Pela
mesma razão, trate-a como credencial: não a registre em log nem a guarde em banco. Expirada,
chame o endpoint de novo.Os dois IDs precisam combinar. O documento tem de pertencer ao chargeback informado no
caminho; caso contrário a resposta é
404, mesmo que os dois existam na sua conta.Para saber quais documentos existem — e os respectivos
documentId —, use
GET /chargebacks/:id/documents. Consultar e baixar continuam
possíveis depois que a janela de defesa fecha; o que expira é o
envio.Authorizations
API Key da Credential (gerada no Backoffice)
Response
URL assinada para download
URL assinada e temporária para baixar o arquivo. Válida por 1 hora e dispensa x-api-key.