Pedidos

Listar transações

GET
/orders

Lista todos os pedidos com suporte a filtros e paginação.

AuthorizationBasic <token>

Chave de Cash-In no formato Basic Auth

In: header

Query Parameters

status?string

Filtrar por status do pedido

Value in"pending" | "paid" | "expired" | "cancelled"
payment_method?string

Filtrar por método de pagamento

Value in"pix" | "card" | "boleto"
limit?integer

Número máximo de resultados

Default20
Range1 <= value <= 100
offset?integer

Número de resultados para pular

Default0
Range0 <= value
created_from?string

Filtrar pedidos criados a partir desta data (ISO 8601)

Formatdate-time
created_to?string

Filtrar pedidos criados até esta data (ISO 8601)

Formatdate-time

Response Body

application/json

application/json

curl -X GET "https://api.exemplo.com/v1/orders"
{
  "data": [
    {
      "id": "ord_123456789",
      "status": "paid",
      "amount": 10000,
      "currency": "BRL",
      "payment_method": "pix",
      "created_at": "2024-01-15T10:00:00Z"
    },
    {
      "id": "ord_987654321",
      "status": "pending",
      "amount": 5000,
      "currency": "BRL",
      "payment_method": "card",
      "created_at": "2024-01-15T09:00:00Z"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 20,
    "offset": 0
  }
}
{
  "error": "Unauthorized",
  "details": {
    "message": "Invalid or missing token"
  }
}