API enxuta, sem surpresas
Uma API bem desenhada vale mais do que mil SDKs. Autenticação por API key com escopos, idempotência, webhooks assinados e uma especificação OpenAPI que diz tudo sem esconder nada.
Criar uma cobrança multi-método
A criação de pagamento hospedado retorna um checkoutUrl. O pagador escolhe o método dentro do checkout YuvexPay e é redirecionado de volta ao seu completion URL.
- Autenticação Bearer com API key por ambiente
- X-Idempotency-Key obrigatório em POST
- Resposta tipada com status e método selecionado
- Webhooks complementares para PAID, EXPIRED, REFUNDED
// Use a API key gerada no dashboard (Configurações → Chaves de API).
// ypk_test_... para sandbox, ypk_live_... para produção.
const API_KEY = process.env.YUVEX_API_KEY!;
const res = await fetch("https://api.yuvexpay.com/v1/payments", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${API_KEY}`,
"X-Idempotency-Key": "ord_10294",
},
body: JSON.stringify({
amount: 149.9,
description: "Pedido #10294",
mode: "hosted",
methods: ["PIX", "CARD", "BOLETO"],
completionUrl: "https://loja.com/pedido/10294/sucesso",
customer: { name: "Ana Souza", email: "ana@empresa.com" },
}),
});
const { checkoutUrl } = await res.json();
window.location.href = checkoutUrl;Tudo o que um time de engenharia espera.
API keys com escopo
Chaves por ambiente (ypk_test_, ypk_live_) e por empresa, com scopes granulares, rotação auditada e revogação em um clique.
Webhooks HMAC
Cada payload assinado com HMAC SHA-256. Valide com o segredo compartilhado e confirme origem.
Idempotência nativa
Cabeçalho X-Idempotency-Key em toda operação crítica. Retry seguro sem cobrar o cliente duas vezes.
OpenAPI 3.1 + Zod
Spec pública completa, geração de tipos automatizada, validação server-side com Zod.
Sandbox com paridade
Ambiente espelhando produção: mesmos endpoints, mesma semântica, dados isolados.