Jump to Content

Docs Recipes API Rest

Docs API Rest Recipes Tutorials Help Log In

Docs

Docs API Rest Recipes Tutorials Help Log In

Docs Recipes API Rest

LATAM

Welcome
- Introduction
- Get Started
Boarding System
e-Commerce
Payments: Card Present
Processing
- Batch Settlement
- FX Solution (DCC)
News
Help

Online Payment - API REST

Glossary
Payments
Payments - V1 Double Request
Payments - V2 Single Request
- Perform Payment
Pre-Authorization
Pre-Authorization - V1 Double Request
Pre-Authorization - V2 Single Request
- Create Pre-Authorization
Tokenization
Schedule
Schedule Edit
Recharge
Cancel
Cancel - V1 Double Request
Cancel - V2 Single Request
- Refund
- Asynchronous Refund
Queries - V1 Double Request
Queries - V2 Single Request
- Query by order_id
- Query
Generic Operations
- Authenticity Token Creation
- Generic Operation Effectuation
Idempotence

Online Payment - Web Checkout

JavaScript Store
JavaScript Payment
Checkout Web

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
Recurrence Schedules
User Administration
Transaction Cancellation
Reports
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
3DS 2.0 Checkout Transparent JavaScript
3DS 2.0 Checkout Fiserv

Online Payment - Acquirers Connections

E-Commerce
Sitef Route

Online Payment - Payment Methods

PIX - Boletos
- Citibank
PIX - Digital Wallets
Vouchers
Emergency Assistance
Authorizers
PIX
- Payment

Online Payment - Anti-Fraud Integrations

Overview
Risk Analysis Response
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

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
Change History
Available Routines
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
Supported Platforms
Introduction
Control Files
Message translation

SiTef - LePinblockdirecto

Comments
Goal
Master Keys Installed on the Pinpad
Execution Flow
CNPJ Configuration
Target Audience
History and Version Control
Password Collection From Proprietary Cards
Introduction
Return codes

SiTef - Client Interface Manual

Description of Fields
Communication Message Layout
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
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
Presentation
Sending Trace Files to the SiTef Server
Enabling\Disabling Payment Methods
Loading Tables on PinPad
Continuation of the Iterative Collection Process
Supported Platforms
Enabling Credit in Installments when in a Linked Payment
Introduction
Control Files
Sending Pending Messages
Pinpad Configuration
Library Configuration
Development\Approval Process
- Additional Trace File During the Development Phase
- Approval Process

CliSiTef - Interface com Aplicacao

Payment Method Digital Wallet
New Command Codes
Target Audience
Change History
Goals
Discount Value Treatment
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
Particularities of a Fuel Card Sale
Pix Additional Fields
Request to Pix Payer
Product Information List
Digital Wallet Top-Up Transaction
Digital Wallet Balance Inquiry Transaction
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
Digital Wallet Withdrawal Transaction
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
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
Goal
Target Audience
Change History
Reading Open Fields on the Pinpad in a New Way
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
Goal
Change History

Browser POS-SiTef

POS-SiTef Browser

Smart Terminal

Integracao com CliSiTef - Android - Programming Interface
TLS Restriction with Private APN
Integracao com CliSiTef - Android
Integracao com CliSiTef - Android - Goals
Integracao com CliSiTef - Android - Integration with APOS Terminals
Integracao com CliSiTef - Android - Statistics
Integracao com CliSiTef - Android - CliSiTef Configuration of External Pinpad Access
Integracao com CliSiTef - Android - CLSIT Configuration File
- Trace
- Write Restriction on Android 10 and Later
Integracao com CliSiTef - Android - TLS (Transport Layer Security)
Integracao com CliSiTef - Android - Inclusion in the Project
- Minimum Android Version
POS-Sitef Android
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
Query Web Service
Code Table

PIX - Boletos

Supported Boletos

Carat is integrated with the following Boletos:

Citibank

Updated 15 days ago

Table of Contents
- Supported Boletos