Documentação da API

Um único endpoint de webhook conecta o seu sistema de vendas à Nacional Express. Assim que o pagamento é aprovado, o rastreio e os e-mails automáticos começam sozinhos.

Autenticação

Envie o token gerado em Admin → Integração no cabeçalho de autorização de toda chamada.

Authorization: Bearer SEU_TOKEN_AQUI

Endpoint

Registra o pagamento do pedido e, se aprovado, dispara o e-mail de confirmação com o código de rastreio.

POST https://nacionalexpress.delivery/api/webhooks/pagamento

Campos do corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
referencia_externa	string	Sim	ID do pedido no seu sistema. Usado para identificar o pedido em chamadas futuras.
status	string	Não	Status do pagamento. Use "aprovado" para disparar o e-mail de confirmação.
cliente_nome	string	Não	Nome do cliente, usado nos e-mails automáticos.
cliente_email	string	Não	E-mail do cliente. Obrigatório para o envio dos e-mails automáticos.
cidade	string	Não	Cidade de entrega, exibida no painel do lojista.
valor	number	Não	Valor do pedido em reais, exibido no e-mail e no painel.
produto_nome	string	Não	Nome do produto vendido. Se enviado junto com o pagamento aprovado, gera a nota fiscal (DANFE) automaticamente e a envia por e-mail ao cliente.
produto_quantidade	number	Não	Quantidade do produto na nota fiscal. Padrão: 1.
cliente_documento	string	Não	CPF ou CNPJ do cliente, exibido na nota fiscal.
cliente_endereco	string	Não	Endereço de entrega, exibido na nota fiscal.
cliente_bairro	string	Não	Bairro de entrega, exibido na nota fiscal.
cliente_cep	string	Não	CEP de entrega, exibido na nota fiscal.
cliente_uf	string	Não	UF de entrega, exibida na nota fiscal.
cliente_telefone	string	Não	Telefone do cliente, exibido na nota fiscal.

Exemplo de chamada

curl -X POST https://nacionalexpress.delivery/api/webhooks/pagamento \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "referencia_externa": "PEDIDO-1234",
    "status": "aprovado",
    "cliente_nome": "Maria Silva",
    "cliente_email": "maria@exemplo.com",
    "cidade": "São Paulo",
    "valor": 149.90,
    "produto_nome": "Fone de ouvido bluetooth",
    "produto_quantidade": 1,
    "cliente_documento": "123.456.789-00",
    "cliente_endereco": "Rua Exemplo, 100",
    "cliente_bairro": "Centro",
    "cliente_cep": "01310-100",
    "cliente_uf": "SP",
    "cliente_telefone": "(11) 99999-9999"
  }'

Resposta

{
  "ok": true,
  "pedido_id": "23ed5249-e076-4b68-bd54-e41db7ede787",
  "pagamento_status": "aprovado"
}

Pronto para conectar sua loja?

Crie sua conta e gere seu token de integração em menos de um minuto.

Criar conta da loja