Jump to Content
API Reference
v1.3
v1.4
v1.5
Log In
API Reference
Log In
v1.5
API Reference
The Payer object
All
Pages
Start typing to search…
JUMP TO
GETTING STARTED
Quickstart
Authentication
Tokens
The Access Token object
Create an Access Token
post
API errors
Pagination
Metadata
Payment
Pix QR Code
The Pix QR Code object
Create a Pix QR Code
post
Retrieve a Pix QR Code
get
List all Pix QR Codes
get
Refund a Pix QR Code
del
Get receipt
get
Credit Card
3DS integration
The Credit Card object
The Card object
Create a Credit Card
post
Capture a Credit Card
post
Refund a Credit Card
del
Retrieve a Credit Card
get
List all Credit Cards
get
Tokenize a Card
post
ITP
Step By Step
The ITP object
OPF Banks
Create an ITP
post
Retrieve an ITP
get
List all ITPs
get
Boleto
The Boleto object
Create a Boleto
post
Retrieve a Boleto
get
List all Boletos
get
Bank Transfer
The Bank Transfer object
Retrieve a Bank Transfer
get
List all Bank Transfers
get
Payment links
The Link object
Create a Link
post
Retrieve a Link
get
List all Links
get
Recurring Pix
The Recurring Pix object
Create a Recurring Pix
post
Cancel a Recurring Pix
post
Developer
Endpoint
The Webhook Endpoint object
Create an Endpoint
post
Retrieve an Endpoint
get
Update an Endpoint
put
List all Endpoints
get
Delete an Endpoint
del
Webhook
The Webhook object
Retry policy
Validate signature
Resend a Webhook
post
Retrieve a Webhook
get
List all Webhooks
get
Finance
Bank Account
The Bank Account object
Create a Bank Account
post
Retrieve a Bank Account
get
List all Bank Accounts
get
Withdrawal
The Withdrawal object
Create a Withdrawal
post
Get qrcode data from dict
get
Retrieve a Withdrawal
get
List all Withdrawals
get
Get receipt
get
Balance
Get Balance
get
List all Transactions
get
Account API
Sub accounts
Quickstart
List sub accounts
get
Get sub account
get
Create sub-account
post
Update sub-account
put
Partners
Create partner
post
Get partner
get
Update partner
put
Delete partner
del
customer
Data Queries
Tax ID from Gov
get
🧩 Sqala Apps
3DS integration
White label checkout
How to create a checkout page
How it works
E-commerce
Magento
WordPress
Powered by
The Payer object
Ask AI
