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.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

• UAT: https://transactions.transactional.uat.unico.app/api/public/v1;

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

Solicitação de análise de chargeback

---

Solicitar análise de chargeback

Endpoint para solicitar a análise do chargeback de uma transação especificada.

POSThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback

Path parameters

transaction_id*string

ID da transação que será submetida ao chargeback.

Header parameters

Body

application/json

datetime*string (date-time)

Data e hora do pedido de chargeback no formato ISO 8601.

Example: "2023-01-05T03:00:00.000Z"

requestor*object

Informações do solicitante.

name*string

Nome do solicitante.

Example: "NOME_DO_USUARIO"

reason*string

Motivo da solicitação de chargeback.

Example: "MOTIVO_DA_SOLICITACAO"

observationstring

Observações gerais sobre o pedido.

Example: "OBSERVACOES_GERAIS"

documents*array of object

Documentos relacionados ao chargeback. Até 3 itens são permitidos, e cada documento deve estar codificado em Base64. Apenas arquivos PDF serão aceitos.

Response

200400403404500

Solicitação de chargeback bem-sucedida.

Body

application/json

idstring

ID do chargeback gerado.

Example: "8263a268-5388-492a-bca2-28e1ff4a69f0"

Request

JavaScriptCurlPython

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datetime": "2023-01-05T03:00:00.000Z",
      "requestor": {
        "key": "cpf",
        "value": "CPF_DO_USUARIO"
      },
      "name": "NOME_DO_USUARIO",
      "reason": "MOTIVO_DA_SOLICITACAO",
      "documents": [
        {
          "label": "NOME_DO_ARQUIVO",
          "data": "JVBERi0xLjQKMSAwI=="
        }
      ]
    }),
});
const data = await response.json();

Response

200400403404500

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

Consulta status da análise de chargeback

---

Consultar status da análise de chargeback

Endpoint para consultar o status de um chargeback específico de uma transação.

GEThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}

Path parameters

transaction_id*string

ID da transação relacionada ao chargeback.

chargeback_id*string

ID do chargeback a ser consultado.

Header parameters

Response

200400403404500

Consulta do status do chargeback bem-sucedida.

Body

application/json

idstring

ID do chargeback.

Example: "8263a268-5388-492a-bca2-28e1ff4a69f0"

statusstring

Status atual do chargeback.

Example: "waiting"

Request

JavaScriptCurlPython

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200400403404500

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

Para ver todos os status possíveis, consulte a seção Enumerados.

Para otimizar a performance da sua aplicação, você também pode implementar nosso Webhook para saber quando realizar a consulta do status do Chargeback.

---

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.