Consultar transferência

Lê uma transferência pelo id, com o estado atual e o motivo da falha quando houver.

GET/v1/payouts/{id}escopo: payout:read
cURL
curl https://api.transakto.io/v1/payouts/3b7a11d0-7e5c-4c6a-9d21-0e4f5a6b7c8d \
  -H "x-api-key: sk_live_..."

Estados

status

pending
stringopcional
Criada. Aguardando aprovação manual, quando o envio automático está desativado.
processing
stringopcional
Enviada ao adquirente, aguardando liquidação.
completed
stringopcional
Dinheiro entregue. end_to_end_id preenchido.
failed
stringopcional
Recusada ou falhou. O valor volta ao saldo e failure_reason explica.
canceled
stringopcional
Cancelada antes do envio. O valor volta ao saldo.

Uma transferência em pending por muito tempo não é sinal de erro: significa que a conta exige aprovação manual e ninguém aprovou ainda.

Campos da resposta

payout

amount
inteiroopcional
Valor em centavos, sem a tarifa.
fee
inteiroopcional
Tarifa cobrada, em centavos. Sai do saldo junto com o valor.
recipient
objetoopcional
Nome, documento, tipo e valor da chave Pix.
end_to_end_id
string | nullopcional
Identificador da liquidação no Pix, disponível após completed.
failure_reason
string | nullopcional
Motivo da recusa, quando o estado é failed.
processed_at
ISO 8601 | nullopcional
Quando saiu para o adquirente.