Pular para o conteúdo
Pagamentos

Listar contestações

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/disputes
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

Lista as contestações (chargeback e infração Pix) recebidas do processador: situação, resultado, valor, prazo de resposta e a cobrança ligada. A decisão é do processador; a defesa é enviada pelo painel. Paginação por cursor (limit 1–100, padrão 20) e filtro opcional por status. Somente leitura; não consulta o processador.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional

    open (aberta, aguardando resposta), under_review (em análise no processador) ou closed (concluída).

    • um de"open""under_review""closed"
  • cursorstringopcional
    • tamanho máx. 200
  • limitintegeropcional
    • padrão 20
    • faixa 1–100

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de contestações: as abertas primeiro, pelo prazo de resposta (sem prazo por último); depois as concluídas, da mais recente para a mais antiga. timeline vem [] na lista. data: [] também é sucesso.

  • Cada item — V1Dispute

    • idstring
    • typestring

      chargeback (cartão), pix_infraction (infração Pix, MED) ou unknown (tipo não informado).

      • um de"chargeback""pix_infraction""unknown"
    • statusstring

      open (aberta, aguardando resposta), under_review (em análise no processador) ou closed (concluída).

      • um de"open""under_review""closed"
    • outcomestring | null

      Resultado decidido pelo processador: upheld (valor devolvido ao pagador), dismissed (favorável ao vendedor) ou withdrawn (encerrada sem decisão).

      • um de"upheld""dismissed""withdrawn"
    • amountCentsinteger

      Valor contestado em centavos (BRL).

    • chargeIdstring | null

      Cobrança contestada; null quando o processador não a identifica.

    • deadlineAtstring (date-time) | null

      Prazo para responder; null quando o processador não informa.

      • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
    • createdAtstring (date-time)
      • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
    • concludedAtstring (date-time) | null
      • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…

    • Linha do tempo informada pelo processador, da mais antiga para a mais nova. Só em GET /disputes/{id}; [] na lista.

      Cada item da lista

      • typestring
      • atstring (date-time)
        • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
    • responseStatusstring | null

      Situação da defesa enviada pelo painel: draft (rascunho), submitted (aguardando encaminhamento) ou forwarded (encaminhada ao processador).

      • um de"draft""submitted""forwarded"
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.