Jump to Content
Docs
Recipes
API Rest
v1.0.0
v3.0.0
Docs
API Rest
Recipes
Tutorials
Help
Log In
Docs
Docs
API Rest
Recipes
Tutorials
Help
Log In
Moon (Dark Mode)
Sun (Light Mode)
Active
Docs
Recipes
API Rest
Web Checkout
Search
LATAM
Welcome
Introduction
Get Started
News
Help
Boarding System
API Integration
Environments
Get Started
Payments: Card Present
Logistics
FDGO
Sales App for Clover (Sitef)
PinPad
Clover
Processing
FX Solution (DCC)
Batch Settlement
e-Commerce
Virtual Terminal (legacy)
API REST
Plugins
Web Checkout
SOAP API
Features
Online Payment - API REST
Glossary
Payments
Payments - V1 Double Request
Quick Start
Transaction Creation
Payment Effectuation
Payment Effectuation with two Cards
Payment Confirmation
Payment Confirmation with two Cards
Payment Confirmation for External Origin
Payments - V2 Single Request
Perform Payment
Pre-Authorization
Pre-Authorization - V1 Double Request
Quick start
Pre-Authorization Creation
Pre-Authorization Effectuation
Pre-Authorization Editing
Pre-Authorization Editing for External Origin
Pre-Authorization Increment
Pre-Authorization Capture
Pre-Authorization Capture for External Origin
Pre-Authorization - V2 Single Request
Create Pre-Authorization
Tokenization
Card Storage
Activation and Deactivation of Card Token
List of Tokenized Cards
Schedule
Quick Start
Create Scheduled Transaction
Activate Schedule
Execution of the Scheduled Payments
Schedule Edit
Quick Start
Schedule Editing Creation
Confirm Schedule Edition
Recharge
Quick Start
Recharge Creation
List Dealers
List Branch Data
Recharge Effectuation
Recharge Confirmation
Cancel
Cancel - V1 Double Request
Quick Start
Cancel Via Host
Create Canceallation
Cancel Effectuation
Cancel External Origin
Cancel - V2 Single Request
Asynchronous Refund
Refund
Queries - V1 Double Request
Pre-Authorization Status Query
Recharge Query
Card Query
Card Query (Pre-Authorization)
Transaction Status Query
Queries - V2 Single Request
Query by order_id
Query
Generic Operations
Generic Operation Effectuation
Authenticity Token Creation
Idempotence
Capture
Cancellation
Payment
Pre-Authorization
Online Payment - Web Checkout
JavaScript Store
Virtual Store's Page
Transaction Creation Service
Quick Start
JavaScript Payment
pagamento-js-quickstart
Transaction Query Service
Transaction Creation Service
Virtual Store's Payment Page
Checkout Web
Create Pre-Authorization Service
Payment with Card Storage Service
Create Transaction Service
Payment with Multiple Payment Methods
3DS 2.0 Activation
Quick Start
Create Recharge Service
Transaction Query Service
Multiple Transaction Payment
Pages Customization Service
Online Payment - Payment Link
Overview
Payment Link Through Portal
Payment Link Via API
Online Payment - Notifications
Overview
REST payment
Pix
Payment
WebCheckout
Online Payment - Automatic Retries
Retry Service
Flow
Quick Start
Allowed Return Codes
Online Payment - Return Codes
Transaction Status
Schedule Status
Storage Status
Response Codes
Online Payment - Merchant Web Page
Overview
Configuration for digital wallets
Web page POS
Payment Via Virtual POS
POS Transaction Report
Virtual POS Configuration
Recurrence Schedules
User Administration
Transaction Cancellation
Reports
Analytical Report
Transaction Report
Daily Summary Report
Storage Report
Recharges Report
Two-Step Authentication
Configure Authorizer Ordering
User Settings
Web page POS recharge
Recharge Via Virtual POS
Access to Web Portal
Risk Analysis Configuration
Configure Authorizers
Online Payment - 3D Secure 2.0
Overview
3DS 2.0 API Transparent Checkout
Decoupled Notification
Data Only - Mastercard and Visa
Transaction Query Service
Authentication Result
Initiating a 3DS Method
Authentication Service
How to Test the 3DS API
3D Secure Glossary
Challenge
Quick Start
Transaction Creation Service
3DS 2.0 Checkout Transparent JavaScript
Authorize the Payment with Authentication
Customization of the threeds.css File
Quick Start
Online Merchant Payment Page with 3DS Authentication
Transaction Query Service
Start ThreeDS
Transaction Creation Service
3DS 2.0 Checkout Fiserv
Begin Transaction
Customizations
Mastercard 3DS Identity Check Insights (Dataonly)
Online Payment - Acquirers Connections
E-Commerce
Stone
Getnet
E.Rede
Fepas HUB
Cielo
EPX
SafraPay
IPG
Ticket
GlobalPayments
Sitef Route
Cetelem
Others
Orbitall
Sipag
Bin
GetnetLac
Bradescard
Online Payment - Payment Methods
PIX - Boletos
Citibank
PIX - Digital Wallets
Samsung Pay
Apple Pay
Mercado Pago
Masterpass
Visa Checkout
AME
VEE Via CardSE
PayPal
Google Pay
Vouchers
Emergency Assistance
Authorizers
PIX
Online Payment - Anti-Fraud Integrations
Risk Analysis Response
Overview
Antifraud Fiserv
Konduto
CyberSource
ClearSale
Fraud Notification Service
Manual Review Flow
Risk analysis Service on the HTML Interface
Online Payment - Store Management
Registration Via BATCH
Batch Routing Configuration
Batch Store Registration
Registration Via REST API
Merchant Editing Service
Token Creation Service
REST Merchants Registration
Merchant Status Query Service
Quick Start
Merchant Creation Service
List Merchants Service
Merchant Query Service
Online Payment - General Information
Soft Descriptor
Signature Authentication
Digital Certificates
Online Payment - Facilitador de Pagamentos
Overview
SiTef - Simplified Interface with the Application
Funcionamento Basico
Tables
Flag code
Authorizing Network Code
Flag Code
Authorizing Network Code
Change History
Available Routines
Banking Correspondent (Bill Payment)
Standard Interface
Library Configuration
Checking the Integrity of a Bar Code
ASCII Interface
PinPad Functions
Getting Version
Loading Tables on PinPad
Querying Transactions Pending Confirmation on the Terminal
Sending Pending Messages
API - Routines Available on CliSiTef
Payment Confirmation or not
Start of Payment or Management Transaction
Continuation of the Iterative Collection Process
Pinpad Information
Developmentapproval process
Additional Trace File During the Development Phase
Approval Process
Publico Alvo
Discontinued Routines
Goals
Trace
Submitting Trace Files To Sitef Server
Terminal Trace Files
Directory Configuration
Enabling the Rotating Trace
Revolving Trace
Presentation
Basic Operation
Limiting the Size of the Files
Configuring History
Settings File
PinPad Configuration
CLISITEF or CLSIT Settings File
Enabling Special Settings per Transaction
Connection Mandatory
Additional Transactions Qualification
Specific Network Transactions Qualification
Defining Default Values for Payment Methods
Credit\debit Transactions with Card Without Bin
Setting up a Second PinPad
Enabling Value Confirmation on the Pinpad
Configuration When not Using Pinpad
Communication Display Configuration
Qualifying Disabled Payment Forms
Restricting Payment Methods at Execution Time
Configuring Additional IP Addresses
Disabling Transactions
Changing Timing Parameters (Timeout)
Payment Codes Table, Settings and Menus
Passing Value of the Purchase of the Transaction at Clisitef
Setting the Default Message
Sitef Server Port Configuration
Maintaining Active Connection
Enabling Credit in Installments in Linked Payment
Supported Platforms
Introduction
Control Files
Message translation
SiTef - LePinblockdirecto
Comments
Goal
Master Keys Installed on the Pinpad
ObtemMKSEInterativo Function
ObtemMKSEDireto Function
Modality 424
Execution Flow
CNPJ Configuration
Target Audience
History and Version Control
Password Collection From Proprietary Cards
Off-Line On-Line Operating Mode
Modality
Using 6-Digit Card Identification - (BIN)
Introduction
Return codes
SiTef - Client Interface Manual
Description of Fields
Value Referring to the Establishment
Control of Enabled EMS Transactions
Type of Each Product\Type of Packaging
Item Indicator Sold
Withdrawal
Branch Name
Special Treatment Indicator Performed
Customer Phone
Boarding Date
Data Entry Form
Entry Check Amount
Product Quantity
Control for Continued Payment
Allows Additional Data on the Transaction
Number of First - Way Line Lines of the Coupon
POS Date - Receipt
Customer Code
Type of Data Input
Scope for Generic Query
CMC-7
Timestamp of the Host Transaction
ECF Store Number
Type of Entry for Consultation
Quantidade Devolvida
Document's Value
Customer CPF
Automation TLV Data
Value of Miles \ Value of Fine \ Value (R$) of Accumulated Points
Product Science Term
Card Bin
Miles Consultation Response
QUANTITY OF AUTHORIZED MEDICINES
Sub-Adquering Information
Number of Free Field Lines
Document Name Card Trail
Form of Payment
Number of Proof Lines
Discount Type
Identifier
Service-z
Transaction Type
Authorized Value with Discount
Checking Account
Bar Code Error Message
Number of Days that the Coupon for Reprinting the Customer\Establishment Copy will be Available
Driver's Registration Number
Quantities of Portions of the Transaction
Product's Name
Agency
Product Capture
CDC Sell Type
Maximum Value
Transfer Value
Complementary Product Data
Document Number
Commercial Phone
Type of Sale Made with Card
Insurance Fee Amount
CCS Card Number or your TRACK2
Check Number
IDENTIFICATION
Benefit Type
Value to be Funded Credit
Finalization
Trailer-Registration
Point Balance
Treats CPF Collection on Pinpad
Value of Each Portion of the Transaction
Value of the Addition
Additional Data
Type of Consultation
Fee Value for Prepaid Recharge Via Banking Correspondent
Car Mileage
Tax Coupon Time
Coin
LINKED TAX DOCUMENT
Discount Plan Code
QRcode
Read Card Type
Initial Date
Current Account C2
Establishment Code
Tax Coupon Issue Date
License Plate
Odometer
Factory Value
Address (Street, Number, Complement)
Transaction Time - Proof
Special Operator Text
Approved Value
Available Value
The Free Field
Exit Shape(Display) of Data
Payment Split Input Data
Cardboard
Shipping Rate Value
Input Check Number
Accumulated Points
Quantity of Credit Installments
Password\Token Collection Timeout
Total Amount Paid by the Product
ECF Cashier Number
Establishment Code
Rebate Value
Balance Available
Discount Transaction Value
Number of Rescued or Transferred Points
Document Number Entry Mode
Identification Card No
Example
Pharmacy Replacement Value\Net Price
Transaction Authorization Code
Number of Days
CCS Contract Number
Occurrence ID
Multiple Return
Installment Type Indicator
Authentication
Kind of Person
Query Code to be Made\Payment Code
CCS Contract Number Number
Canceled Transaction Number
Pre-Authorization Change Treatment Indicator
Miles Accumulation Indicator
Transaction Number - NSU of the Sitef
Operator Code
Dados da Finish CHIP
Name of the Concessionaire
CNPJ of the Agreement
Bank
JGV Transaction Subfunction
Barcode Value
Transaction Date - Proof
Telephone
RECNR Monitor or AUTHORIZATION CODE \ VOUCHER VALIDATION \ Extended
Account Opening Date
Form of Payment
Sending Sub-Acquiring Information Enabled
Drug Code\Product Code EAN
Due Date
Concessionaire Code
Branch Code
Timestamp of the Canceled Transaction - Host
Transaction Status
CNPJ Number of the NFC-E Debit\Credit Card Acquirer
Flag code
Service Rate Value
Branch UF
Number of Checks for Consultation
HEADER
Total INFORCARD Transaction Value
Unit Value of Each Product
Product Belongs to the Customer
PDV number
Store Number
Product Code
Card Issuance Date
Agreement Subsidy Amount
Qualified Transactions Control
Fiscal Coupon Number
Network Code
Date of Each Transaction Installment
Administrator Code
Payment Methods Card Bin
Host Transaction Number (Sitef NSU) of Payment Methods
Customer Code
Image of Each Line of the Receipt
Payment Method Authorization Code
Access Key
Compensation
Due Date of the Transfer to be Collected by the Bank Correspondent\Accounting Date
Payment Methods Authorizing Network Code
Code of Establishment of Payment Methods
Alphanumeric Response Code
Liters of Fuel
Card Type
Acquisition Value
Establishment Code R3 (BR PREMMIA)
Mapping Version
PLAN CODE \ REVENUE CODE \ TABLE CODE \ PRODUCT CODE VOUCHER
Conferente's Registration
PAYMENT DATE OF THE 1ST INSTALLMENT \ COMPETENCE
Total Value
Sending Free Information
Access Key for the Issued Tax Document
Pre-Authorization Expiration
Packaging Code for Each Product
Check Date
Authorizing Network Code
Sitef has Coupon Reprint Via Client
Value of Payments Made
Complementary Data
Payment Output Data
Operator Registration Number
Selling Value The Pharmacy\Value Receivable from the store
Name of Software House and Version of Commercial Automation
Transaction Number - NSU
Data Information to be Captured in the Pinpad
Extended Warranty
Start Date Consultation Period \ Calculation Period
Client Name
Percentage Interest Rate \ Interest Amount
Host Transaction Number (Host NSU) of Payment Methods
Pharmacy\Gross Price Refund Value
Type of Sale Normal or Forced
Input Value \ Inss Value
Type of Fiscal Document Issued
Partial Cancellation Value
Code Occurrence \ Reference Number
CCS Transaction Subfunction
Operator Code
Cash Value \ Gross Revenue Value
Authorizer Registration Number
Indicative of the Existence of a Prescription
Maximum amount of payment methods
Product Name of Payment Forms
NFC-E Authorization Number
ECF Serial Number
Extended Response Code
RG
Final Date
Sitef has Coupon for Reprinting the Establishment
Other Document Number
Date of VIC
POS Number that Made Sale
Clipping Mark
Free Consultation Modality
Seller Registration Number
Additional Data Payment Invoice
Special Treatment Indicator
Status of Each Product
Selling Item Code
Purchased Quantity of Each Product
Consultation Indicators
Number of Cycles to Jump
TEF Destination Network
Data Captured in Pinpad
identifiers-and-fields-of-payment-forms
Control of Enabled PHARMACY Transactions
Value of the Transfer to be Collected by the Bank Correspondent
Value Other Entities
Discount
Number of Returned Products
Product Allows
CPF or CNPJ
Residential branch
Contract Verifier Digit (DV)
Establishment Code
Proprietary Transaction Type
Installment Value
Number of Products Sold
Continuation Indicator
Scope of Cancellation
Does not Use Full Value Field
Type of Entry for Generic Authorization
Generic Consultation Modality
Pharmacy Authorization Code
Product Payment Form
Type of Opinion
Communication Message Layout
Request File From the TEF Requesting Terminal for ClienteSitef
Request and Response File From the TEF Requesting Terminal for ClienteSitef
SiTef Client Response File
Update History
Technical Information
Information on Terminal Number Configuration
Example of a Credit Card Sale
Presentation
CliSiTef - Reference Manual
API - Rotinas Disponiveis na CliSiTef
Goal
Banking Correspondent (Bill Payment)
Discontinued Routines
Start of Payment or Management Transaction
Return Code Table
Function Code Table
Additional Parameters
Pinpad Information
Checking the Integrity of a Bar Code
Change history
Enabling Special Settings per Transaction
Tables
Enabling Transactions from Specific Networks
Publico Alvo
Payment Confirmation or Not
PinPad Functions
Consultation of Outstanding Confirmation Transactions at the Terminal
Credit\Debit Card Transactions Without BIN
Trace
CliSiTef.ini or CLSIT Settings File
Directory Configuration
Revolving Trace
Enabling the Rotary Trace
Trace Files per Terminal
Limiting the Size of the Files
Configuring History
How to Pass a New Transaction Purchase Amount on CliSiTef
Getting Version
Connection Configuration with the SiTef Server
Compulsory Connection
Additional IP Address Configuration
Communication Display Configuration
Maintaining Active Connection
Changing Timetic Parameters (Timeout)
Sitef Server Door Configuration
Presentation
Sending Trace Files to the SiTef Server
Enabling\Disabling Payment Methods
Restricting Payment Methods at Execution Time
Defining Default Values for Payment Methods
Disabling Transactions
Enabling Additional Transactions
Loading Tables on PinPad
Continuation of the Iterative Collection Process
Command Code Table
Event Table, Also Returned in TypeField
Table of Values for FieldType
Supported Platforms
Enabling Credit in Installments when in a Linked Payment
Introduction
Control Files
Sending Pending Messages
Pinpad Configuration
Default Message Definition
Enabling Confirmation of Value in Pinpad
Port Configuration
Configuration of a Second Pinpad
Configuration when Automation does not Use Pinpad
Library Configuration
Floating Point
General Special Settings
Additional Automation\Establishment Information
Development\Approval Process
Additional Trace File During the Development Phase
Approval Process
CliSiTef - Interface com Aplicacao
Payment Method Digital Wallet
Indirect Form
Direct Form
Additional Parameter QrCode Processing
New Command Codes
Target Audience
Change History
Goals
Discount Value Treatment
Sales Transaction that does not Allow Discounts
Transaction Blockade
Changing the Original Sales Value
Field Codes
Digital Wallet ID Table
Rounding in the Calculation of the Discount Granted
Transactional Flow
How the Flow Works
Aborting the Transaction
Introduction
Menu Codes
CliSiTef - Carteiras Digitais
Additional Documentation
Configuration of Available Readers
List of Non-Fleet\Fuel Products
History of Changes
Customizing the Digital Wallets Menu
Default Values Via Configuration File (CliSitef.ini)
Target Audience
Basic Flow of a Digital Wallet Transaction
Payment Transaction Digital Wallet
Data Request on the Operator Screen if There is no Pinpad Configured
Payment Transaction
Additional Parameter - QRcode Handling
Indirect Form
Enabling Payment Method
Additional Parameter - CPF Previously Captured by Automation
Direct Form
Particularities of a Fuel Card Sale
Pix Additional Fields
Request to Pix Payer
Product Information List
Digital Wallet Top-Up Transaction
Indirect Form
Enabling Payment Method
Direct Form
Digital Wallet Balance Inquiry Transaction
Enabling Payment Method
Indirect Form
Direct Form
Goals
Digital Wallet Menu Codes
Field Codes
Field 135 - Extended Authorization Code
Digital Wallet Identification Codes (Type Field 106)
Transactional Flow with Payments Via the Establishment's QRCode
Transactional Flow with Payments Via the Establishment's QRCode
Pix, PixSaque, Pix Troco
Indications to the POS to Display an Abort\Cancel Button on the Screen, While the Merchant's QRCode Transaction with SiTef is in Progress
BrinksPay
Nucash
Vee
How the Flow Works with the Establishment's QR Code
Indication to the POS to Remove an Abort\Cancel Button on the Screen
Rappi
Payment Market
Love Digital
MoneyPag
Pay Face
4All
Midway
Tapago
Cielo (Credit\Debit)
PicPay
IzPay
PagSeguro (Pagbank)
Iti\Itau
Procedure that the POS must Implement in Case of Withdrawal of the Transaction with the Establishment's QRCode
Aborting the Transaction with QRCode if the Customer or Cashier Cancels the Current Transaction
Simple Change
VC +
Digital Wallet Withdrawal Transaction
Indirect Form
Direct Form
Enabling Payment Method
New Command Codes for the Case of Returning the QRCode String for Commercial Automation
Ways of Customer Identification in the Digital Wallet Flow
Enabling\Disabling Digital Wallet Menu Options
At Runtime (Additional Parameter)
Menu Codes
Default Values V ia Configuration File (CliSitef.ini)
Cancellation Pix Change
Introduction
CliSiTef - Cartao Combustivel
Summary of Operations
New Modalities
New Types of Field
Grant of Discounts for a Particular Type of Card
Particularities of a Fuel Card Sale
Exemplo
Introduction
CliSiTef - Informacoes de Sub Adquirencia
Aim
History of Changes
Target Audience
Minimum Version
Introduction
Description
CliSiTef - Campo Aberto no Pinpad
Pinpad Open Fields Reading - Old Way
Example 2 - CliSiTef Divides the CNPJ into 2 Parts
Parameter Description
API - Function Prototype
Example 3 - Birth Month Collection
PIN Pad Support in Abecs Protocol
Recommendations
Examples
Restrictions
"Output" Parameter Format (FieldType 670)
"Input" Parameter Format (FieldType 669)
Goal
Target Audience
Change History
Reading Open Fields on the Pinpad in a New Way
API - Function Prototype
CNPJ Capture (D)
Security Code Capture (C)
Description of Parameters
Functions that do not Require an Opening Key
Reading Digits on the PinPad
Introduction
CliSiTef - Senha Aberta no Pinpad
Target Audience
Introduction
Open Password Reading on Pinpad
SEObtemSenhaClienteDireto
MKSE Library
API - Function Prototype
Return Codes
MKSE Configuration on the SiTef Server
Obtaining the Open Password
SEObtemChaveSeguranca
MKSE Library Installed on SiTef Server
Capture of the Release\Identifier Access Key Without MKSE Library
Obtaining the Security Key
MKSE Library Installed on the POS (Original Model)
MKSE Library Installed at the POS (Model 2)
Call Sequence
MKSE Library Installed on the POS (Original Model)
Goal
Change History
Browser POS-SiTef
POS-SiTef Browser
Smart Terminal
Integracao com CliSiTef - Android - Programming Interface
Class br.com.softwareexpress.sitef.android.CliSiTef
Example of Handling the OnData and onTransactionResult Events
End Identified
Function Equivalence
Available Functions
Accessing CliSiTef in Other Activities (Activity)
TLS Restriction with Private APN
Integracao com CliSiTef - Android
Integracao com CliSiTef - Android - Goals
Integracao com CliSiTef - Android - Integration with APOS Terminals
Manufacturer Libraries
Virtual Pinpad (setActivity Method)
Enabling Accessibility in CliSiTef
Integracao com CliSiTef - Android - Statistics
Integracao com CliSiTef - Android - CliSiTef Configuration of External Pinpad Access
Application Debugging when Using a USB Pinpad
Bluetooth Pinpad Filter Using your MAC Address
Pinpad Events Via Handler
Integracao com CliSiTef - Android - CLSIT Configuration File
Trace
Write Restriction on Android 10 and Later
Integracao com CliSiTef - Android - TLS (Transport Layer Security)
Using TLS from WNB COMNECT
Error Situations
Using GSurf TLS
Architecture
Enabling TLS Communication on CliSiTef
Using TLS from Software Express
Error Codes
Configuring the CA Certificate
Integracao com CliSiTef - Android - Inclusion in the Project
Minimum Android Version
POS-Sitef Android
Reprint
Transaction Cancellation
Installation
Support
Pix Method and Digital Wallet
Chip Method
POS-SiTef - Introduction
Reports
Print Coupon - AGT Flow
POS-SiTef
Contactless Method
Terminal Data
Administrative
Integracao com CliSiTef - Android - Target-Audience
Integracao com CliSiTef - Android - Change History
Finnacial Management and WS API
WS Query - Response Examples
WS Query - Request Responses
Return Errors
Returns of Requests
WS Query - General Information
Code Tables and Descriptions
WS Query - Alterations History
Decription
Return Files Specification
Return File 4.3
Return File 3.6.1
Return File 3.2
Return File 3.0
Return File 3.5
Return File 3.6
Return File 3.4
Return File 3.3
Return File 4.2
Return File 4.0
Return File 4.1
Query Web Service
Transaction Query by Export Date
Reversal Transaction Query
Query by Transaction
Transaction Query by Date
Pending Transaction Confirmation
Inquiry of Reversal Transactions by Date
Quick Start
Pending Transaction Cancellation
Query for Pending Transactions
Transaction Query by BIN
Version Query
Code Table
Web Checkout
Updated about 16 hours ago
English
English
Spanish (Latin America)
