Pular para o conteúdo principal
POST
Criar boleto

Autorizações

x-api-key
string
header
obrigatório

API Key da organização

Corpo

application/json
idempotency
string
obrigatório

Identificador único do boleto por organização. Garante que o mesmo boleto não seja emitido duas vezes.

Minimum string length: 1
value
number
obrigatório

Valor do boleto em reais (ex.: 150.00). Deve ser positivo e maior ou igual a R$ 3,00.

Intervalo obrigatório: x >= 3
payer
object
obrigatório

Dados do pagador do boleto.

description
string

Descrição opcional do boleto (máximo 100 caracteres).

Maximum string length: 100
dueDate
string

Data de vencimento do boleto no formato YYYY-MM-DD (opcional; usa o padrão da organização se omitida).

Pattern: ^\d{4}-\d{2}-\d{2}$
expirationDate
string

Data limite para pagamento após o vencimento, no formato YYYY-MM-DD (opcional).

Pattern: ^\d{4}-\d{2}-\d{2}$
boletoType
enum<string>

Tipo do boleto: OTHER (padrão) ou PROPOSAL.

Opções disponíveis:
OTHER,
PROPOSAL

Resposta

Requisição processada com sucesso

Requisição processada com sucesso

response
object
obrigatório

Dados retornados pela operação; null quando não há conteúdo.

message
string
obrigatório

Mensagem que descreve o resultado.