Cadastros de Lojas em Lote

Visão Geral

O Carat possui uma interface para que sejam cadastradas várias lojas de um cliente, em lote.

Para isto, o lojista deve enviar à equipe de atendimento um arquivo de importação de lojas, seguindo um determinado formato para que os dados das lojas do lote sejam cadastrados corretamente e rapidamente. A importação de lojas é feita somente quando todas as lojas pertencerem a um mesmo grupo.

A ideia é que o desenvolvedor do cliente crie um programa que gera o arquivo de importação seguindo o formato apresentado, pois a geração manual deste arquivo seria trabalhosa e passível de erros.

Formato do arquivo de importação

ATENÇÃO: O arquivo de importação deve ser gerado com codificação UTF-8.

Campos Padrão

Formato a ser recebido (formatação por linha):

campo1;campo2;campo3;...;campo16;<autorizadora1>;<autorizadora2>;...;<autorizadoraN>

Campo	Descrição do campo	Tamanho e formato	Obrigatório
campo1	Código da Loja ou merchant Id. Este valor identifica a loja no Carat de forma única. Logo sugere-se utilizar aqui o CNPJ da empresa, sem formatação, apenas com números, a fim de evitar conflitos de códigos entre lojas diferentes.	< 15 AN	Sim
campo2	Nome Fantasia	< 250 AN (s/ acentuação)	Sim
campo3	Razão Social	< 250 AN (s/ acentuação)	Sim
campo4	CNPJ	< 15 N	Opcional
campo5	Endereço (rua e número)	< 30 AN (s/ acentuação)	Opcional
campo6	Cidade	< 13 AN (s/ acentuação)	Opcional
campo7	Estado	= 2 A	Opcional
campo8	CEP não formatado (apenas números)	< 9 N	Opcional
campo9	Telefone (opcional)	> 5 e < 20 N	Opcional
campo10	e-mail (opcional)	> 5 e < 20 AN	Opcional
campo11	Domínio do site	< 50 AN (s/ acentuação)	Opcional
campo12	URL de Aviso de Status (HTTPS)	< 500 AN (s/ acentuação)	Opcional
campo13	URL de Autenticidade de transação (HTTPS)	< 500 AN (s/ acentuação)	Opcional
campo14	URL para envio de HASH (HTTPS)	< 500 AN (s/ acentuação)	Opcional
campo15	URL de Sucesso	< 500 AN (s/ acentuação)	Opcional
campo16	URL de Fracasso	< 500 AN (s/ acentuação)	Opcional
campo17	URL de Cancelamento	< 500 AN (s/ acentuação)	Opcional
autorizadoraN	Configurações de autorizadoras (vide seção Campos de configuração de autorizadoras abaixo.	-	Sim

Campos de configuração de autorizadoras

autorizadora1, autorizadora2, ..., autorizadoraN - Autorizadoras a serem cadastradas na loja. Podem ser enviadas N autorizadoras. O campo autorizadoraN devem ter o seguinte formato:

...;campoAut1|campoAut2|campoAut3|campoAut4|campoAut5|parametro1|parametro2|...|parametroN

Campo	Descrição do campo	Tamanho e formato
campoAut1	Código da Autorizadora. Para verificar os códigos de autorizadora permitidos, veja a seção Exemplos de Autorizadoras.	< 5 N
campoAut2	Código do roteamento. Para verificar os códigos de roteamento permitidos, veja a seção Exemplos de Roteamentos.	< 5 N
campoAut3	Valor mínimo por parcela em caso de pagamento parcelado, em centavos (*).	< 8 N
campoAut4	Parcelamento máximo com juros (*).	< 2 N
campoAut5	Parcelamento máximo sem juros (*).	< 2 N
parametro1, parametro2, parametroN	Parâmetros da autorizadora. Podem ser enviados N parâmetros. Verifique a seção Parâmetros dos roteamentos para verificar os necessários para cada roteamento.	-

(*) Campos utilizados apenas para configurar pagamentos e pré-autorizações via interface HTML.,

Exemplo

Campo	Valor
Código de Loja	cod_loja_comp
Nome Fantasia	Loja dos Computadores
Razão Social	Loja dos Computadores LTDA.
CNPJ	11137051003444
Endereço	R. dos Computadores, 3032
Cidade	S Joao do Sul
Estado	SC
CEP	07022000
Telefone	12341234
E-mail	email@email.com
Domínio	https://dominio.com.br
URL de Aviso de status	https://dominio.com.br/avisoStatus.jsp
URL de Autenticidade	https://dominio.com.br/autenticidade.jsp
URL de Armazenamento	https://dominio.com.br/envioHash.jsp
URL de Sucesso	https://dominio.com.br/sucesso.jsp
URL de Fracasso	http://dominio.com.br/fracasso.jsp
URL de Cancelamento	https://dominio.com.br/cancelamento.jsp
AUTORIZADORAS
AUTORIZADORA 1
Autorizadora	Visa [1]
Roteamento	Cielo [1125]
Valor mínimo de cada parcela	20 reais [2000]
Parcelamento máximo com juros	5 parcelas [5]
Parcelamento máximo sem juros	5 parcelas [5]
Código de Filiação Cielo	00000001
AUTORIZADORA 2
Autorizadora	Mastercard [2]
Roteamento	Rede (Redecard) [1005]
Valor mínimo de cada parcela	10 reais [1000]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação Rede (Redecard)	00000002

Resultado

cod_loja_comp;Loja dos Computadores;Loja dos Computadores LTDA.;11137051003444;R. dos Computadores,3032;S Joao do Sul;SC;07022000;12341234;email@email.com.br;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

Parâmetros dos roteamentos

Cada roteamento possui parâmetros necessários para que eles funcionem corretamente. Eles devem ser inseridos nos campos variáveis parametro1, parametro2, ..., parametroN:

ATENÇÃO: Os parâmetros devem ser enviados na ordem em que estão descritos nos exemplos a seguir.

Cielo via SiTef

Parâmetro necessários para o roteamento Cielo via SiTef:

• Código de filiação Cielo

Exemplo Cielo via SiTef

Campo	Valor
Autorizadora	Visa [1]
Roteamento	Cielo [1125]
Valor mínimo de cada parcela	10 reais [1000]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação Cielo	00000001

...;1|1125|1000|10|10|00000001

Rede (Redecard) via SiTef

Parâmetros necessários para o roteamento Rede (Redecard) via SiTef:

• Código de filiação Rede (Redecard)

Exemplo Rede (Redecard) via SiTef

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	Rede (Redecard) [1005]
Valor mínimo de cada parcela	10 reais [1000]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação Rede [Redecard]	00000002

...;1|1005|1000|10|10|00000002

Stone via SiTef

Parâmetros necessários para o roteamento Stone via SiTef:

• Código de filiação Stone
• Código Stone (alfanumérico tamanho 9)

Exemplo Stone via SiTef

Campo	Valor
Autorizadora	Visa [1]
Roteamento	Stone via SiTef [1265]
Valor mínimo de cada parcela	2,65 reais [265]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação Stone	codigoFiliacaoDaLojaNaStone32Car
Código Stone	123456789

...;1|1265|265|10|10|codigoFiliacaoDaLojaNaStone32Car|123456789

BIN via SiTef

Parâmetros necessários para o roteamento BIN via SiTef:

• Código de filiação BIN
• Terminal Virtual (alfanumérico tamanho 8)

Exemplo BIN via SiTef

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	BIN via SiTef [1229]
Valor mínimo de cada parcela	2 reais [200]
Parcelamento máximo com juros	7 parcelas [7]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação BIN	12345678
Terminal Virtual	1TerVir8

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

Safra via SiTef

Parâmetros necessários para o roteamento Safra via SiTef:

• Código de filiação Safra
• Número Lógico Terminal TEF (alfanumérico tamanho 8)

Exemplo Safra via SiTef

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	Safra via SiTef [1296]
Valor mínimo de cada parcela	6 reais [600]
Parcelamento máximo com juros	6 parcelas [6]
Parcelamento máximo sem juros	11 parcelas [11]
Código de Filiação Safra	98765432
Número Lógico Terminal TEF	NoLgTe12

...;2|1296|600|6|11|98765432|NoLgTe12

Global Payments via SiTef

Parâmetros necessários para o roteamento Global Payments via SiTef:

• Código de filiação Global Payments

Exemplo Global Payments via SiTef

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	Safra via SiTef [1206]
Valor mínimo de cada parcela	2 reais [200]
Parcelamento máximo com juros	8 parcelas [8]
Parcelamento máximo sem juros	10 parcelas [10]
Código de Filiação Global Payments	12345678

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

Getnet Lac via SiTef

Parâmetros necessários para o roteamento Getnet Lac via SiTef:

• Código de filiação Getnet Lac
• Terminal Lógico (alfanumérico tamanho 8)

Exemplo Getnet Lac via SiTef

Campo	Valor
Autorizadora	Visa [1]
Roteamento	Safra via SiTef [1181]
Valor mínimo de cada parcela	8 reais [800]
Parcelamento máximo com juros	11 parcelas [11]
Parcelamento máximo sem juros	12 parcelas [12]
Código de Filiação Getnet Lac	87654321
Terminal Lógico	TerLog18

...;1|1181|800|11|12|87654321|TerLog18

Stone WS

Este roteamento se refere à interface e-commerce da adquirente Stone. Parâmetros necessários para o roteamento via Stone WS:

• salesAffiliationKey: alfanumérico.

ATENÇÃO: Os parâmetros específicos para este roteamento devem ser enviados no formato chave:valor.

Exemplo Stone WS

Campo	Valor
Autorizadora	Visa [1]
Roteamento	Stone WS [409]
Valor mínimo de cada parcela	9 reais [900]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
salesAffiliationKey	chaveDeIdentificacaoDaLojaNaStone

...;1|409|900|10|10|salesAffiliationKey:chaveDeIdentificacaoDaLojaNaSt

one

Cielo EC

Este roteamento se refere à interface e-commerce da adquirente Cielo. Parâmetros necessários para o roteamento via Cielo EC:

• merchantId: alfanumérico (tamanho < 36)
• merchantKey: alfanumérico (tamanho < 40)

ATENÇÃO: Os parâmetros específicos para este roteamento devem ser enviados no formato chave:valor.

Exemplo Cielo EC

Campo	Valor
Autorizadora	Visa [1]
Roteamento	Cielo EC [201]
Valor mínimo de cada parcela	21 reais [2100]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
merchantId	identificacaoDaLojaNaCieloEC
merchantKey	chaveDaLojaNaCieloEC

...;1|201|2100|10|10|merchantId:identificacaoDaLojaNaCieloEC|merchantKey:chaveDaLojaNaCieloEC

e-Rede

Este roteamento se refere à interface e-commerce da adquirente Rede. Parâmetros necessários para o roteamento via e-Rede:

• filiacao: numérico (tamanho 9)
• senha: alfanumérico (tamanho 32)

ATENÇÃO: Os parâmetros específicos para este roteamento devem ser enviados no formato chave:valor.

Exemplo e-Rede

Campo	Valor
Autorizadora	Visa [1)]
Roteamento	e-Rede [1200]
Valor mínimo de cada parcela	13 reais [1300]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
filiacao	123456789
senha	aSenhaLojaNaERedeCom32Caracteres

