Visão geral
Essa API se aplica a estornos integrados da Argentina, Chile e México.
A API Chargeback é um canal de comunicação entre a plataforma e os comerciantes que têm disputas atribuídas a eles. Permite que os comerciantes:
- listar disputas atribuídas a eles
- ver detalhes da disputa
- visualizar histórico de disputas e trilha de auditoria
- concurso (envie um desafio) ou aceite uma disputa
- Carregue documentos de apoio (evidências)
- baixar ou listar documentos enviados anteriormente
A API foi projetada para trocas seguras e auditáveis e oferece suporte à paginação, filtragem e acesso baseado em funções.
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 de 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, client_secret.
Autenticação e autorização
A API Chargebacks usa OAuth 2.0 para autenticação e autorização, junto com Tokens de portador 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 Token de acesso do portador com escopo específico
- Cada solicitação subsequente à API deve incluir o cabeçalho de autorização com o token
Todos os tokens são de curta duração e deve ser atualizado por meio do fluxo OAuth2. Os tokens de atualização 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 Autorização: Portador <access_token>
- O token expira após 1 hora. Use o token de atualização, se disponível
Segurança e conformidade
- Todos os endpoints exigem HTTPS (TLS 1.2+).
- O acesso é controlado por Escopos do OAuth2 e propriedade do comerciante
- Os arquivos de evidências são armazenados criptografado em repouso
- Todas as ações são registrado para auditoria
- Conformidade com PCI-DSS, GDPR e LGPD padrões