Request Payment

Route to create a new static QRcode payment request 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
origin_accountObjectOrigin account information
accountStringOrigin account
documentStringOrigin document
nameStringOrigin name
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
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 00020126830014br.gov.bcb.pix01364004901d-bd85-4769-8e52-cb4c42c506dc0000Jornada pagador 956585204000053039865406605.965802BR5903Pix6008BRASILIA62290525cfa559cddb494b03855d2bd9a61234567

QR Code Receiver

string
required
Defaults to -11.100,-22.200

Client Geo Localization

string
required
Defaults to 123.123.123.123

Client IP Address

string
required
Defaults to "Web - Google Chrome

Client System

float
Defaults to 100

Amount QR Code Receiver

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