Jump to Content
API Reference
v1.0
v3.0
Log In
API Reference
Log In
v1.0
API Reference
Devices
JUMP TO
BaaS
BaaS - Banking as a Service
Authentication
Authentication
post
Accounts
PF
Create Partner Client PF
post
Update Partner Client PF
put
Retrieve Partner Client PF
get
Retrieve Partner Client PF by Partner Code
get
Retrieve Partner Client PF by Document
get
PJ
Create Partner Client Company
post
Create Partner Client Company with PJ Representative
post
Create Partner Client Company with PF Representative
post
Update Partner Client Company
put
Update Partner Client Company with PJ Representative
put
Update Partner Client Company with PF Representative
put
Retrieve Partner Client PJ
get
Retrieve Partner Client PJ by Client Code
get
Retrieve Partner Client PJ by document
get
Biometry
Retrieve All Biometrics
get
Retrieve Biometry Details
get
Retrieve Biometry Limits
get
Create Biometry
post
Create Biometry Transactions
post
Representatives
Create Representative PF From Representative
post
Create Representative PJ From Representative
post
Create Partner Client Representative PJ
post
Create Partner Client Representative PF
post
Update Partner Client Representative PJ
put
Update Partner Client Representative PF
put
Retrieve Partner Client Representative
get
Retrieve Partner Client Representative by Code
get
Retrieve Partner Client Representative by document
get
Signature Contract
Create Account Consent
post
Create Account Consent by Representative
post
Create Signature Contract
post
Resend Signature Contract
post
Retrieve Signature Contract
get
Devices
Solicitation Device
post
Retrieve Solicitations Devices
get
Request Device
post
Confirm Device
post
Retrieve Request Device
get
Block Device
patch
Unblock Device
patch
Delete Device
del
Retrieve Devices
get
Retrieve Balance
get
Retrieve Balance By Bank Account
get
Retrieve Account
get
Retrieve Accounts Balance Closure By Competence
get
Retrieve Income Report
get
Documents
PF
Send documents base64 PF
post
Send documents by link PF
post
Update document base64 PF
put
Update document link PF
put
Retrieve Documents Client Partner PF
get
Retrieve Documents Client by Image Code
get
PJ
Send documents base64 PJ
post
Send document by link PJ
post
Update documents base64 PJ
put
Update documents by link PJ
put
Retrieve Documents Client Partner PJ by client pj code
get
Retrieve Documents Client PJ by Image Code
get
Representatives
Representative send documents by base64
post
Representative send document by link
post
Representatives update documents base64
put
Representatives update documents by link
put
Retrieve Documents Representative by Representative Code
get
Retrieve Documents Representative by Image Code
get
Transactions
Boleto
Boleto Payment
Authorized Covenants
Create Payment Boleto
post
Payment Boleto
post
Request Deposit Charge Boleto
post
Create Deposit Charge Boleto
post
Create Deposit Charge Boleto Pix
post
Create Deposit Boleto
post
Retrieve Download Boleto
get
Retrieve generated boleto
get
Retrieve Detailed generated boleto
get
Cancel Boleto
put
TED
Request Ted
post
Payment Ted
post
Request Ted Batches
post
Retrieve Ted Batches
get
Retrieve Ted Batches Details
get
Retrieve Ted Batches Details by Ted Batch Item
get
P2P
Request P2P
post
Payment P2P
post
Request P2P Batch Payment
post
Retrieve Banks List
get
Digital Services - Mobile Top Up
Retrieve Providers Digital Services
get
Retrieve Digital Service Products
get
Digital Services Payment Request
post
Digital Services Payment
post
Extract
Retrieve Detailed Card Extract
get
Retrieve Detailed Card SLC Extract
get
Retrieve Card Extract
get
Retrieve Extract V2
get
Retrieve Extract V2 by bank account
get
Detailed P2P Extract
get
Detailed TED Extract
get
Detailed BOLETO Extract
get
Detailed Pix Extract
get
Detailed Mobile Top Up Extract
get
Cards
Card User
Create Card User
post
Update Card User
put
Retrieve Card User
get
Card Payment
Create Card Payment
post
Retrieve Card Payment
get
Create Card
post
Vinculate Card
post
Change Status Card
put
Change Password Card
put
Retrieve Cards
get
Retrieve Cards By Card Code
get
Retrieve Cards by Client Partner
get
Retrieve Cards By Bank Account
get
Change Contactless Card
put
Benefits
Products
Vinculate Products
post
Create Product
post
Update Product
put
Retrieve Products
get
Retrieve Segments
get
Retrieve Balance Card Product
get
Balance Card Product Bank Account
Credit Balance Card Product
post
Debit Balance Card Product
post
Order
Benefits Product Recharge Order
post
Retrieve Benefits Recharge Order
get
Pix
Transaction Qr Code
Request Payment
post
Confirm Payment Qr Code
post
Transaction by Dynamic QR Code
Request Payment
post
Confirm Payment
post
Transaction by Dynamic Cobv QR Code
Request Payment
post
Confirm Payment
post
Transaction by Static QR Code
Request Payment
post
Confirm Payment
post
Transaction by Key
Request Payment
post
Confirm Payment
post
Manual Transaction
Request Payment
post
Confirm Payment
post
DICT
Create DICT
post
Retrieve DICT
get
Retrieve DICT By Bank Account
get
Delete DICT
del
Claim DICT
post
Confirm Claim DICT
post
Cancel Claim DICT
post
Retrieve Claim DICT
get
QR Code
Generate Static QrCode
post
Generate Dynamic QrCode
post
Generate Dynamic Cobv QrCode
post
Decode QrCode
post
Limit
Change limit
post
Retrieve Limit
get
Retrieve Solicitation Limit By Bank Account
get
Retrieve All Limit Solicitations
get
Retrieve Limit With Bank Account
get
Scheduling
Cancel Scheduling
del
Retrieve Scheduling
get
Retrieve Scheduling By Bank account
get
Retrieve Scheduling By Pix Scheduling Code
get
Secure Contacts
Create Secure Contact
post
Update Secure Contact
put
Delete Secure Contact
del
Retrieve All Secure Contact of Client Partner
get
Webhooks
Create Webhook
post
Update Webhook
put
Retrieve Webhook by code
get
Retrieve All Webhooks
get
Payment Gateway
Card Payment
Card Payment
post
Generate Card Token
post
Initialize Card Payment
post
Confirm Initialized Card Payment
post
Cancel Initialized Card Payment
post
Save Card
post
Retrieve saved card
get
Retrieve Card Payment History
get
Retrieve customer's card payment history
get
Customers
Create Customer
post
Update Customer
put
Remove Customer
del
Retrieve a customer
get
Retrieve all customers
get
CaaS
CaaS - Credit as a Service
Authentication
Autentication
post
Operation
Retrieve all customer operations
get
Retrieve details operation
get
Product
Retrieve
get
Purchaser
Retrieve
get
Suppliers
Retrieve
get
FGTS
Simulator FGTS
post
Retrieve Installments
get
Retrieve Installments Result
get
Affiliates
Simulator Affiliates
post
Rate
Simulator Rate
post
Anticipation
Simulator Installments anticipation
post
Generate operation by a simulation
Generate operation by a simulation
put
IOF Simulator
Rate
post
Installments anticipation
post
FGTS
post
Document
Send
post
Retrive
get
Download
get
Payment
Insert
post
Suppliers Insert
post
Delete
del
Retrieve Info board
get
Thirdparty Insert
post
Digital Signature - Subscriber
Insert subscriber
post
Retrieve subscriber
get
Delete Subscriber
del
Digital Signature - Contract
Preview of the CCB contract
post
Trigger contract for signature
put
Check pending subscriptions
get
Download contract in base64
put
Movement history
Retrieve
get
Update Status Operation
post
Client
PF
Create
post
Update
put
PJ
Create
post
Update
put
Partner
Create
post
Update
put
Account Payment
Create
post
Retrieve
get
Delete
del
Get All Clients
get
Retrieve Client
get
Document
Send
post
Retrive
get
Affiliates
Get Affiliates By Product Hash
get
Assignment
Create
Generate Assignment
post
Operations available for purchase
get
Retrieval
List of recorded assignments
get
Analyze assignment
get
Consult assignment movement history
get
Document
Send Document
post
Retrieve Document
get
Digital Signature - Contract
Preview of the Assignment contract
get
Trigger contract for signature
put
Check pending subscriptions
get
Download contract in base64
put
Update assignment status
post
Delete Assignment
del
Webhook
Create
post
Update
put
Retrieve
get
API Pix CASH-IN
API PIX Cash-in Introduction
Authentication
Authentication
post
Payload locations
Create Payload locations
post
Immediate Charge (Cob)
Create Immediate Charge with txid
put
Retrieve Immediate Charge by id
get
Notification Management
Update Webhook
put
Create Webhook
post
API PIX CASH-OUT
Authentication
Authentication
post
Account
Retrieve Balance
get
Retrieve Extract
get
Retrieve Detailed Transaction
get
Payment
Transaction By Key
Request Payment By Key
post
Confirm Payment By Key
post
Manual Transaction
Request Payment
post
Confirm Payment
post
Refund
Refund transference
post
Retrieve Payment Requests
get
Limits
Retrieve All Limits
get
Webhook
Create Webhook
post
Update Webhook
put
Retrieve Webhook By Code
get
Retrieve All Webhooks
get
BETS
Payin
Generate QR Code Pix
post
GET QR Code Pix Status
get
Mock QR Code Payment
get
Payout
PIX Key
post
Manual
post
GET Transaction Status
get
Refunds
Refund
post
Webhooks
Transactions
Generate Pix Receipt
post
Accounts
GET Balance
get
Auth
Access Token
post
Powered by
Devices
Ask AI
Register your device to make transactions with security
