Referência da API

Pedidos

Checkout dos débitos em Pix, boleto ou cartão, e a leitura do pagamento.

O pedido soma os débitos escolhidos e a taxa de serviço da marca. Criar pedido ou pagar no cartão conta no limite de 30 requisições por hora.

POST/api/v1/orders

Abre o pedido. Os ids precisam ser itens pagáveis de consultas desta conta.

Corpo

Campo	Tipo	Presença	Descrição
`debt_item_ids`	`uuid[]`	obrigatório	Pelo menos um item.
`method`	`string`	obrigatório	pix, boleto ou credit_card.

curl https://api.zera.mobi/api/v1/orders \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f" \
-H "Content-Type: application/json" \
-d '{"debt_item_ids":["99aa88bb-77cc-66dd-55ee-4433221100ff"],"method":"pix"}'

{
"id": "55ee44dd-33cc-22bb-11aa-009988776655",
"status": "awaiting_payment",
"method": "pix",
"purpose": "debts",
"plate": "ABC1D23",
"uf": "SP",
"vehicle_id": "8c1d9e2a-7b34-4f10-9a11-22b33c44d55e",
"debts_amount": "129.90",
"service_fee": "9.90",
"total_amount": "139.80",
"refunded_amount": "0.00",
"latest_attempt": {
  "method": "pix",
  "status": "pending",
  "pix_copy_paste": "00020126360014BR.GOV.BCB.PIX",
  "pix_expires_at": "2026-10-20T12:31:00-03:00"
}
}

GET/api/v1/orders/{order_id}

Lê o pedido, os itens e a última tentativa de pagamento. Use este GET para esperar o Pix e a liquidação.

Listagem

Campo	Tipo	Presença	Descrição
`vehicle_id`	`uuid`	opcional	Filtra os pedidos do veículo.
`status`	`string`	opcional	Status exato do pedido.
`method`	`string`	opcional	pix, boleto ou credit_card.
`q`	`string`	opcional	Trecho da placa.
`created_after`	`date`	opcional	Data inicial, YYYY-MM-DD.
`created_before`	`date`	opcional	Data final, YYYY-MM-DD.

curl https://api.zera.mobi/api/v1/orders/55ee44dd-33cc-22bb-11aa-009988776655 \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f"

GET /api/v1/orders devolve a lista paginada com os filtros acima. GET /api/v1/orders/summary agrega quantidade e valor por status e por método.

POST/api/v1/orders/{order_id}/pay-card

Cobra um pedido que nasceu como credit_card e ainda está awaiting_payment.

Corpo

Campo	Tipo	Presença	Descrição
`holder_name`	`string`	obrigatório	Nome impresso no cartão.
`number`	`string`	obrigatório	PAN, 13 a 19 dígitos.
`expiry`	`string`	obrigatório	MM/AA.
`cvc`	`string`	obrigatório	3 ou 4 dígitos.
`installments`	`integer`	opcional	1 a 12. Padrão: 1.

curl -X POST \
https://api.zera.mobi/api/v1/orders/55ee44dd-33cc-22bb-11aa-009988776655/pay-card \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f" \
-H "Content-Type: application/json" \
-d '{"holder_name":"MARIA SILVA","number":"4111111111111111","expiry":"12/30","cvc":"123","installments":1}'

POST /api/v1/orders/{order_id}/pix gera outro copia e cola se o atual não existe ou já venceu, e só enquanto o pedido Pix aguarda pagamento. POST /api/v1/checkout/preview calcula debts_amount, service_fee, total_amount e a grade installments sem criar pedido.