Request Payment

Route to create a new pix by key 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
dataArray of ObjectObject with transaction
codeStringIdentification code
valueDecimalValue Qr code
spreadDecimalSpread Qr code
origin_accountObjectOrigin account information
documentStringOrigin document
nameStringOrigin name
accountStringOrigin account
agencyStringOrigin account agency
bank_codeStringOrigin account bank code
digitStringOrigin account digit
typeStringOrigin account type
bank_nameStringOrigin account bank name
receiver_accountObjectReceiver account information
accountStringReceiver account
nameStringReceiver name
documentStringReceiver document
agencyStringReceiver account agency
bank_codeStringReceiver account bank code
digitStringReceiver account digit
typeStringReceiver account type
bank_nameStringReceiver account bank name

Request Parameters

Path Params
string
required

Bank Account Code

Body Params
string
required
Defaults to 12345678910

Key Receiver

float
Defaults to 10

Amount

string
required
Defaults to -11.100,-22.100

Client Geo Localization

string
required
Defaults to 123.123.123.123

Client IP Address

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