Introduction

The EDI - Eletronic Data Interchange is a channel of capture and processing of large transactions volume in lot, through changing the files between the client, the files transmission partner (VANs) and Cielo.

This channel is indicated for:

Target Audience

There is no restriction on the use of this Channel. However, the client’s business needs may or not make feasible the use of this capture channel.

As described above, some characteristics are required:

EDI in 4 steps

To use the EDI capture channel, four steps are required:

  1. Accreditation: the client has to be accredited to Cielo;
  2. Integration: to perform the development according to the manual to integrate to the EDI. Note: the development size will depend on the desired integration level with your management systems (ERP, Commercial Automation, etc);
  3. Homologation: A test file can be sent to the EDI Attendance Island for file estructure validation;
  4. Production: send the file for processing.

Technical Support

The EDI capture solution counts on an Attendance Island for support, responsible for:

  1. Support to the integration and homologation by the client;
  2. Support of 1st level on the production stage;
  3. Interface with the internal Cielo areas and with VANs partners (TIVIT and GXS), for support of 2nd and 3rd level.

Products and Card Brands enabled for EDI CHANNEL:

Product/Service Authorization in lot Cancellation in lot Base 2 IATA Submission IATA Cancellation
Debit No Yes No Yes*
Credit in one lump sum Yes Yes Yes Yes
Store installment Yes Yes Yes Yes

Exceptions

Concepts

What is it?

The EDI - Eletronic Data Interchange is a channel of capture and processing of transactions in lot, through changing the files between the client, the files transmission partner (VANs) and Cielo.

What is it for?

How does it work?

General Considerations

Names of the returns from the files:

Formatting tips of the EDI files

Operation Summary (OS)

Identifies the lot number, sales transaction group.

Sale Receipt (SR)

Each sale is registered in a sale receipt.

Files

Files to Remittance and/or Sales Return

Files Layout for Remittance and/or Sales Return

Header Register

SEQUENCE DESCRIPTION POSITION SIZE FORMAT COMMENTS EDI consistencies
001 Type of register 1 2 N Identifies the type of header register Mandatorily equal to “00”
002 Deposit date 3 8 N Data de geração e transmissão do movimento Mandatory field, the format must be DDMMYYYY
003 Operations Summary (OS) number 11 7 N Informed by the establishment, identifies the transactions lot Mandtory Field. Do not send the same lot in a 30 days period of the previous send
004 Reserved for the establishment 18 10 X Exclusive establishment use, not used by CIELO Nenhuma verificação
005 Do not use 28 3 N Constant = Zeros Not read
006 Cielo establishment number 31 10 N Number of the card machine (CIELO contract) Mandatory field. Rejection if N = Numeric / X = Alphanumeric

Detail Register