...;1|1200|1300|10|10|filiacao:123456789|senha:aSenhaLojaNaERedeCom32Caracteres

Global Payments WS

Este roteamento se refere à interface e-commerce da adquirente Global Payments. Parâmetros necessários para o roteamento via Global Payments WS:

• merchantCode: numérico (tamanho 15)
• secretKey: alfanumérico (tamanho 20)
• terminal: numérico (tamanho 3)

ATENÇÃO: Os parâmetros específicos para este roteamento devem ser enviados no formato chave:valor.

Exemplo Global Payments WS

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	Global Payments WS [408]
Valor mínimo de cada parcela	8 reais [800]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
merchantCode	123456789012345
secretKey	qwertyasdf0123456789
terminal	001

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

Getnet WS

Este roteamento se refere à interface e-commerce da adquirente Getnet. Parâmetros necessários para o roteamento via Global Payments WS:

• username: alfanumérico (tamanho 20)
• password: alfanumérico (tamanho 40)
• merchantID: numérico (tamanho 10)
• terminalID: alfanumérico (tamanho 7)

ATENÇÃO: Os parâmetros específicos para este roteamento devem ser enviados no formato chave:valor.

Exemplo Getnet WS

Campo	Valor
Autorizadora	Mastercard [2]
Roteamento	Getnet WS [407]
Valor mínimo de cada parcela	7 reais [700]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	12 parcelas [12]
username	nomeUsuarioDeAcessoG
password	senhaRelativaAoUsernameAcimaComQuarenta
merchantID	1234567890
terminalID	1234567

