Começar

Início rápido

Cadastre um veículo, consulte os débitos e abra um pedido Pix.

O caminho feliz cabe em quatro chamadas. Troque a chave, a conta e os dados do veículo pelos seus.

1. Cadastrar o veículo

curl https://api.zera.mobi/api/v1/vehicles \
  -H "X-Api-Key: zera_live_..." \
  -H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{
    "plate": "ABC1D23",
    "renavam": "123456789",
    "uf": "SP",
    "owner_document": "12345678901"
  }'

A resposta 201 traz o id do veículo. O Renavam volta com 11 dígitos. O documento do proprietário não volta em claro: o campo de leitura é owner_document_masked.

2. Consultar débitos

curl -X POST \
  https://api.zera.mobi/api/v1/vehicles/8c1d9e2a-7b34-4f10-9a11-22b33c44d55e/consultations \
  -H "X-Api-Key: zera_live_..." \
  -H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f"

A consulta nasce com status: "pending". Leia o mesmo recurso até ready ou failed:

curl https://api.zera.mobi/api/v1/consultations/11aa22bb-33cc-44dd-55ee-66ff77889900 \
  -H "X-Api-Key: zera_live_..." \
  -H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f"

Em ready, use os items[].id com is_payable: true para montar o pedido. Há limite de 20 consultas por hora por credencial.

3. Abrir o pedido

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"
  }'

A resposta 201 pode já trazer latest_attempt.pix_copy_paste. Se o Pix ainda não estiver preenchido, leia GET /api/v1/orders/{order_id} de novo. O guia de Pix descreve os status.