SEQUENCE DESCRIPTION POSITION SIZE FORMAT COMMENTS EDI consistencies
001 Register type 1 2 N Identifies the type of detail register Only accepted if equal to “01”
002 Number of the sale receipt (SR) 3 7 N It is a sequential number attributed by the establishment, identifies the transaction within the lot. Mandatory Field; It must be numeric; it cannot be duplicated on the lot.
003 Card Number 10 19 N Card number aligned to the right, with zeros to the left. Mandatory Field; It has have from 16 to 19 digits.
004 Authorization code 29 6 X On the remittance, fill with zeros. On the return, it will return with the authorization code. No consistency at the moment of the sending.
005 Sale date 35 8 N Format DDMMYYYY Only accepted the specified format
006 Options of the sale 43 1 N ‘0’ – In one lump sum, ‘2’ - Installment retailer, ‘4’ – Installment retailer – Airline company Mandatory Field. Within the same lot, all operations must have the same sale option.
007 Amount of the sale * 44 15 N One lump sum sale => value of the sale. Intallment sale => Installments total amount + input amount + boarding tax Mandatory Field - It must respect the “sale option” - Cannot be less than zero/non numeric
008 Installments amount 59 3 N Sale in one lump sum => Fill with zeros. Installment sale => amount of sales Mandatory Field - It must respect the “sale option” - Cannot be less than zero/non numeric.
009 Financed amount * 62 15 N Sale in one lump sum => Fill with zeros. Installment sale => Original financed value Cannot be less than zero \ non numeric
010 Input value 77 15 N Sale in one lump sum => Fill with zeros. Installment sale => Input value. Only Airline Companies Cannot be less than zero \ non numeric
011 Boarding tax 92 15 N Only fill for Airline Companies. Otherwise, fill with zeros Cannot be less than zero \ non numeric
012 Installment amount 107 15 N Sale in one lump sum => Fill with zeros. Installment sale => Installment amount (sem arredondar) Mandatory Field. Cannot be less than 0 or non numeric
013 Operations summary (OS) number 122 7 N Equal to the OS number informed on the header register Mandatory to the use of the same header number
014 Do not use 129 3 N Constant = zeros Not read
015 Establishment number 132 10 N Number of the card machine (CIELO contract) It must be the same of the header
016 Reserved for the establishment 142 30 X Exclusive establishment use, not used by CIELO No verifications
017 Sale status (return code). Detail on the field 023 172 2 N On the remittance, fill with zeros, On the return, it will be formated by CIELO containing status like on the ATTACHED I table No verifications
018 Expected settlement date 174 8 N On the remittance, fill with zeros, On the return, it will be formated by CIELO with the expected settlement date. Not read
019 Card expiring date 182 4 X Format = YYMM Mandatory Field
020 Do not use 186 7 N Constants = zero Not read
021 Do not use 193 15 N Constants = zero Not read
022 Do not use 208 03 X Inform blanks No verifications
023 Código do Erro 211 04 X On the remittance, fill with blanks. On the return, in case there’s an error, it will be returned by Cielo like on the ATTATCHMENT II No verifications
024 Reference 215 11 X Constant = blanks It must be blank
025 New Card 226 19 X On the remittance, fill with blanks. On the return, it case there’s a “renews easily” covenant, it will appear the number of the card aligned to the left with blanks on the right. No verifications
026 New Expiration 245 04 N On the remittance, fill with blanks. On the return, in case there’s a ‘‘renews easily” covenant, it will appear the expiration date. New card No verifications
027 Do not use 249 02 X Constant = blanks Not read

Trailler Register

SEQUENCE DESCRIPTION POSITION SIZE FORMAT COMMENTS EDI consistencies
001 Type of register 1 2 N Identifies the type of register traillers detail Mandatory the use of the code “99”
002 Registers amount 3 7 N Including header and trailler Rejection if less than 0 or non numeric
003 Total gross value (*) 10 15 N Informed by the establishment – Total value lot, sum of the field 007 from the register detail. Rejection if less than 0 or non numeric. Rejects if the value different from sum of the 07 field
004 Total accepted value (*) 25 15 N On the remittance, fill with zeros; On the return, it will be formatted by Cielo with the Total accepted value. No verifications
005 Total net value (*) 40 15 N On the remittance, fill with zeros; On the return, it will be formatted by Cielo with the Total net value. No verifications
006 Credit expected date 55 8 N On the remittance, fill with zeros; On the return, it will be formatted by Cielo with the expected payment date. No verifications
007 Do not use 63 188 X Constant = blanks Not read

Remittance Files and Cancellation Return

Remittance Files layout and Cancellation Returns (Not PCI) used for the cancellation of transactions through an EDI channel, for example, recurring transactions.

Key without PCI certification:

Header Register

