Criar Boleto

Campo

Tipo

Descrição

your_number

string

due_date

string

Data de vencimento YYYY-MM-DD

amount

number

Valor da cobrança em centavos de reais.

payer_name

string

Nome do pagador

payer_document

string

Documento CPF ou CNPJ do pagador

payer_email

string

Email do pagador

payer_phone_prefix

string

Prefixo do telefone do pagador (apenas os dois números do prefixo)

payer_phone_number

string

Número de telefone do pagador

payer_address_zipcode

string

CEP de endereço do pagador

payer_address_public_place

string

Rua do endereço do pagador

payer_address_neighborhood

string

Bairro do endereço do pagador

payer_address_number

string

Número de endereço do pagador

payer_address_complement

string | null

Complemento do endereço do pagador

payer_address_city

string

Cidade do endereço do pagador

payer_address_state

string

UF do estado do endereço do pagador

webhook_url

string

Caso tenha um servidor para receber as informações de pagamento ou estorno informe aqui sua URL, campo pode ser vazio ""

split_rules

[]

Caso queira fazer split envie o seguinte Obj dentro do Array com o valor do split e o ID da conta: { value: number, account_id: string }