Skip to main content
POST
Upload de documento
POST /chargebacks/:id/documents Faz parte do recurso Chargebacks — as etapas do caso e a janela de defesa estão lá. Anexa uma prova ao caso. São obrigatórios o tipo e o arquivo; a descrição é opcional.
A janela fecha, e depois disso não há recurso. O envio só é aceito enquanto o caso está em under_review e o deadlineAt não passou — fora disso a resposta é 409. Quem define esse prazo é a adquirente, não você: confira o deadlineAt do caso antes de montar a defesa.
O arquivo vai em base64, no corpo JSON. Não é multipart/form-data. O campo file aceita o base64 puro ou com o prefixo data URI (data:application/pdf;base64,…) — os dois funcionam.
O tipo do arquivo é detectado pelo conteúdo, não pelo nome. A validação lê a assinatura binária dos primeiros bytes, então renomear um arquivo para .pdf não o faz passar. São aceitos PDF, JPEG, PNG e WebP, com até 10 MB já decodificados. Qualquer outra coisa responde 400.
type classifica a prova, e ajuda quem for analisar o caso: invoice (nota fiscal), delivery_proof (comprovante de entrega), signed_contract (contrato assinado), screenshot (captura de tela) e other. Use description para o que o tipo não diz — o número da nota, a data da conversa, o que for.
Endpoint idempotente. Envie o header Idempotency-Key para que um retry por timeout não anexe o mesmo documento duas vezes. Veja Convenções.
A resposta não devolve o arquivo nem um link para ele. Ela confirma o registro — id, type, contentType, size e as datas. Para baixar depois, use GET /chargebacks/:id/documents/:documentId/download.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do chargeback

Body

application/json
type
enum<string>
required

Tipo do documento de contestação: invoice (nota/fatura), delivery_proof (comprovante de entrega), signed_contract (contrato assinado), screenshot (captura de tela) ou other (outro).

Available options:
invoice,
delivery_proof,
signed_contract,
screenshot,
other
file
string
required

Conteúdo do arquivo do documento (base64).

Minimum string length: 1
description
string | null

Descrição ou observação sobre o documento.

Maximum string length: 500

Response

Documento enviado

id
string

Identificador único do registro.

chargebackId
string

ID do chargeback ao qual o registro pertence.

type
string

Tipo do documento de contestação: invoice, delivery_proof, signed_contract, screenshot ou other.

contentType
string

Tipo MIME do arquivo enviado (ex.: application/pdf).

size
integer

Tamanho do arquivo enviado, em bytes.

description
string | null

Descrição do registro.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).