Pular para o conteúdo
Pagamentos

Buscar repasse por id

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

Lê um repasse. Não altera nada nem consulta o processador.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Respostas

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

200Deu certoapplication/json

O repasse, com a situação e o motivo de falha, quando houver.

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]…