Jump to Content

Listar Payouts

Retorna um histórico paginado de todos os saques realizados pela sua conta. Use como livro-razão para reconciliação financeira ou para verificar o status de saques em caso de falha no webhook.

GET https://api.legacyecombr.com.br/payout

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`status`	`string`	Filtra por status: `AWAITING_APPROVAL`, `PENDING`, `PROCESSING`, `APPROVED`, `COMPLETED`, `FAILED`, `CANCELED`, `REFUSED` ou `REFUNDED`
`startDate`	`string (ISO 8601)`	Data/hora de início do período (ex.: `2026-03-01T00:00:00.000Z`)
`endDate`	`string (ISO 8601)`	Data/hora de fim do período
`referenceId`	`string`	ID exato do saque no seu sistema
`page`	`integer`	Página a ser retornada (padrão: `1`)
`limit`	`integer`	Itens por página (padrão: `10`)

Exemplo de requisição

GET /payout?status=COMPLETED&startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-31T23:59:59.000Z&page=1&limit=10
Host: api.holdinglegacy.io
Authorization: Basic base64(pk_live_xxxx:sk_live_yyyy)

Resposta `200 OK`

{
  "data": [
    {
      "id": "payout_1A2B3C",
      "externalId": "ext_001abc",
      "status": "COMPLETED",
      "amount": 250000,
      "currency": "BRL",
      "pixKey": "[email protected]",
      "pixKeyType": "EMAIL",
      "referenceId": "comissao-parceiro-001",
      "beneficiaryName": "Maria Silva",
      "beneficiaryDocument": "83416281085",
      "feeAmount": 150,
      "netAmount": 249850,
      "createdAt": "2026-03-02T16:00:00.000Z",
      "updatedAt": "2026-03-02T16:05:00.000Z"
    },
    {
      "id": "payout_1A2B3D",
      "externalId": null,
      "status": "FAILED",
      "amount": 50000,
      "currency": "BRL",
      "pixKey": "11.222.333/0001-44",
      "pixKeyType": "CNPJ",
      "referenceId": "repasse-fornecedor-002",
      "beneficiaryName": "Empresa Fornecedora LTDA",
      "beneficiaryDocument": "11222333000144",
      "feeAmount": null,
      "netAmount": null,
      "createdAt": "2026-03-02T17:00:00.000Z",
      "updatedAt": "2026-03-02T17:02:00.000Z"
    }
  ],
  "meta": {
    "total": 23,
    "page": 1,
    "limit": 10,
    "totalPages": 3
  }
}

Campos da resposta

Campo	Tipo	Descrição
`data`	`array`	Lista de saques do período
`meta.total`	`integer`	Total de registros encontrados
`meta.page`	`integer`	Página atual
`meta.limit`	`integer`	Itens por página
`meta.totalPages`	`integer`	Total de páginas disponíveis
`feeAmount`	`integer \| null`	Taxa cobrada pelo saque em centavos
`netAmount`	`integer \| null`	Valor líquido transferido ao beneficiário em centavos

📘
Saques com status: FAILED têm o saldo estornado automaticamente
Você não precisa solicitar o estorno manualmente. O saldo retorna à sua conta disponível e você receberá um webhook com o status atualizado.

Updated 38 minutes ago