Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Access Key Return
All
Pages
Start typing to search…
JUMP TO
Introduction and General Aspects
Introduction
Registration and Credentialing
API Endpoints
API REST
Simulation Cards
Postman Collection
Authentication and Authorization
Bearer Token and Access Key
Authentication and Authorization
post
Creation of Access Key
post
Fetch access keys by seller ID
get
Delete access key
del
Access Key Return
Credentialing
Sellers
Create individual seller
post
Create company seller
post
List sellers
get
Fetch seller by ID
get
Seller Return
Pix Key
Keys
Create PIX key
post
List keys
get
Fetch key by key_id
get
Delete PIX key by key_id
del
PIX Key Return
Pix Payment
Payer
Create payer
post
List payers
get
Fetch payer by ID
get
Delete payer by ID
del
Pix Charge
Create Pix Charge
post
List Pix Charges
get
Fetch Pix Charge by ID
get
Pix Transfer
Transfers
Create Transfer
post
Reverse Transfer
put
List Transfers
get
Get Transfer by ID
get
Get QR Code
get
Return Transfer
Balance and Statement
Balance
Balance summary
get
Statement
Transaction statement
get
Statement details
get
ECS - Statement and Transfer
ECS Statement
List establishment transactions
get
Transaction details
get
ECS Transfer
List establishment transfers
get
Transfer details
get
Transparent Checkout
Initial configuration of Transparent Checkout
Checkout and Payments
Create Payment
post
Payment via boleto
Payment via credit card
Error Codes – Credit Card
Payment via PIX
Saved Card
Order and Payment Status
Resend Payment
put
List Payments
get
Search Payment by ID
get
Capture or Cancel Order
post
Cancel Payment
del
Payment Link
Endpoints
Generate payment link
post
List payment links
get
Search payment link by hash_id
get
Cancel payment link
put
Notifications and Events
Webhook
Register webhook
post
List webhooks
get
Delete webhook
del
Webhook Return
Return - accreditation-seller
Return - payment-link
Return - invoice-pix
Return - pix-tranfer
Powered by
Access Key Return
Ask AI
