Consultar payout

Quick Reference

WhatConsultar um único payout

WhyVerificar o status e os detalhes atuais de um payout que você criou

Reading Time3 min

DifficultyBeginner

PrerequisitesAuthentication → Um payout_uuid e a wallet_uuid que o financiou

GET/api/v1/bank/wallet/payout/{payout_uuid}/{wallet_uuid}/Bearer TokenConsultar um payout vinculado a uma carteira

O payout é vinculado à carteira que o financiou: tanto payout_uuid quanto wallet_uuid vão no caminho da URL. Se o payout não pertencer à carteira, a API retorna errors.wallet.payout_not_found.

---

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
payout_uuid	string (UUID)	Sim	Payout a consultar
wallet_uuid	string (UUID)	Sim	Carteira que financiou o payout

Cabeçalhos da requisição

Header	Valor	Obrigatório
Authorization	Bearer {A55_ACCESS_TOKEN}	Sim

---

Campos da resposta

Retorna o mesmo objeto de payout de Criar payout.

Campo	Tipo	Descrição
payout_uuid	string	Identificador interno do payout
external_id	string	ID do payout no provider
status	string	Status atual (pending, issued, realized, returned, canceled, error, expired)
type_payout	string	Rail utilizado
amount	number (float)	Valor do payout
fee	number (float)	Taxa do provider
currency	string	Moeda ISO 4217
description	string	Descrição do payout
beneficiary_name	string	Nome do beneficiário
transaction_reference	string	Chave de idempotência usada
submitted_date	string	Data de envio ao provider
confirmed_date	string	Data de confirmação
payment_code	string	Código de retirada (apenas cash payouts)
authorization_code	string	Código de autorização do provider, quando disponível
destination	object	Eco dos dados de destino
message	array	Mensagens do provider/processamento
created	string	Timestamp de criação (ISO 8601)
updated	string	Timestamp da última atualização (ISO 8601)

---

Respostas de erro

Status	Código	Descrição
401	unauthorized	Token Bearer inválido ou expirado
404	errors.wallet.not_found	Carteira não encontrada
404	errors.wallet.payout_not_found	Payout não encontrado, ou não pertence à carteira

---

Exemplos de código

cURL

curl -s "https://sandbox.api.a55.tech/api/v1/bank/wallet/payout/9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1/f47ac10b-58cc-4372-a567-0e02b2c3d479/" \
  -H "Authorization: Bearer $A55_ACCESS_TOKEN"

Python

import requests
import os

token = os.environ["A55_ACCESS_TOKEN"]
base = os.environ.get("A55_API_URL", "https://sandbox.api.a55.tech")

payout_uuid = "9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1"
wallet_uuid = "f47ac10b-58cc-4372-a567-0e02b2c3d479"

payout = requests.get(
    f"{base}/api/v1/bank/wallet/payout/{payout_uuid}/{wallet_uuid}/",
    headers={"Authorization": f"Bearer {token}"},
).json()

print(f"Payout {payout['payout_uuid']} — status: {payout['status']}")

Node.js

const token = process.env.A55_ACCESS_TOKEN;
const base = process.env.A55_API_URL || "https://sandbox.api.a55.tech";

const payoutUuid = "9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1";
const walletUuid = "f47ac10b-58cc-4372-a567-0e02b2c3d479";

const payout = await fetch(
  `${base}/api/v1/bank/wallet/payout/${payoutUuid}/${walletUuid}/`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

console.log(`Payout ${payout.payout_uuid} — status: ${payout.status}`);

---

Criar payout →Envie um novo pagamento de saída a partir de uma carteira.Listar payouts →Liste e filtre os payouts de uma carteira.Webhook de payout →Receba uma notificação quando o status do payout mudar.