Jump to Content

Portuguese (BR)

Docs API Reference Changelog

v1.0

Portuguese (BR)API Status Support

API Reference

API Status Support

v1.0Docs API Reference Changelog

API Architecture

Environments and API Architecture
Resource List
Postman

sandbox

How to use the Sandbox
Credit card in sandbox
Debit card in sandbox
Other payment methods in sandbox
Renova fácil in sandbox
Consulta BIN in sandbox

Consulta BIN

Consulta BINget

Zero Auth

Validate card with Zero Authpost
Validate tokenized card
Validate e-wallet cardpost

VELOCITY

Prevent frauds with Velocity

Credit Card

Create a credit card paymentpost
Capture credit transaction after authorizationput
Void a credit transaction via PaymentIdput
Void a credit transaction via MerchantOrderIdput
Cancellation return codes
Card on file

Debit Card

Create a debit card paymentpost
Void a debit transaction via PaymentIdput
Void a debit transaction via MerchantOrderIdput
Cancellation return codes
Card on file

Pix

Create a payment with Pix QR Code.post
Request a Pix refundput
Error messages and codes - Pix

Boleto

Create a boleto paymentpost

E-wallets

Create an e-wallet payment using an encrypted cardpost
Create an e-wallet payment using a decrypted card

Click to Pay

Create a payment with Click to Paypost

QRCODE

Generating a QR Code via APIpost

Carnê

Create carnê transactionpost

Get payment details

Get payment details by PaymentIdget
Get payment details by TIdget
Get payment details by MerchantOrderIdget
Get recurrent payment detailsget

Conversor de moedas e-commerce

Create payment with currency conversionpost
Confirm the currency conversionput
Currencies available for conversion

Card Tokenization

Create card token before authorizationpost
Create payment using a card tokenpost
Create a card token during authorization
Create payment with brand token via external integration

Recurrence

Modify recurrent payment data
Deactivate recurrent paymentput
Reactivate recurrent paymentput

Payment with fraud analysis - Clearsale

Implementing ClearSale fraud analysispost

Payment with Fraud Analysis - Cybersource

Implementing Cybersource fraud analysispost

NOTIFICATION POST

Webhook

SPECIFIC IMPLEMENTATIONS

Cash In transactions
SDWO transactions
CBPS transactions
Quasi Cash
Payment Facilitators

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 Program
ABECS Codes

API Architecture

Environments and API Architecture
Resource List
Postman

sandbox

How to use the Sandbox
Credit card in sandbox
Debit card in sandbox
Other payment methods in sandbox
Renova fácil in sandbox
Consulta BIN in sandbox

Consulta BIN

Consulta BINget

Zero Auth

Validate card with Zero Authpost
Validate tokenized card
Validate e-wallet cardpost

VELOCITY

Prevent frauds with Velocity

Credit Card

Create a credit card paymentpost
Capture credit transaction after authorizationput
Void a credit transaction via PaymentIdput
Void a credit transaction via MerchantOrderIdput
Cancellation return codes
Card on file

Debit Card

Create a debit card paymentpost
Void a debit transaction via PaymentIdput
Void a debit transaction via MerchantOrderIdput
Cancellation return codes
Card on file

Pix

Create a payment with Pix QR Code.post
Request a Pix refundput
Error messages and codes - Pix

Boleto

Create a boleto paymentpost

E-wallets

Create an e-wallet payment using an encrypted cardpost
Create an e-wallet payment using a decrypted card

Click to Pay

Create a payment with Click to Paypost

QRCODE

Generating a QR Code via APIpost

Carnê

Create carnê transactionpost

Get payment details

Get payment details by PaymentIdget
Get payment details by TIdget
Get payment details by MerchantOrderIdget
Get recurrent payment detailsget

Conversor de moedas e-commerce

Create payment with currency conversionpost
Confirm the currency conversionput
Currencies available for conversion

Card Tokenization

Create card token before authorizationpost
Create payment using a card tokenpost
Create a card token during authorization
Create payment with brand token via external integration

Recurrence

Modify recurrent payment data
Deactivate recurrent paymentput
Reactivate recurrent paymentput

Payment with fraud analysis - Clearsale

Implementing ClearSale fraud analysispost

Payment with Fraud Analysis - Cybersource

Implementing Cybersource fraud analysispost

NOTIFICATION POST

Webhook

SPECIFIC IMPLEMENTATIONS

Cash In transactions
SDWO transactions
CBPS transactions
Quasi Cash
Payment Facilitators

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 Program
ABECS Codes

Recurrence status list

Possible recurrence statuses

Código	Descrição
1	Active
2	Finished
3	DisabledByMerchant
4	DisabledMaxAttempts
5	DisabledExpiredCreditCard

Trabalhe conosco

Portal de Desenvolvedores

Central de Ajuda

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030

Copyright © 2024 Cielo S.A. – Instituição de Pagamento. Todos os direitos reservados.

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030

Nos acompanhe: