Visão geral
A API Chargeback é um canal de comunicação entre a plataforma e os comerciantes que possuem disputas atribuídas a eles. Permite que os comerciantes:
- listem as disputas atribuídas a eles
- vejam detalhes da disputa
- visualizem histórico de disputas e o audit trail
- contestem (submetam um recurso) ou aceitem uma disputa
- enviem de documentos de apoio (evidências)
- baixem ou listem documentos enviados previamente
A API é projetada para trocas seguras e auditáveis e oferece suporte a paginação, filtros e controle de acesso baseado em função.
Atores e permissões
- Comerciante - pode acessar disputas atribuídas à sua conta de comerciante. Pode contestar, aceitar e fazer upload de documentos.
- Plataforma - uso interno: atribuir disputas, alterar status, resolver disputas.
- Auditor - acesso somente leitura para equipes de conformidade (opcional).
Conceitos e enumerações comuns
Status da disputa
- Disputa vencida = O comerciante venceu a disputa e qualquer débito de estorno é revertido.
- Disputa perdida = O comerciante perdeu a disputa e o valor do estorno será debitado do comerciante.
- Disputa parcialmente vencida = O comerciante perdeu a disputa, mas o valor do estorno não será totalmente debitado do comerciante.
- Precisa de resposta = O comerciante deve enviar o documento ou aceitar o estorno.
- Em análise = Resposta sendo validada pela Getnet Network.
Status de comerciante
- documentation_reproved = A equipe do PagoNXT determinou que os documentos enviados não podem ser usados como evidência.
- merchant_notification = O lojista foi notificado de que uma resposta é necessária.
- verification_required = Não há problemas pendentes do lado do comerciante, pois os documentos necessários foram fornecidos.
- chargeback_accepted = Não há problemas pendentes do lado do lojista, pois o estorno foi aceito.
Ciclos
- retrieval_request = A solicitação de recuperação ocorre quando o emissor do cartão solicita informações adicionais sobre a transação antes de iniciar um estorno.
- retrieval_fulfillment = A resposta do lojista à solicitação de recuperação. Inclui todos os documentos e notas enviadas para satisfazer a consulta do emissor.
- first_chargeback = Um primeiro estorno (também conhecido como estorno inicial) ocorre quando o emissor ou o titular do cartão contesta uma transação e os fundos podem ser debitados do comerciante.
- second_representment = A segunda apresentação (também chamada de representação) é a resposta formal do lojista ao primeiro estorno. O comerciante envia as evidências ao adquirente, que as encaminha ao emissor para análise. Se aceito, o estorno será revertido; se rejeitado, poderá prosseguir com a pré-arbitragem.
- pre_arbitration = Ocorre quando o emissor discorda da segunda apresentação do comerciante. É a oportunidade do emissor de reabrir a disputa antes de encaminhá-la para a arbitragem da rede de cartões.
- arbitration_chargeback = Estágio final do processo de disputa, em que a rede de cartões toma uma decisão de licitação. Neste ponto, ambas as partes apresentaram evidências e as regras da rede favorecem o emissor ou o comerciante. Esta decisão é final e irreversível.
Credenciais de acesso
Para obter as credenciais da API, entre em contato com seu gerente de contas para obter orientação. Seu gerente de contas fornecerá as instruções necessárias e o ajudará no processo de integração e geração de credenciais, incluindo seu client_id e client_secret.
Autenticação e autorização
A API Chargeback usa OAuth 2.0 para autenticação e autorização, junto com bearer tokens para acesso a recursos.
Fluxo
- O comerciante (ou cliente da plataforma) se autentica usando o OAuth 2.0 - fluxo de credenciais do cliente.
- A plataforma emite um bearer access token com escopo específico.
- Cada solicitação subsequente à API deve incluir o cabeçalho de autorização (header) com o token.
Todos os tokens são de curta duração e devem ser atualizados por meio do fluxo OAuth2. Os refresh tokens são suportados quando aplicável.
Exemplo de fluxo de autenticação
- Obtenha um token de acesso de /oauth2/access_token
- Use o token em todas as chamadas de API subsequentes como Authorization: Bearer <access_token>
- O token expira após 1 hora. Use o refresh token, se disponível
Segurança e conformidade
- Todos os endpoints exigem HTTPS (TLS 1.2 ou superior).
- O acesso é controlado por escopos OAuth2 e propriedade do comerciante.
- Os arquivos de evidências são armazenados criptografados em rest.
- Todas as ações são registradas para auditoria.
- Conformidade com os padrões PCI-DSS, GDPR e LGPD.