Jump to Content
Portuguese (BR)
Docs
API Reference
Changelog
Portuguese (BR)
API Status
Support
API Reference
API Status
Support
Docs
API Reference
Changelog
API Error Codes
All
Pages
Start typing to search…
JUMP TO
INTEGRATION ARCHITECTURE
About the API
Test and production environments
Resource List
VerifyCard
VerifyCard
VerifyCard by card number
post
VerifyCard by card token
Providers for Verifycard
CREDIT CARD
Create a credit card payment
post
Visa Intelligent Data Exchange (IDX)
Capture a credit card payment
put
Void a credit card payment
put
Providers for credit card
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 card payment
put
Providers for Debit Card
Card on file
First use of the stored card
Debit card transaction status list
PIX
Create a QR code Pix payment
post
Requesting a Pix Refund
put
Providers for Pix
Bradesco Pix codes
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
QR CODE
QR Code Transaction
post
BOLETO
Create a boleto payment
post
Providers for registered boleto
Boleto transaction status list
VOUCHER
Create a voucher payment
post
Providers for voucher
E-wallets
Encrypted card
post
Decrypted card
E-wallet transaction status list
Multi-benefit card
Create payment with multi-benefit card
post
Click to Pay
Create a payment with Click to Pay
post
RECURRENCE
Create recurring payment
post
Schedule 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
Data alteration
Changing customer data
put
Changing recurrence end date
put
Changing recurrence interval
put
Changing recurrence day
put
Changing recurrence transaction amount
put
Changing next payment date
put
Changing recurrence payment data
put
Deactivating a recurring order
put
Reactivating a recurring order
put
Tokenization
Create a CardToken payment
Create a CardToken payment
post
Tokenize a card during authorization
Creating a transaction with Alias
Create payment with network token via external integration
Payment with fraud analysis - ClearSale
Implementing ClearSale fraud analysis
post
PAYMENT WITH FRAUD ANALYSIS - CYBERSOURCE
Implementing Cybersource Fraud Analysis
post
Payment with fraud analysis - ACI
Implementing ACI Worldwide Fraud Analysis
post
QUERIES
Get payment details via PaymentId
get
Get payment details via MerchantOrderId
get
Get recurrent payment details
get
NOTIFICATION POST
Notification Post
Cartão Protegido
Environment
Authentication
Create card token
post
Get token information
get
Get token using alias
get
Delete token
del
Suspend token
put
Unsuspend token
get
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
API Codes
Transaction Status List
Antifraud status list
MerchantDefinedData Table
HTTP Codes
Recurrence Status List
ReasonCode/ReasonMessage List
API Error Codes
Test Cards (Simulado)
Fraud analysis tables
List of values - Payment.FraudAnalysis.Cart.Items[n].GiftCategory
List of values - Payment.FraudAnalysis.Shipping.Method
List of values - Payment.FraudAnalysis.Travel.Passengers [n].Rating
List of Values - Payment.FraudAnalysis.Cart.Items [n].Type
List of Values - Payment.FraudAnalysis.Travel.JourneyType
Value List - Payment.FraudAnalysis.Travel.Passengers [n].Status
API Error Codes
Possible API error codes and their descriptions
