Create Deposit Charge Boleto Pix

Route for the completion of the deposit boleto using its unique boleto code

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

❗️

You must register device on onboarding before using this route

❗️

A valid Pix key must be registered for the origin account.


Response parameters

ParametersFormatDescription
returnBooleanResponse status (true/false)
messageStringResponse message
dataObjectObject with boleto data
codeStringIdentification code boleto
digitableStringBoleto digitable line
bar_codeStringBoleto bar code
receiverObjectReceiver Object
codeStringReceiver identification code
documentStringReceiver document
nameStringReceiver name
payerObjectPayer Object
documentStringPayer document
nameStringPayer name
pixObjectPix Object
imageStringPix QRcode image encoded in Base64
payloadStringPix "Copy and Paste" encoded in Base64

Request parameters

Path Params
string
required

Boleto request code

Body Params
string
required

Client Geo Localization

string
required

Client IP Address

string
required

Client System

string

Cliente Device ID

Responses

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