...;2|407|700|10|12|username:nomeUsuarioDeAcessoG|password:senhaRelativaAoUsernameAcimaComQuarenta|merchantID:123456790|terminalID:1234567

Exemplo completos de linha de arquivo

Abaixo listaremos alguns exemplos de linhas de arquivo de importação.

Apenas uma autorizadora

Campo	Valor
Código Loja	cod_loja_comp
Nome Fantasia	Loja dos Computadores
Razão Social	Loja dos Computadores LTDA.
CNPJ	11137051003444
Endereço	R. dos Computadores, 3032
Cidade	S Joao do Sul
Estado	SC
CEP	07022000
Telefone	12341234
E-mail	email@email.com
Domínio	https://dominio.com.br
URL de Aviso de status	https://dominio.com.br/avisoStatus.jsp
URL de Autenticidade	https://dominio.com.br/autenticidade.jsp
URL de Armazenamento	https://dominio.com.br/envioHash.jsp
URL de Sucesso	https://dominio.com.br/sucesso.jsp
URL de Fracasso	http://dominio.com.br/fracasso.jsp
URL de Cancelamento	https://dominio.com.br/cancelamento.jsp
AUTORIZADORA
Autorizadora	Visa [1]
Roteamento	Cielo [1125]
Valor mínimo de cada parcela	20 reais [2000]
Parcelamento máximo com juros	5 parcelas [5]
Parcelamento máximo sem juros	5 parcelas [5]
Código de Filiação Cielo	00000001

