Consultar pedido

Retorna o detalhe completo de um pedido: identidade, status, prazo de pagamento, os produtos congelados na submissão (com seus objetos de risco), a cobrança, o segurado e a trilha de eventos.

O pedido não retorna apólices

O pedido é a visão da venda. Após a emissão (emitted), as apólices vivem em um recurso próprio — consulte-as com GET /v1/insurance/policies?order_key=.

Request

ENDPOINT

/v1/insurance/orders/{order_key}

MÉTODO

GET

Path params

Parâmetro	Tipo	Obrigatoriedade	Descrição
order_key	string	obrigatório	Chave do pedido.

Response

STATUS

200

Response Body

{
  "order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
  "status": "emitted",
  "distribution_type": "direct",
  "quote_data": {
    "total_order_amount": 617.28,
    "products": [
      {
        "order_product_key": "7f3a9c2e-0b5d-4e8a-a1c6-9d4b2e7f0a53",
        "product_key": "9d1f8c7a-3b21-4e60-8a2f-1c5d7e9b0a44",
        "product_category": "insurance",
        "insurance_class": {
          "name": "credit_life",
          "class_number": "0977",
          "group_number": "09"
        },
        "regulator_registration": "15414.900388/2015-21",
        "contract_instrument_type": "ticket",
        "gross_premium_amount": 617.28,
        "iof_amount": 2.35,
        "net_premium_amount": 614.93,
        "term": {
          "start_date": "2026-07-15",
          "end_date": "2027-07-14"
        },
        "risk_object": {
          "type": "credit_operation",
          "insurable_value": 50000.00,
          "attributes": {
            "installment_amount": 1050.00,
            "number_of_installments": 48
          }
        },
        "services": [
          {
            "service_key": "0a3c5e7f-2b4d-4a6c-8e0f-1a3b5c7d9e2f",
            "service_type": {
              "code": "credit_life",
              "name": "Prestamista (Credit Life)"
            },
            "service_category": "insurance",
            "regulator_registration": null,
            "gross_premium_amount": 617.28,
            "insured_amount": 50000.00,
            "unit_amount": null,
            "unit_count": null,
            "deductible_data": {
              "deductible_type": "monetary_amount",
              "value": 1500.00
            },
            "waiting_period_days": 30,
            "service_attributes": {},
            "term": {
              "start_date": "2026-07-15",
              "end_date": "2027-07-14"
            }
          }
        ]
      }
    ]
  },
  "payment_data": {
    "payment_method": "pix_automatic",
    "installment_count": 12,
    "installment_amount": 51.44,
    "first_installment_amount": 51.44,
    "first_due_date": "2026-07-23"
  },
  "customer": {
    "document_number": "96969879003",
    "name": "Maria Souza",
    "email": "maria@example.com",
    "phone_number": "+5511999990000",
    "date_of_birth": "1987-03-22",
    "occupation_code": "211205"
  },
  "events": [
    {
      "new_status": "emitted",
      "at": "2026-07-16T14:03:22Z"
    }
  ]
}

Atributos da resposta

Campo	Tipo	Descrição
order_key	string	Chave única do pedido.
status	string	Status atual. Veja o ciclo de vida.
expires_at	string	Prazo para o pagamento da primeira parcela (7 dias a partir da submissão). null em um pedido rejected.
distribution_type	string	Modelo de distribuição da venda. Hoje sempre direct.
payment_data	object	A cobrança do pedido — mesmo bloco retornado na criação. O sub-objeto payment_artifact (o QR Pix) só é reexposto enquanto o pedido está awaiting_payment; em um pedido emitido ou terminal ele é omitido. null em um pedido rejected.
quote_data	object	Os produtos congelados na submissão — mesmo bloco, com a mesma forma, retornado na criação do pedido.
quote_data.total_order_amount	number	Valor total do pedido (soma dos prêmios brutos dos produtos).
customer	object	O segurado do pedido, em objeto plano: document_number, name, email, phone_number, date_of_birth, occupation_code. Devolvido exatamente como foi submetido — a data de nascimento é o dado congelado; a idade usada na precificação foi derivada dela na submissão e não é armazenada. Os campos opcionais (occupation_code, address) só aparecem se tiverem sido enviados: nada é preenchido por padrão, e a chave é omitida em vez de vir null.
events	array	Trilha de mudanças de status do pedido, em ordem cronológica. Cada entrada é { "new_status", "at" }.

Objeto em quote_data.products

Campo	Tipo	Descrição
order_product_key	string	Chave do produto dentro do pedido — a correlação com a apólice gerada na emissão.
product_key	string	Chave do produto no catálogo.
product_category	string	Categoria do produto: insurance, capitalization ou benefit.
insurance_class	object	Ramo do seguro: { name, class_number, group_number }. null para produtos não securitários.
regulator_registration	string	Registro do produto no regulador (ex.: processo SUSEP).
contract_instrument_type	string	Instrumento contratual congelado do produto: ticket (bilhete) ou policy (apólice). null para produtos não securitários.
gross_premium_amount	number	Prêmio bruto do produto (com IOF).
iof_amount	number	IOF do produto.
net_premium_amount	number	Prêmio líquido do produto (sem IOF).
term	object	Vigência do produto, congelada na submissão: { start_date, end_date }. Produtos do mesmo pedido podem ter vigências diferentes.
risk_object	object	O objeto de risco congelado deste produto (type, insurable_value, attributes).
services	array	Coberturas congeladas — cada uma com service_type ({ code, name }), service_category, regulator_registration, prêmio bruto, importância segurada, o par por unidade (unit_amount / unit_count, null quando a cobertura não é precificada por unidade), franquia (deductible_data), carência (waiting_period_days), atributos e vigência (term).

Pedido rejected na consulta

Um pedido nascido rejected não persiste produtos nem cobrança: a consulta devolve quote_data.products vazio e payment_data nulo, e não repete os decline_reasons. Os motivos da recusa são entregues uma única vez, no 201 da submissão — registre-os no seu lado.

Possíveis erros

Todo erro (non-2xx) retorna o corpo padrão { "title", "description", "translation", "code" } — trate programaticamente apenas o campo code.

Status	Código	Descrição
401 / 403	—	Falha de autenticação ou autorização.
404	ORD000001	Pedido inexistente ou pertencente a outra integração — os casos são indistinguíveis.
500 / 503	QIT000500	Erro interno ou serviço indisponível — seguro repetir a chamada.