SEQUENCE DESCRIPTION POSITION SIZE FORMMAT COMMENTS EDI consistencies  
001 Type of register 1 2 N Identifies the type of header register Mandatorily has to be “00”  
002 Deposit date 3 8 N Date of the generation and transmission of movement Mandatory Field. Format must be DDMMYYYY  
003 Number of operations summary (OS) 11 7 N Informed by the establishment, identifies the transactions lot. Mandatory Field. NDo not send the same lot in a 30 days period from the previous send.  
004 Reserved for the establishment 18 10 X Exclusive establishment use, not used by CIELO No verifications  
005 Do not use 28 3 N Constant = Zeros Not read  
006 Cielo establishment number 31 10 N Number of the card machine (CIELO contract) Mandatory field. Rejected if sale value, Installment sale => sum of installments and input amount. Mandatory Field. It must respect the “sale option”
008 Amount of installments 59 3 N Sale in one lump sum => fill with zeros, Installment sale => amount of sales Mandatory Field. It must respect the “sale option”  
009 Financed amount * 62 15 N Sale in one lump sum => fill with zeros, Venda parcelada => Original amount financed Mandatory Field. It must respect the “sale option”  
010 Input amount 77 15 N Sale in one lump sum => fill with zeros, Installment sale => Input amount. Only Airline Companies Mandatory Field. It must respect the “sale option”  
011 Tax value of boarding 92 15 N Fill only for airline companies. Otherwise, fill with zeros Rejected if different from zero or non numeric  
012 Installment amount * 107 15 N Sale in one lump sum => fill with zeros, Installment sale => Installment amount (do not round) Mandatory Field. It must respect the “sale option”  
013 Mumber of operations summary (OS) 122 7 N Equal to the OS number informed on the header register It is mandatory the use of the same header number  
014 Do not use 129 3 N Constant = zeros Not read  
015 Establishment number 132 10 N Number of the card machine (CIELO contract) It must be the same of the header  
016 Reserved for the establishment 142 30 X Exclusive establishment use, it is not used by CIELO No verifications  
017 Sale status (return code). Detail on the field 023 172 2 N Na remessa preencher com zeros. On the return, it will be formated by CIELO containing the status as on the ATTATCHMENT I table No verifications  
018 Expected settlement date 174 8 N On remittance, fill with zeros; On the return, it will be formated by CIELO with the expected settlement date. Not read  
019 Card expiration date 182 4 X Format = YYMM. It can be filled with zeros No verifications  
020 Number of original operations summary (OS) 186 7 N Inform the original OS sale number Mandatory Field. Rejected if ( * ) - These fields must be considered with 2 (two) decimal houses, without commas, dots or any other character to separete the numbers.</aside>  

Rules - sales cancellation

The cancellation of any transaction will only be accepted if there’s available balance on the Commercial Establishment Finantial Agenda to cover the amount of the requested cancellation..

Transactions in One Lump Sum: there can be send more than one partial cancellation of the same transaction on the same day, as long as they are sent in different Lots / Installment Store Transaction: does not allow the partial cancellation of the same transaction on the same day.

Attachments

ATTACHMENT I - Table of Return Codes

Rejection Code Descriptive of the Occurrence
00 Transaction OK (Transaction Accepted)
01 Error on the file
02 Invalid authorization code
03 Invalid establishment
04 Mixed lot
05 Invalid installments number
06 Amount difference on the OS
07 Invalid OS number (BH register)
08 Invalid input value
09 Invalid board tax amount
10 Invalid installment amount
11 Invalid transaction code
12 Invalid transaction
13 Invalid amount
14 Not Applicable
15 Invalid cancellation amount
16 Original transaction not located (for cancellation)
17 Number of items informed on the OS are not compatible to the CVs
18 Invalid reference number
20 Cancellation for installment of an already cancelled transaction
21 Cancellation amount greater than the sale’s
22 Cancellation amount greater than allowed (jurisdiction)
)  
23 Invalid number of the original OS number (register I2)
42 Canceled card
54 It is not allowed the partial cancellation of an installment plan that is being contested by the holder.
56 Invalid card plan type
59 Invalid card type 60 Invalid date
71 Transaction declined by the issuing bank
72 Transaction declined by the issuing bank
73 Card problem - retain the card
74 Authorization denied
75 Error
76 Transaction declined by the issuing bank
77 Sintax error - redo the transaction
78 Emiiter authorization not found
79 Canceled card
80 Canceled card
81 Insufficient funds
82 Expired card or wrong expiration date
87 Card not allowed
88 Exceeded the number of transactions in the period
89 Message differs from original message
92 Issuing bank without communication
93 Cancellation with more than 365 days
94 Duplication on the airlines
95 No balance in open
99 Other reasons

ATTACHMENT II – Detailing of the error to the Sales Status informed on the field 23

