Pular para o conteúdo
Pagamentos

Listar repasses

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

Lista os repasses (saques) do saldo da conta de recebimento para a conta de destino, com a situação confirmada pelo processador. Paginação por cursor (limit 1–100, padrão 20) e filtro opcional por status. Valores em centavos (BRL). Somente leitura: o saque é pedido pelo painel. Não consulta o processador.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional

    Situação do repasse confirmada pelo processador. unknown = sem confirmação (a resposta foi ambígua; nunca há reenvio automático). partially_returned/returned = o banco de destino devolveu parte ou todo o valor.

    • um de"submitting""unknown""rejected""pending""processing""completed""failed""partially_returned""returned"
  • 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 repasses do workspace, do mais novo para o mais antigo. data: [] também é sucesso.

  • Cada item — V1Payout

    • idstring
    • statusstring

      Situação do repasse confirmada pelo processador. unknown = sem confirmação (a resposta foi ambígua; nunca há reenvio automático). partially_returned/returned = o banco de destino devolveu parte ou todo o valor.

      • um de"submitting""unknown""rejected""pending""processing""completed""failed""partially_returned""returned"
    • amountCentsinteger

      Valor pedido em centavos (BRL).

    • returnedCentsinteger

      Valor devolvido pelo banco de destino em centavos (0 sem devolução).

    • feeCentsinteger | null

      Tarifa do saque em centavos; null quando ainda não conhecida.

    • failureReasonstring | null

      Motivo de falha informado pelo processador (ou de conferência), quando houver.

      • um de"counterparty_timeout""provider_failed""rejected""response_mismatch""return_inconsistent"

    • Conta de destino resumida: banco e os quatro últimos dígitos. Nunca a conta completa.

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

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