v10

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

Transacoes

Listar transacoes

Retorna uma lista paginada de transacoes com suporte a filtros.

get/v1/transactions

Query parameters

pageinteger

Example:1

Numero da pagina

pageSizeinteger

Example:20

Itens por pagina (max: 100)

status'Pending' | 'Completed' | 'Expired' | 'Failed' | 'Refunded'

Example:Completed

Filtrar por status

method'Pix' | 'CreditCard' | 'Boleto'

Example:Pix

Filtrar por metodo de pagamento

externalIdstring

Example:pedido_12345

Buscar por ID externo

customerIdstring uuid

Example:550e8400-e29b-41d4-a716-446655440000

Filtrar por ID do cliente

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 transacoes

messagestring nullable

Example response

{
  "data": {
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "externalId": "pedido_12345",
        "method": "Pix",
        "amount": 10000,
        "fee": 150,
        "netAmount": 9850,
        "currency": "BRL",
        "status": "Completed",
        "description": "Pagamento do pedido #12345",
        "environment": "Sandbox",
        "expiresAt": "2025-01-15T15:30:00Z",
        "completedAt": "2025-01-15T15:10:00Z",
        "createdAt": "2025-01-15T15:00:00Z",
        "customerId": "550e8400-e29b-41d4-a716-446655440000",
        "customer": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Joao Silva",
          "email": "joao@email.com",
          "document": "123.456.789-00"
        }
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 100,
    "totalPages": 5,
    "hasNextPage": true
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}