Request Payment

Route to create a new pix using the payer's unique bank account code

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

🚧

Every request have a expiry of 10 minutes

❗️

Is necessary to register device on onboarding

Response parameters

ParametersFormatDescription
returnBooleanResponse status (true/false)
messageStringResponse message
dataObjectObject with transaction
codeStringIdentification code
valueDecimalValue Qr code
spreadDecimalSpread Qr code
originObjectOrigin account information
origin_accountStringOrigin account
origin_documentStringOrigin document
origin_nameStringOrigin name
origin_account_agencyStringOrigin account agency
origin_account_bank_codeStringOrigin account bank code
origin_account_digitStringOrigin account digit
origin_account_typeStringOrigin account type
origin_bank_nameStringOrigin account bank name
receiverObjectReceiver account information
receiver_accountStringReceiver account
receiver_nameStringReceiver name
receiver_account_agencyStringReceiver account agency
receiver_account_bank_codeStringReceiver account bank code
receiver_account_digitStringReceiver account digit
receiver_account_typeStringReceiver account type
receiver_bank_nameStringReceiver account bank name

Request Parameters

Path Params
string
required

Bank Account Code

Body Params
string
required
Defaults to 12345678910

Document Receiver

string
required
Defaults to Receiver Name

Receiver Name

string
required
Defaults to 4700000

Receiver Account

string
required
Defaults to 0

Digit Account Receiver

string
required
Defaults to 0001

Agency Account Receiver

string
required
Defaults to CC

Type Account Receiver

string
required
Defaults to 470

Bank Account Receiver

string
required
Defaults to 10.00

Amount

string
required
Defaults to -11.100,-22.100

Client Geo Localization

string
required
Defaults to 123.123.123.123

Client Ip

string
required
Defaults to Web - Google Chrome

Client System

string
Defaults to YYYY-MM-DD

Scheduled Date for the Transaction

string

Message for the receiver

string
required
Responses

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