API v1

API de cobrança recorrente: assinaturas pela sua própria aplicação

REST em /api/public/v1, autenticação HTTP Basic, Idempotency-Key obrigatória nas escritas e webhooks assinados com HMAC SHA-256 para fechar o ciclo dentro do seu sistema.

HTTP Basic com client_id e client_secretIdempotency-Key obrigatória nas escritasAssinaturas, cobranças, vendas e reembolsosX-Request-Id para rastreio de chamada

Sem mensalidade · Sem fidelidade · Cancele quando quiser

V

Checkout Voren

Pagamento 100% seguro

Nome completo
E-mail
CPF
PixAprovação instantânea
Pagar agora

Liquidação D+0 · Split automático · Antifraude

v1

Versão pública estável

9

Recursos REST

18

Eventos de webhook

0%

Taxa no Pix

O que costuma dar errado numa integração de recorrência

Cobrança recorrente é um sistema distribuído: retry, timeout e ordem de eventos são o trabalho de verdade.

Cobrança duplicada por retry

Um timeout que o cliente HTTP repete sozinho é suficiente para cobrar duas vezes numa API sem idempotência.

Polling em vez de evento

Varrer a API a cada minuto atrasa a liberação de acesso e gasta requisição. Evento assinado resolve na hora.

Webhook sem validação

Endpoint que aceita qualquer POST é porta aberta para liberar acesso com payload falso.

Estado só no seu banco

Sem reconsultar o recurso, uma entrega perdida deixa o seu sistema para sempre desalinhado da cobrança real.

Recursos da API v1

01

/subscriptions

Criação e consulta de assinaturas, com ciclo e oferta.

02

/charges

Cobrança por catálogo, avulsa ou por carrinho com SKU e frete.

03

/sales e /refunds

Histórico de vendas por id e reembolso idempotente.

04

/products

Catálogo consultável para montar checkout no seu front.

05

/webhooks

Cadastro de URL e eventos, com entrega assinada e retentativa.

06

/ping

Verificação rápida de credencial antes de subir a integração.

Integração em seis passos

  1. 1

    1. Gere as credenciais

    client_id e client_secret no painel, usados em HTTP Basic.

  2. 2

    2. Teste no /ping

    Confirme autenticação antes de escrever qualquer fluxo de cobrança.

  3. 3

    3. Crie a assinatura

    POST em /subscriptions com Idempotency-Key própria por tentativa.

  4. 4

    4. Cadastre o webhook

    POST em /webhooks com a URL HTTPS e os eventos desejados.

  5. 5

    5. Valide a assinatura do evento

    Recalcule o HMAC SHA-256 antes de confiar no payload.

  6. 6

    6. Reconcilie por id

    Consulte /subscriptions/{id} e /sales/{id} para fechar divergência.

Perguntas frequentes

Como autentico na API?

Com HTTP Basic usando client_id como usuário e client_secret como senha, no header Authorization. As credenciais são geradas no painel e valem para todos os endpoints em /api/public/v1.

Quais endpoints existem?

Os endpoints públicos da v1 cobrem /ping para teste, /products, /charges, /subscriptions, /sales, /refunds, /shipments, /webhooks e /tokens. Cada recurso aceita consulta por id, como /subscriptions/{id} e /sales/{id}.

Como evito cobrar o cliente duas vezes?

Toda escrita exige o header Idempotency-Key. Se a mesma chave for reenviada — timeout, retry automático, dedo no botão — a API devolve o resultado da primeira chamada em vez de criar uma nova cobrança.

Dá para criar cobrança de item que não está cadastrado?

Sim. /charges aceita modo catálogo (product_id e offer_id), modo avulso (amount_cents e item_name) e modo loja (lista de items com sku, quantidade e valor unitário, mais frete e endereço). Serve para SaaS, e-commerce e sistemas próprios.

Como acompanho o ciclo da assinatura?

Por webhook: subscription.created, subscription.updated, subscription.charged e subscription.canceled avisam cada mudança. Para reconciliar, consulte /subscriptions/{id} e /sales — ambos refletem o estado atual.

Consigo rastrear uma chamada específica no suporte?

Sim. Envie X-Request-Id na requisição; ele é aceito pela API e facilita localizar exatamente aquela chamada quando algo precisa ser investigado.

Reembolso também é via API?

Sim, pelo endpoint /refunds, com a mesma exigência de Idempotency-Key. O reembolso dispara sale.refunded no seu webhook, então o seu sistema pode revogar acesso sem checagem manual.

Integre hoje, sem mensalidade

Crie a conta, gere as credenciais da API v1 e cobre pela sua própria aplicação. Você paga a taxa quando vende — e no Pix a taxa é 0% com liquidação em D+0.

Ver a documentação da API

Leva menos de 2 minutos · Não pedimos cartão

Continue explorando