Skip to main content
POST
Criar Carnê

Visão Geral

Cria um carnê e registra apenas o primeiro boleto. As parcelas seguintes são emitidas mês a mês, e a venda só se torna real quando a parcela 1 compensa.
Carnê é crédito concedido por você, não parcelamento de cartão. Ninguém garante um boleto: se o comprador parar na parcela 4, você fica com 4 parcelas. Leia o guia do carnê antes de ativar.
Envie sempre X-Idempotency-Key. Esta chamada registra um boleto de verdade no banco — uma retentativa sem a chave coloca dois códigos de barras pagáveis na mão do mesmo comprador. A mesma chave devolve o carnê original por 24h.

Exemplo de Requisição

Parâmetros

string
required
UUID do produto. O produto precisa ter carnê habilitado.
number
required
ID numérico do cliente. Clientes já têm um uuid público (veja Clientes), mas este endpoint ainda linka pelo id numérico interno — obtenha-o via POST /api/customers (API interna) ou no dashboard.
number
required
Número de parcelas, de 2 a 12. Uma parcela só não é carnê. O teto da plataforma é 12 e o vendedor pode definir um menor por produto.
string
Vencimento da parcela 1 em YYYY-MM-DD. Padrão: hoje. Deve cair nos próximos 90 dias. As demais parcelas caem no mesmo dia dos meses seguintes, calculadas a partir dessa âncora — por isso um carnê ancorado em 31/01 não “escorrega” depois de fevereiro.
number
Afiliado que fez a venda. Fixado no momento da venda: todas as parcelas seguintes herdam ele, então omitir aqui significa não pagar comissão nenhuma no carnê inteiro. Precisa ter afiliação ativa neste produto — caso contrário a chamada é recusada, em vez de descartar a atribuição em silêncio.

Resposta

Só a parcela 1 aparece com boleto. As demais ainda não existem como slip pagável — elas são criadas quando a parcela 1 compensa.

Erros