Create a bill payment

Creates a bill payment from the bank slip's digitable line.

Without scheduleDate, the payment follows the immediate processing flow. To schedule the payment for a future date, provide scheduleDate according to the scheduling rules applicable to the bank slip.

Creating the operation does not confirm that the bank slip has been paid. The payment may go through intermediate statuses or fail later during processing.

📘

Tracking the payment

Use Webhooks to track status changes until the operation's outcome.

In case of a timeout or an inconclusive response, do not immediately create a new payment for the same bill. First check whether the operation has already been registered.

See the Bill Payment events.

Related content

Guides

Error Library

Body Params
string
required

Digitizable bill line

string

Payment scheduling date

string

Bill Payment Description

number

Discount attributed to payment

number

Interest attributed to payment

number

Fine assigned to payment

date

Expiration date of the account if it is the type that does not have this information

number

Account value if it is the type that does not have this information (Ex: credit card invoices)

string

Unique identifier of the bill in your system

Responses

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