HomepageAutenticaçãoAPI Reference

Chargeback

Nesta seção, você encontrará todos as especificações técnicas das REST APIs do produto IDPay para gerenciar transações de 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.

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

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

Path parameters
transaction_idstringRequired

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

Header parameters
AuthorizationstringRequired

Access-token válido. O valor deve ser enviado no formato Bearer {token}".

Body
datetimestring · date-timeRequired

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

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

Nome do solicitante.

Example: NOME_DO_USUARIO
reasonstringRequired

Motivo da solicitação de chargeback.

Example: MOTIVO_DA_SOLICITACAO
observationstringOptional

Observações gerais sobre o pedido.

Example: OBSERVACOES_GERAIS
Responses
200

Solicitação de chargeback bem-sucedida.

application/json
post
POST /api/public/v1/credit/transactions/{transaction_id}/chargeback HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": {
    "key": "cpf",
    "value": "CPF_DO_USUARIO"
  },
  "name": "NOME_DO_USUARIO",
  "reason": "MOTIVO_DA_SOLICITACAO",
  "observation": "OBSERVACOES_GERAIS",
  "documents": [
    {
      "label": "NOME_DO_ARQUIVO",
      "data": "JVBERi0xLjQKMSAwI=="
    }
  ]
}
{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

Consultar status da análise de chargeback

get

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

Path parameters
transaction_idstringRequired

ID da transação relacionada ao chargeback.

chargeback_idstringRequired

ID do chargeback a ser consultado.

Header parameters
AuthorizationstringRequired

Access-token válido. O valor deve ser enviado no formato Bearer {token}".

Responses
200

Consulta do status do chargeback bem-sucedida.

application/json
get
GET /api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id} HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Accept: */*

{
  "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.

PreviousTransações de pagamentoNextOnboarding de cartão de crédito

Last updated

Was this helpful?