Schedule boleto payment

It follows the same principle as payment in other flows, with the main difference being that you must send the schedule_date, and in this case, you will receive the schedule_key.

Request

ENDPOINT

/bank_slip/payment

METHOD

POST

Request Body

{
    "digitable_line": "32990001031000000001708001075103794890000015000",
    "source_account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
    "payment_date": "2023-09-25",
    "transaction_amount": 150.00
}

Body params

Field	Type	Description	Characters
digitable_line *	string	Boleto's digitable line.	-
resource_account_key *	string	Key of the account to be used.	-
payment_date *	date	Date for payment. If not sent, the date will be today.	-
transaction_amount	float	Amount to be paid.	-

Information

To view the accepted payment agreements, click here.

Response

STATUS

200

Response Body: Payment through a free movement account

{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "waiting_approval",
    "webhook_type": "bank_slip_payment"
    "schedule_key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2"
}

STATUS

200

Response Body: Payment through a escrow account

{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "waiting_approval",
    "webhook_type": "bank_slip_payment",
    "schedule_key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2"
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}