CODE Error complement CE action
E001 The Lot has exceeded the number of records Review file structure
E001 Incorrect lot structure Review file structure
E001 Invalid transmission means Contact Cielo
E002 Review the card information Redo the transaction with valid inforation
E005 Establishment Number not found Check the Cielo Establishment data
E005 Problem with your register on Cielo Contact Cielo
E010 Problem with your register on Cielo Contact Cielo
E023 Problem with your register on Cielo Contact Cielo
E024 Card type not allowed in this channel Contact your costumer
E044 Transaction date does not match Review original transaction data
E045 Authorization code not found Review transaction data
E048 Card expriration date is incorrect Contact your costumer
E054 Incorrect lot estructure Review your file
E055 Invalid installment amount Review installments amount
E056 Transaction not allowed for your register Do not resend transaction
E057 Canceled card Contact your costumer
E061 Review the card information Redo the transaction with valid information
E094 Transaction not allowed for International cards Do not resend transaction
E095 Transaction not allowed for Debit cards Do not resend transaction
E097 Installment with the amount inferior to R$ 5,00 Redo adjusting the installments amount
E101 Transaction declined by the Issuing bank Contact your costumer
E102 Transaction declined by the Issuing bank Contact your costumer
E103 Problem with your register on Cielo Contact Cielo
E104 Canceled card Contact your costumer
E105 Transaction declined by the Issuing bank Contact your costumer
E107 Transaction declined by the Issuing bank Contact your costumer
E112 Transaction not allowed in this channel Contact Cielo
E112 Transaction in Dollar currency, not allowed Do not resent transaction
E112 Transaction with no authorization code Redo including the authorization code
E112 Transaction not allowed for Recurring Register Contact Cielo
E112 Transaction authorized previously Do not resent transaction
E112 Card not allowed for Dollar Register Do not resent transaction
E112 Installment Transaction not allowed Do not resent transaction
E112 Problem with your register on Cielo Contact Cielo
E112 Transaction not allowed Do not resent transaction
E112 Transaction not allowed by your register Do not resent transaction
E112 International card transaction not allowed for your register Do not resent transaction
E112 Invalid transaction data Review transaction data
E114 Review the card information Redo the transaction with valid information
E141 Canceled card Contact your costumer
E143 Canceled card Contact your costumer
E151 Transaction not authorized by the Issuing bank Contact your costumer
E154 Incorrect card expiration date Contact your costumer
E157 Canceled card Contact your costumer
E158 Card type not allowed in this channel Contact Cielo
E162 Card not allowed in this transaction Contact your costumer
E180 Transaction date does not match Review original transaction data
E182 Invalid Card security code Review transaction data / Contact your costumer
E191 Issuing Bank with no communication Contact Cielo
E192 Applicable for Airline companies Applicable for Airline companies
E205 Review card data Redo the transaction with valid information
E207 Invalid Lot number Review Lot number
E207 Lot field is not numeric Review Lot number
E207 Duplicate Lot number Review Lot number
E209 Applicable for Airline companies Review amount
E210 Invalid Installment amount Field zeroed number of installments
E210 Invalid Installment amount Contact Cielo
E210 Product not authorized for your Establishment Contact Cielo
E210 Installment amount greater than the allowed Contact Cielo to change installment register
E211 Applicable for Airline companies Review amount
E212 Applicable for Airline companies Review amount
E213 Cancellation amount not allowed Review transaction data
E214 Transaction not found Review transaction data
E215 Already canceled transaction Contact Cielo
E216 Transaction canceled previously Do not resend transaction
E217 Cancellation amount greater than the sale Review transaction data
E218 Cancellation not allowed in this channel Contact Cielo
E219 OS number not found Review transaction data
E220 Transaction cancellation timeout exceeded Do not resend transaction
E900 Invalid Register type Review file estructure
E901 Invalid Header Deposit date Review transaction data
E902 Invalid number of Operations Summary (OS) of the header Review the number of Operations Summary (OS)
E903 Establishment Number of the Header invalid Review the Establishment Number/Contact Cielo
E904 Invalid Header currency Review the Header estructure
E905 Invalid Header test indicator Review the Header estructure
E906 Invalid Header test indicator Review the Header estructure
E911 Invalid sale receipt (SR) number Review transaction data
E912 Invalid Sale Date Review transaction data
E913 Invalid Sale Date Review transaction data
E914 Invalid card number Review transaction data/Contact your costumer
E915 Invalid sale amount Review transaction data
E916 Invalid installments amount Review transaction data
E917 Invalid funded amount Review transaction data
E918 Invalid input amount Review transaction data
E919 Invalid board tax amount Applicable for Airline Companies
E920 Invalid installment amount Review transaction data
E921 Invalid Operations Summary (OS) number Review the Operations Summary (OS) numbe
E922 Invalid Establishment Number Review the Establishment Number / Contact Cielo
E923 Invalid card expiration date Contact your costumer
E924 Invalid Original Operations Summary (OS) number Review the Operations Summary (OS) number
E925 Invalid refund amount Review transaction data
E926 Invalid reference number Review transaction data
E930 Amount of Trailer registers does not match Review the registers amount
E931 Total gross amount does not match Review transaction data