LYNX UPBANK · Tecnologia de pagamentos Pix & Crypto

Emitir boleto

POST/v1/boleto/create

Emite um boleto bancário registrado e HÍBRIDO: o pagador pode pagar a linha digitável em qualquer banco ou lotérica, ou o Pix Copia e Cola do mesmo título. Qualquer um dos dois liquida a mesma cobrança. A taxa só é cobrada quando o boleto é pago; boleto emitido e não pago não gera cobrança nenhuma.

Permissão necessária: BOLETO:CREATE

Parâmetros

Parâmetro	Tipo	Descrição
`amountCents`obrig.	integer	Valor em centavos (ex.: 15000 = R$ 150,00). Mínimo 500 (R$ 5,00).
`payer`obrig.	object	Dados REAIS do pagador (título registrado): { "name": "Nome completo", "document": "CPF ou CNPJ, só números", "cep": "8 dígitos" }.
`description`	string	Descrição interna da cobrança.
`dueDays`	integer	Dias até o vencimento, de 1 a 5. Padrão 3. Boleto vencido sem pagamento é cancelado automaticamente, sem protesto.
`passFee`	boolean	Se true, a taxa é somada ao valor do boleto (você recebe o valor cheio).
`metadata`	object	Objeto livre devolvido nos webhooks e consultas.

Boas práticas

Mostre ao cliente a digitableLine E o brCode (Pix do boleto): pagando pelo Pix a confirmação chega em segundos; pela linha digitável em outro banco pode levar 1 dia útil.
pdfUrl entrega o boleto pronto em PDF (marca do seu perfil quando configurada): envie por e-mail ou WhatsApp.
Nome, CPF/CNPJ e CEP precisam ser reais: o boleto é um título registrado em nome do pagador.
Pagamento parcial não é aceito. Boleto vencido é cancelado automaticamente, sem protesto nem negativação.
Confirme o pagamento pelo webhook boleto.paid; a consulta de status é só reforço.

Requisição

bash

curl -X POST https://lynxpix.cc/api/v1/boleto/create \
  -H "Authorization: Bearer lynx_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":15000,"description":"Pedido #1234","payer":{"name":"João da Silva","document":"12345678909","cep":"01310100"},"dueDays":3}'

Resposta

json

{
  "data": {
    "id": "bol_9f8a2c1e",
    "kind": "boleto",
    "method": "BOLETO",
    "status": "PENDING",
    "amount": 15000,
    "netAmount": 14330,
    "boleto": {
      "ourNumber": "600000064",
      "digitableLine": "74891160090000642205902991121050115340000000500",
      "barcode": "74891153400000005001160000006422050299112105",
      "dueDate": "2026-07-18T02:59:59Z"
    },
    "brCode": "00020126910014br.gov.bcb.pix...",
    "brCodeBase64": "data:image/png;base64,iVBORw0KG...",
    "pdfUrl": "https://lynx.app/api/boleto/bol_9f8a2c1e/pdf",
    "devMode": true,
    "expiresAt": "2026-07-18T02:59:59Z",
    "createdAt": "2026-07-15T12:00:00Z"
  },
  "error": null
}