cod_loja_comp;Loja dos Computadores;Loja dos ComputadoresLTDA.;11137051003444;R. dos Computadores,3032;S Joao doSul;SC;07022000;12341234;email@email.com.br;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

Duas autorizadoras

Campo	Valor
Código Loja	cod_loja_comp
Nome Fantasia	Loja dos Computadores
Razão Social	Loja dos Computadores LTDA.
CNPJ	11137051003444
Endereço	R. dos Computadores, 3032
Cidade	S Joao do Sul
Estado	SC
CEP	07022000
Telefone	12341234
E-mail	email@email.com
Domínio	https://dominio.com.br
URL de Aviso de status	https://dominio.com.br/avisoStatus.jsp
URL de Autenticidade	https://dominio.com.br/autenticidade.jsp
URL de Armazenamento	https://dominio.com.br/envioHash.jsp
URL de Sucesso	https://dominio.com.br/sucesso.jsp
URL de Fracasso	http://dominio.com.br/fracasso.jsp
URL de Cancelamento	https://dominio.com.br/cancelamento.jsp
AUTORIZADORAS
AUTORIZADORA 1
Autorizadora	Visa [1]
Roteamento	Cielo [1125]
Valor mínimo de cada parcela	20 reais [2000]
Parcelamento máximo com juros	5 parcelas [5]
Parcelamento máximo sem juros	5 parcelas [5]
Código de Filiação Cielo	00000001
AUTORIZADORA 2
Autorizadora	Mastercard [2]
Roteamento	Stone WS [409]
Valor mínimo de cada parcela	10 reais [1000]
Parcelamento máximo com juros	10 parcelas [10]
Parcelamento máximo sem juros	10 parcelas [10]
salesAffiliationKey	chaveDeIdentificacaoDaLojaNaStone

cod_loja_comp;Loja dos Computadores;Loja dos ComputadoresLTDA.;11137051003444;R. dos Computadores,3032;S Joao doSul;SC;07022000;12341234;email@email.com.br;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

Exemplos de Autorizadoras

Abaixo estão listadas as autorizadoras que podem ser enviadas na importação:

Autorizadora	Código
Visa	1
Mastercard	2
Amex	3
Hipercard / Hiper	5
Aura	6
Diners	33
Elo	41
JCB	43
Discover	44
Visa Electron	221
Maestro / Mastercard débito	286

Exemplos de Roteamentos

Abaixo estão listados os roteamentos que podem ser enviados na importação:

Autorizadora	Código
Cielo	1125
Rede (Redecard)	1005
Stone WS	409
Cielo EC	201
e-Rede	1200
Global Payments WS	408
Getnet WS	407