Jump to Content
Portuguese (BR)
Docs
API Reference
Changelog
v1.0
Portuguese (BR)
API Status
Support
API Reference
API Status
Support
v1.0
Docs
API Reference
Changelog
Webhook
All
Pages
Start typing to search…
JUMP TO
API Architecture
Environments and API Architecture
Resource List
Authentication and credential management
Revoke and create API keys on the Cielo website
Get the 3DS credentials
Get credentials for Silent Order Post
sandbox
How to use the Sandbox
Test the API for free
Credit card in sandbox
Debit card in sandbox
Other payment methods in sandbox
Renova fácil in sandbox
Consulta BIN in sandbox
Postman
Download and register
Explaining Postman Components
Making a request
Collections and Environments Cielo
Consulta BIN
Consulta BIN
get
Zero Auth
Validate card with Zero Auth
post
Validate tokenized card
Validate e-wallet card
post
VELOCITY
Prevent frauds with Velocity
Credit Card
Create a credit card payment
post
Visa Intelligent Data Exchange (IDX)
Capture credit transaction after authorization
put
Void a credit transaction via PaymentId
put
Void a credit transaction via MerchantOrderId
put
Cancellation return codes
Card on file
First use of the stored card
Card already stored
Recurrence
Unscheduled recurrence
Recurrence installments
Credit card transaction status list
Debit Card
Create a debit card payment
post
Void a debit transaction via PaymentId
put
Void a debit transaction via MerchantOrderId
put
Cancellation return codes
Card on file
First use of the stored card
Debit card transaction status list
Pix
Create a payment with Pix QR Code
post
Request a Pix refund
put
Error messages and codes - Pix
Pix transaction status list
PIX - NEW INTEGRATION
Updates on Pix fields
Create a Pix QR Code
Remove a Pix QR Code
Get details on a Pix transaction
Request a Pix refund
Boleto
Create a boleto payment
post
Boleto transaction status list
E-wallets
Create an e-wallet payment using an encrypted card
post
Create an e-wallet payment using a decrypted card
E-wallet transaction status list
Multi-benefit card
Multi-benefit card
Create payment with multi-benefit card
post
Voucher
Create voucher payment
post
QRCODE
Generating a QR Code via API
post
Click to Pay
Create a payment with Click to Pay
post
Carnê
Create carnê transaction
post
Get payment details
Get payment details by PaymentId
get
Get payment details by TId
get
Get payment details by MerchantOrderId
get
Get recurrent payment details
get
Conversor de moedas e-commerce
Create payment with currency conversion
post
Confirm the currency conversion
put
Currencies available for conversion
Card Tokenization
Create card token before authorization
post
Create payment using a card token
post
Create a card token during authorization
Create payment with network token via external integration
Recurrence
Create recurring payments
Create a recurrent payment
post
Create a scheduled recurrence
Create recurring payment with tokenized card
Create a merchant recurrence
Schedule value adjustment in the scheduled recurrence
Schedule value adjustment in the scheduled recurrence
post
Modify value adjustment of a scheduled recurrence
put
Delete value adjustment of scheduled recurrence
del
Modify recurrent payment data
Modify shopper's data
put
Modify recurrent payment data
put
Modify recurrent payment amount
put
Modify recurrent payment day
put
Modify next recurrent payment date
put
Modify recurrent payment interval
put
Modify recurrent payment end date
put
Deactivate recurrent payment
put
Reactivate recurrent payment
put
Payment with fraud analysis - Clearsale
Implementing ClearSale fraud analysis
post
Payment with Fraud Analysis - Cybersource
Implementing Cybersource fraud analysis
post
NOTIFICATION POST
Webhook
Payment facilitators: SDWO, subacquirers and marketplaces
Subacquirers and marketplaces
SDWO
SDWO for fund transfer arrangement
Me2Me - transfer to the same holder
P2P - transfer to another holder
Transfer to another arrangement
Unidentified boleto
Identified boleto
Toll
MCC performance program for individual registrations
SPECIFIC IMPLEMENTATIONS
Quasi Cash
API codes and returns
About API codes
HTTP Codes
Transactional status
Recurrence status list
Antifraude status list
Cancellation Return Codes
API Errors
Card Brands Retry Programs
ABECS Codes
Webhook
Receive transaction status change notifications via API
