Pular para o conteúdo principal

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 carteira

Retorna uma lista paginada dos payouts financiados por uma carteira. Suporta expressões de filtro e ordenação MagicQuery.


Parâmetros de query

ParamTipoObrigatórioPadrãoDescrição
wallet_uuidstring (UUID)SimCarteira cujos payouts serão listados
pageintegerNão1Número da página
limitintegerNão10Itens por página
filterstringNãoExpressão de filtro MagicQuery (ex.: status:eq:realized)
sortstringNãoExpressão de ordenação MagicQuery (ex.: created:desc)

Cabeçalhos da requisição

HeaderValorObrigatório
AuthorizationBearer {A55_ACCESS_TOKEN}Sim

Campos da resposta

CampoTipoDescrição
pageintegerPágina atual
limitintegerItens por página
totalintegerNúmero total de payouts
pagesintegerNúmero total de páginas
dataarrayLista de objetos de payout (mesmo formato de Consultar payout)

Respostas de erro

StatusCódigoDescrição
401unauthorizedToken Bearer inválido ou expirado
404errors.wallet.not_foundCarteira não encontrada

Exemplos de código

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"

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"
}
]
}