Saltar para o conteúdo principal
Consultar um pedido pelo ID do pedido. Este endpoint suporta dois modos de leitura: o acesso anônimo retorna apenas os campos mínimos necessários para a página de pagamento; quando o proprietário do pedido fornece um Account Token, são retornados os detalhes completos.

Visão geral da interface

/orders/{id} e /orders/{id}/ estão ambos disponíveis atualmente. O ID do pedido faz parte do link de pagamento e deve ser considerado 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 é perdido:
A resposta anônima inclui apenas id, description, price, state, pay_way, pay_url, expired_at, created_at. Ela não retorna conta, Application, Package, identificadores internos de 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, retorna 403; exceto para superadministradores.

Campos principais

A resposta completa pode adicionar campos conforme o método de pagamento; os clientes devem lê-los conforme necessário e sempre evitar registrar metadata sensível presente 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.

Estorno de fatura e nova solicitação

A fatura atual do pedido pode ser obtida por meio de GET /api/v1/orders/{order_id}/invoice/. Após o envio automático de estorno, a fatura ainda estará como Issued, e red_state indica o progresso do estorno; o envio bem-sucedido não significa que o estorno foi concluído. Enquanto aguarda confirmação, emissão de nota vermelha ou arquivamento, o pedido não pode solicitar uma fatura novamente. Quando um administrador solicita um estorno devido a erros nas informações de faturamento, como nome ou número fiscal, o motivo do estorno é “erro na emissão da fatura”; o estorno automático acionado pelo reembolso do pedido continua usando “interrupção do serviço”. Após a emissão e o arquivamento bem-sucedidos da nota vermelha, a fatura original passa para Voided, e só então o pedido pode solicitar novamente. A fatura original pode ser consultada no histórico de faturas. Quando o estorno falha ou o resultado aguarda verificação, a equipe financeira deve verificar e tratar o caso, e a restrição de faturamento do pedido não será removida antecipadamente. Faturas emitidas manualmente devem primeiro ser anuladas ou estornadas no sistema fiscal ou de faturamento, e depois confirmadas pela equipe financeira na plataforma.

Interfaces relacionadas