Skip to main content
Consulte um pedido pelo ID do pedido. Este endpoint oferece suporte a dois modos de leitura: o acesso anônimo retorna apenas os campos mínimos necessários para a página de pagamento; o proprietário do pedido que porta o Account Token recebe os detalhes completos.

Visão geral da API

/orders/{id} e /orders/{id}/ estão disponíveis atualmente. O ID do pedido faz parte do link de pagamento e deve ser tratado como um identificador opaco sensível, não o divulgue publicamente.

Consulta anônima

A página de pagamento pode ler diretamente quando o estado de login for perdido:
A resposta anônima inclui apenas id, description, price, state, pay_way, pay_url, expired_at, created_at. Ela não retorna identificadores internos de conta, Application, Package, pagamento ou metadata.

Consulta autenticada

O proprietário do pedido receberá os detalhes completos de Order, incluindo application / applications, package / packages, bank_details, invoice_automation e campos do modelo. Se estiver autenticado, mas não for o proprietário do pedido, retornará 403; exceto para superadministradores.

Campos principais

A resposta completa pode adicionar campos conforme o método de pagamento, os clientes devem ler conforme necessário e sempre evitar registrar metadata sensíveis na resposta completa.

Tratamento de erros

  • 404: o ID do pedido não existe.
  • 403: está conectado, mas não é o proprietário do pedido.
  • Solicitações anônimas não retornam 401; elas recebem apenas a projeção pública mínima.

APIs relacionadas