Create Payment Boleto

Route for the creation of a new request for the payment of a boleto using the client's unique bank account code

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

🚧

If inform the amount in the body and the boleto not allow to change value, it is returned error in response

🚧

If the boleto amount is zero, it is mandatory to inform the amount in the body.

❗️

Is necessary to register device on onboarding


Response parameters

ParametersFormatDescription
returnBooleanResponse status (true/false)
messageStringResponse message
dataObjectResponse data of boleto
billet_dataObjectboleto data
codeStringidentification code boleto
digitableStringDigitable boleto
bar_codeStringBar code bank slip
original_amountNumberOriginal amount boleto
interest_amountNumberInterest amount boleto
discounts_amountNumberDiscounts amount boleto
total_discounts_amountNumberTotal discounts amount boleto
fine_amountNumberFine amount boleto
total_fine_interest_amountNumberTotal fine interest amount boleto
amountNumberTotal amount boleto
paid_amountNumberPaid boleto
due_dateStringdue date boleto
inicial_hourStringInicial hour boleto
final_hourStringFinal hour boleto
payerObjectPayer boleto
documentStringPayer document boleto
nameStringPayer name bank slip
bankStringPayer bank boleto
bank_codeNumberPayer bank code boleto
receiverObjectReceiver boleto
documentStringReceiver document boleto
nameStringReceiver name boleto
bankStringReceiver bank boleto

Request Parameters

Path Params
string
required

Bank Account Code

Body Params
string
required

Client Geo Localization

string
required

Client IP Address

string
required

Client System

string

Client Device ID

string
Defaults to 12345678901234567890123456789012345678901234567

Digitable boleto ([0-9]{47})

string
Defaults to 12345678901234567890123456789012345678901234

Bar Code boleto ([0-9]{44})

float

amount to paid boleto

Responses

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