Batch Store Registration

Overview

The Carat Portal has a interface to register sereval merchant stores in batch mode.

For this, the merchant must send to the Carat Portal's support team a store importation file following a certain format, so the data of the merchant's store can be registered at once. The importation can be done only if all the stores belong to the same group.

The main purpose of the interface is to offer to developers the possibility to develop an application that creates a file based on this especification. Creating the file manually is not recommended.

Importation File Format

ATTENTION: The importation file must be generated with the UTF-8 encode.

Default fields

Format to be received (Format per line):

field1;field2;field3;...;field16;<authorizer1>;<authorizer2>;...;<authorizerN>

Authorizer Configuration Fields

authorizer1, authorizer2, ..., authorizerN - Authorizers to be configured in the store. May be sent N authorizers. The field authorizerN must be in the following format:

...;authField1|authField2|authField3|authField4|authField5|parameter1|parameter2|...|parameterN

(*) Field affects only payment e pre-authorization via HTML interface.

Example

Result

cod_loja_comp;Loja dos Computadores;Loja dos Computadores LTDA.;11137051003444;R. dos Computadores,3032;S Joao do Sul;SC;07022000;12341234;[email protected];https://dominio.com.br; https://dominio.com.br/avisoStatus.jsp; https://dominio.com.br/autenticidade.jsp; https://dominio.com.br/envioHash.jsp; https://dominio.com.br/sucesso.jsp;http://dominio.com.br/fracasso.jsp; https://dominio.com.br/cancelamento.jsp;1|1125|2000|5|5|00000001;2|1005|10 00|10|10|00000002

Routing Parameters

Each routing has required parameters to work properly. They must be used in the variable fields parameter1, parameter2, ..., parameterN:

ATTENTION: The parameters must be sent in the order as described below.

BIN via SiTef

Required parameters for BIN via SiTef routing:

• BIN affiliation code
• Virtual Terminal (alphanumeric length 8)

BIN via SiTef Example

...;2|1229|200|7|10|12345678|1TerVir8

Global Payments via SiTef

Required parameters for Global Payments via SiTef routing:

• Global Payments affiliation code

Global Payments via SiTef Example

...;2|1206|200|8|10|12345678

Global Payments WS

This routing refers to the Global Payments' acquirer e-commerce interface. Required parameters for Global Payments WS routing:

• merchantCode: numeric (length 15)
• secretKey: alphanumeric (length 20)
• terminal: numeric (length 3)

Global Payments WS Example

...;2|408|800|10|10| merchantCode:123456789012345|secretKey:qwertyasdf0123456789|terminal:001

Complete File Lines Example

In this section will be listed some examples of importation file lines.

Just One Authorizer

cod_loja_comp;Loja dos Computadores;Loja dos ComputadoresLTDA.;11137051003444;R. dos Computadores,3032;S Joao doSul;SC;07022000;12341234;[email protected];https://dominio.com.br;https://dominio.com.br/avisoStatus.jsp;https://dominio.com.br/autenticidade.jsp;https://dominio.com.br/envioHash.jsp;https://dominio.com.br/sucesso.jsp;http://dominio.com.br/fracasso.jsp;https://dominio.com.br/cancelamento.jsp;1|1125|2000|5|5|00000001

cod_loja_comp;Loja dos Computadores;Loja dos ComputadoresLTDA.;11137051003444;R. dos Computadores,3032;S Joao doSul;SC;07022000;12341234;[email protected];https://dominio.com.br;https://dominio.com.br/avisoStatus.jsp;https://dominio.com.br/autenticidade.jsp;https://dominio.com.br/envioHash.jsp;https://dominio.com.br/sucesso.jsp;http://dominio.com.br/fracasso.jsp;https://dominio.com.br/cancelamento.jsp;1|1125|2000|5|5|00000001;2|405|1000|10|10|salesAffiliationKey :chaveDeIdentificacaoDaLojaNaStone

Authorizer Code Examples

List of some allowed authorizers on the importation: