v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB

Saques

Listar saques

Retorna uma lista paginada de saques com suporte a filtros.

get/v1/cashouts

Query parameters

pageinteger

Example:1

Numero da pagina

pageSizeinteger

Example:20

Itens por pagina (max: 100)

Example:Completed

Filtrar por status

startDatestring date-time

Example:2025-01-01T00:00:00Z

Data inicial (ISO 8601)

endDatestring date-time

Example:2025-01-31T23:59:59Z

Data final (ISO 8601)

Response

Lista de saques

messagestring nullable

Example response

{
  "data": {
    "items": [
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "amount": 50000,
        "fee": 200,
        "netAmount": 49800,
        "status": "Completed",
        "pixKeyType": "CPF",
        "pixKey": "***456789**",
        "endToEndId": "E12345678202501151600xyz789abc012",
        "requestedAt": "2025-01-15T16:00:00Z",
        "completedAt": "2025-01-15T16:05:00Z",
        "createdAt": "2025-01-15T16:00:00Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 10,
    "totalPages": 1
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}