Link de pagamento

O link de pagamento gera uma URL para uma cobrança avulsa. Você cria o pedido no API Gateway, envia checkout_url ao pagador e, depois do pagamento, consulta o status ou recebe uma notificação.

Este produto não faz parte do BaaS e não se consome no host da Minha Conta. O integrador só usa o API Gateway (https://api.nuvende.com.br ou, em homologação, https://api-h.nuvende.com.br). O recurso é POST /api/v2/checkout. A autenticação é o login do Gateway (client_credentials) com os scopes checkout.read e checkout.write. A conta cobradora é a da aplicação autenticada.

Não envie account_id no corpo, nem os headers Account-Id, Application-Id, Partner-Id, seller-id ou assinatura HMAC. O Gateway monta isso para o upstream. Se account_id vier no corpo, é ignorado.

Fluxo

1. Obtenha um token no Gateway com os scopes do link de pagamento. Veja Autenticação.
2. Crie o link em POST /api/v2/checkout e guarde id e checkout_url.
3. Envie o pagador para checkout_url. Ele escolhe Pix, boleto ou cartão, conforme os métodos que você habilitou.
4. Quando o pagamento concluir, o status passa a PAID.
5. Se você informou redirect_url, o navegador do pagador volta para o seu site com a query documentada em Retorno e notificação.
6. Se você informou notification_url, a Nuvende envia um único POST. A confirmação oficial continua sendo o GET.

O que esta API faz

• Cobrança por valor, sem lista de produtos (type UNIQUE).
• Cobrança com itens (type SMART). O total das linhas precisa bater com amount, quando os dois são enviados.
• Consulta e inativação do link da sua conta.
• Retorno do pagador e notificação HTTP, ambos opcionais.

O que esta API não faz

• Assinatura, carnê ou cobrança recorrente.
• Cadastro separado de clientes ou produtos. Os dados vão no próprio create.
• Listagem paginada de links.
• Devolver QR Code ou linha digitável no lugar do link.

Status

Próximos passos

• Autenticação
• Criar link
• Cliente e itens
• Retorno e notificação
• Erros
• Homologação
• Novidades