Listar payouts
Quick Reference
WhatListar os payouts de uma carteira
WhyConciliar e monitorar pagamentos de saída, com filtros e paginação
Reading Time3 min
DifficultyBeginner
PrerequisitesAuthentication → Uma wallet_uuid
GET
/api/v1/bank/wallet/payout/Bearer TokenListar payouts de uma carteiraRetorna uma lista paginada dos payouts financiados por uma carteira. Suporta expressões de filtro e ordenação MagicQuery.
Parâmetros de query
| Param | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
wallet_uuid | string (UUID) | Sim | — | Carteira cujos payouts serão listados |
page | integer | Não | 1 | Número da página |
limit | integer | Não | 10 | Itens por página |
filter | string | Não | — | Expressão de filtro MagicQuery (ex.: status:eq:realized) |
sort | string | Não | — | Expressão de ordenação MagicQuery (ex.: created:desc) |
Cabeçalhos da requisição
| Header | Valor | Obrigatório |
|---|---|---|
Authorization | Bearer {A55_ACCESS_TOKEN} | Sim |
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
page | integer | Página atual |
limit | integer | Itens por página |
total | integer | Número total de payouts |
pages | integer | Número total de páginas |
data | array | Lista de objetos de payout (mesmo formato de Consultar payout) |
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 |
Exemplos de código
- cURL
- Python
- Node.js
curl -s "https://sandbox.api.a55.tech/api/v1/bank/wallet/payout/?wallet_uuid=f47ac10b-58cc-4372-a567-0e02b2c3d479&filter=status:eq:realized&sort=created:desc&page=1&limit=20" \
-H "Authorization: Bearer $A55_ACCESS_TOKEN"
import requests
import os
token = os.environ["A55_ACCESS_TOKEN"]
base = os.environ.get("A55_API_URL", "https://sandbox.api.a55.tech")
result = requests.get(
f"{base}/api/v1/bank/wallet/payout/",
params={
"wallet_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"filter": "status:eq:realized",
"sort": "created:desc",
"page": 1,
"limit": 20,
},
headers={"Authorization": f"Bearer {token}"},
).json()
print(f"{result['total']} payouts em {result['pages']} páginas")
const token = process.env.A55_ACCESS_TOKEN;
const base = process.env.A55_API_URL || "https://sandbox.api.a55.tech";
const params = new URLSearchParams({
wallet_uuid: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
filter: "status:eq:realized",
sort: "created:desc",
page: "1",
limit: "20",
});
const result = await fetch(`${base}/api/v1/bank/wallet/payout/?${params}`, {
headers: { Authorization: `Bearer ${token}` },
}).then((r) => r.json());
console.log(`${result.total} payouts em ${result.pages} páginas`);
Exemplo de resposta
{
"page": 1,
"limit": 20,
"total": 2,
"pages": 1,
"data": [
{
"payout_uuid": "9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1",
"status": "realized",
"type_payout": "pix",
"amount": 100.00,
"currency": "BRL",
"beneficiary_name": "João Silva",
"transaction_reference": "PAY-2048",
"created": "2026-06-16T18:00:00Z"
},
{
"payout_uuid": "5c2a13f0-5e74-4b21-9c6a-2bd9d9b0aa10",
"status": "issued",
"type_payout": "cash_pickup",
"amount": 200.00,
"currency": "USD",
"beneficiary_name": "Pedro",
"transaction_reference": "PAY-2052",
"created": "2026-06-16T18:05:00Z"
}
]
}