Criar um pagamento de conta

Cria um pagamento de conta a partir da linha digitável do boleto.

Sem scheduleDate, o pagamento segue o fluxo de processamento imediato. Para programar o pagamento para uma data futura, informe scheduleDate conforme as regras de agendamento aplicáveis ao boleto.

A criação da operação não confirma que o boleto foi pago. O pagamento pode passar por estados intermediários ou falhar posteriormente durante o processamento.

📘

Acompanhamento do pagamento

Utilize Webhooks para acompanhar as mudanças de estado até o resultado da operação.

Em caso de timeout ou resposta inconclusiva, não crie imediatamente um novo pagamento para a mesma conta. Verifique primeiro se a operação já foi registrada.

Consulte os eventos para Pague Contas.

Conteúdos relacionados

Guides

Biblioteca de Erros

Body Params
string
required

Linha digitável do boleto

string

Data de agendamento do pagamento

string

Descrição do pagamento de conta

number

Desconto atribuído ao pagamento

number

Juros atribuído ao pagamento

number

Multa atribuída ao pagamento

date

Data de vencimento da conta caso seja do tipo que não possui essa informação

number

Valor da conta caso seja do tipo que não possui essa informação (Ex: faturas de cartão de crédito)

string

Identificador do boleto no seu sistema

Responses

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