Preloader
Desenvolvedor

Gerar Boleto

Cria cobrança por boleto e retorna dados de pagamento, linha digitável e URLs de PDF/carnê.

Endpoint: POST /api/v1/boletos
curl -X POST 'https://api.vexuspay.com/api/v1/boletos' \
  --header 'Authorization: Bearer SEU_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 200.50,
    "dueDate": "2026-03-10",
    "description": "Pedido 123",
    "clientCallbackUrl": "https://seusistema.com/webhooks/boletos",
    "payer": {
      "name": "Fulano de Tal",
      "email": "fulano@email.com",
      "document": "12345678909",
      "phone": "11999999999"
    }
  }'
{
  "message": "Boleto criado com sucesso.",
  "data": {
    "id": 1234,
    "status": "PENDING",
    "amount": 200.5,
    "dueDate": "2026-03-10",
    "pdfUrl": "https://api.vexuspay.com/api/v1/boletos/1234/pdf",
    "bankSlip": {
      "identificationField": "23790...",
      "nossoNumero": "123456",
      "barCode": "23790..."
    }
  }
}
Rotas auxiliares
  • GET /api/v1/boletos/{id}/identification-field
  • GET /api/v1/boletos/{id}/pdf
  • GET /api/v1/boletos/installments/{installmentId}/payment-book