Chargeback

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro. Saiba mais em Autenticação.

Base URL

• UAT: https://transactions.transactional.uat.unico.app/api/public/v1
• Produção: https://transactions.transactional.unico.app/api/public/v1

Solicitar análise de chargeback

POST /credit/transactions/{transaction_id}/chargeback — solicita a análise do chargeback de uma transação especificada.

Headers

Header	Valor
Authorization	Bearer {token} — um access-token válido.

Body

{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}

Campo	Tipo	Obrigatório	Descrição
datetime	string	sim	Data e hora do pedido de chargeback, formato ISO 8601.
requestor	object	sim	Informações do solicitante.
requestor.key	string	sim	Tipo da chave de identificação do solicitante (ex.: cpf).
requestor.value	string	sim	Valor da chave de identificação do solicitante.
name	string	sim	Nome do solicitante.
reason	string	sim	Motivo da solicitação de chargeback.
observation	string	não	Observações gerais sobre o pedido.
documents	array	não	Documentos relacionados ao chargeback. Até 3 itens, cada um em Base64 — apenas PDF.
documents[].label	string	sim (por item)	Nome ou descrição do arquivo.
documents[].data	string	sim (por item)	Arquivo PDF codificado em Base64.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

Campo	Descrição
id	ID do chargeback gerado.

Para respostas de erro, veja Erros — Criação da transação.

Consultar status da análise de chargeback

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — consulta o status de um chargeback específico.

Headers

Header	Valor
Authorization	Bearer {token} — um access-token válido.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}

Campo	Descrição
id	ID do chargeback.
status	Status atual do chargeback.

Veja Enumerados — Resultado do Chargeback para todos os status possíveis. Para otimizar a performance, implemente o Webhook ao invés de consultar este endpoint repetidamente.