Criando uma cobrança

Aqui você pode criar cobranças via boleto, atualmente nós oferecemos as opções de boleto a vista ou parcelado, com boleto a vista, é gerado apenas 1 boleto, com boleto parcelado, é gerado a quantidade de boletos que você especificar na requisição por meio do installments.

Para boletos parcelado, você recebe os valores conforme seu cliente vai pagando a parcela, para uma taxa maior de sucesso nas suas cobranças, nós recomendando fortemente que você ative a régua de cobrança em todas as suas cobranças, deste modo, nós ficaremos lembrando o seu cliente sobre o débito de forma ativa, antes, depois do vencimento e no dia do vencimento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

o id do seu cliente

int32
required
Defaults to 2

informe o tipo de pagamento, 1 para O cliente escolhe, 2 para boleto, 3 para cartão(nesta modalidade, é necessário informar os dados do cartão),.

float
required

valor do boleto a vista, para boleto parcelado, você precisa informar a quantidade de parcelas usando installments e o valor por parcela usando installment_value, no caso do boleto parcelado, você não deve enviar o amount, apenas installments e installment_value.

float

percentual de juros ao mês sobre o valor da cobrança para pagamento após o vencimento

string

percentual de multa sobre o valor da cobrança para pagamento após o vencimento

int32
Defaults to 1

quem paga as taxas? informe 1 para você mesmo, ou 2 para colocar as taxas para o seu cliente pagar, atualmente, só funciona para boleto.

date

régua de cobrança, caso ativada, nós enviaremos um lembretes frequentes para seu cliente, caso o boleto fique vencido há mais de 3 dias, nós começamos a ligar para o cliente, este serviço possui um custo adicionado, verifique em sua conta qual será o custo, para habilitar, basta enviar uma data no formato Y-m-d.

string

[max: 100] informe uma etiqueta para que fique fácil de lembrar, por ex: venda de tenis nike

date
required

data de vencimento do boleto

string

[max: 100] algo que identifique esta cobrança no seu sistema, como ID, e etc, pense como algo que te auxilie no tratamento ou em alguma consulta no recebimento do webhook.

boolean
Defaults to true

para enviar o boleto por email, informe true, para não enviar, informe false

string

[max: 70] informe uma url para recebimento de notificações via webhook, caso você não informe, será considerada a url definida em configurações.

card
object
boolean
required
Defaults to false

Válido apenas quando o cartão é enviado, caso este parametro não seja passado ou seja passado com false, a cobrança será apenas autorizada, para efetuar a cobrança de fato, é necessário efetuar a captura, basta passar true para isso, caso precise, você pode capturar a cobrança posteriormente usando a requisição de captura.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json