Pular para o conteúdo
Pagamentos

Listar pagadores

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

Um pagador por contato do CRM; sem contato, por documento ou e-mail (que nunca saem: o id é opaco). Totais em centavos: cobrado, pago, estornado e em aberto.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • cursorstringopcional
  • limitintegeropcional
    • padrão 25
    • faixa 1–100

Respostas

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

200Deu certoapplication/json

Os pagadores do workspace, do mais recente para o mais antigo, com os totais.

  • Cada item — V1Payer

    • idstring

      O mesmo payerId das cobranças.

    • contactIdstring | null
    • namestring
    • emailstring | null
    • phonestring | null
    • taxIdLast4string | null
    • firstSeenAtstring

      Primeira cobrança deste pagador (ISO).

    • chargesCountinteger
    • chargedAmountinteger

      Pagas + ainda pagáveis (sem canceladas, expiradas e falhas), em centavos.

    • paidAmountinteger

      Bruto pago, em centavos.

    • refundedAmountinteger

      Estornos confirmados, em centavos.

    • openAmountinteger

      Cobranças ainda pagáveis, em centavos.

    • lastPaidAtstring | null
  • nextCursorstring | null

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