Store Management

## Registration Via Batch ### Batch Routing Configuration

Source: https://docs.apis-fiserv.com/latam/docs/lote-config-roteamento

Overview

The batch routing configuration may be used when a group of stores requests a routing update of the Issuer (Mastercard, Visa, etc.) in only a portion of its stores or when the number of stores make it impossible to configure one by one manually.

Thus, for example, a group with 800 stores that route the issuers Visa and Mastercard by Cielo, could make 100 of them route Visa via Rede.

Prerequisites

As prerequisites, the stores and authorizers (issuers) that will have their routing updated must already be registered on Carat Portal. If not, check the Batch Store Registration documentation.

The routings and issuers must also be already configured on SiTef. To that end, contact our Carat Portal Support Team to ensure production operation.

Supported Routings/Acquirer Networks

The routings supported for batch routing configuration are:

Bin via SiTef

Cielo via SiTef
Rede via SiTef
GetNet via SiTef
Stone WS

Import File Format

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

The file will consist of the merchant code followed by the issuer you want to change and the routing/acquirer network through which the issuer will be routed, repeating one line per issuer, one or more lines per store.

Only the routings declared in the file will be changed, if the store has other issuers that were not declared, its configuration will be maintained.

Format to be received (Format per line):

field1;field2;field3;paramter1|paramter2|...|paramterN

Field	Description	Format	Required
`field1`	CNPJ (or `merchant code`, or `merchantId`). No formatting (alphanumeric).	< 15 AN	Yes
`field2`	Issuer/Authorizer code. Check the codes in the Issuer/Authorizer Codes section.	< 15 N	Yes
`field3`	Routing/Acquirer Network code. Check the codes in the Routing/Acquirer Network Codes section.	< 15 N	Yes
`paramter1`, `paramter2`, `paramterN`	Additional parameters that may vary according the acquirer network/routing.	-	No

Issuer/Authorizer Codes

Issuer/Authorizer	Code
`VISA`	1
`MASTERCARD`	2
`AMERICAN EXPRESS (AMEX)`	3
`HIPERCARD`	5
`AURA`	6
`CABAL`	12
`VALECARD`	28
`SOROCRED`	29
`DINERS`	33
`ELO`	41
`GOODCARD`	42
`JCB`	43
`DISCOVER`	44
`CHINA UNION PAY`	45
`CREDZ`	46
`AGIPLAN`	47
`VEROCHEQUE`	48
`PAN`	122
`AVISTA CREDITO`	192

Routing/Acquirer Network Codes

Routing/Acquirer Network	Code
`Cielo via SiTef`	1125
`Rede (old Redecard) via SiTef`	1005
`GetNet via SiTef`	1181
`e-Rede`	1200

Routing/Acquirer Network	Code
`Cielo via SiTef`	1125
`Rede (old Redecard) via SiTef`	1005
`GetNet via SiTef`	1181
`e-Rede`	1200
`Stone WS`	409

Additional Parameters

Some routings/acquirer networks requires additional parameters registered on Carat Portal to perform transactions. To register them, fill in the additional parameters from the field 4 onwards.

...;key1:value1|key2:value2|key3X:valueX

Additional parameters are not required, but if not sent, the parameters will be set to a default value.

Stone WS

The Stone WS routing/acquirer network refers to the Stone acquirer e-commerce.

The following additional parameters are required to perform its functionalities:

Field	Description
salesAffiliationKey	Identification of the merchant on the Stone Acquirer.
subAdquirenciaHabilitada	Allowed values: `true` or `false`. This value must follow the configuration of the merchant on the Stone Acquirer regarding the subacquirer functionality.

NOTE

To use the Stone WS subacquirer functionality, the merchant's registration on Carat Portal must be completed. In other words, the Country, City, State and Zip Code fields must be properly be informed on the Merchant's store registration on Carat Portal. Contact the Carat Portal support team before updating a routing to Stone WS using the subacquirer functionality with SoftDescriptor. Check the Stone WS documentation for more details.

Stone WS Example

22222222222222;1;409;salesAffiliationKey:XXXXXXXXXX|subAdquirenciaHabilitada:true

Example

At first, all the stores in the XPTO group perform transactions with the issuers Visa, Mastercard, Hiper and Amex routing via Rede .

Initial state of the Group XPTO, including the stores 11111111111111, 22222222222222 and 333333333333333:

Issuer/Authorizer	Acquirer/Routing
Visa	Rede (old Redecard)
Mastercard	Rede (old Redecard)
Hiper	Rede (old Redecard)
Amex	Rede (old Redecard)

It is desired that only two stores in this group, 11111111111111 and 22222222222222, start to perform transactions both with Visa via Cielo and Mastercard , keeping the Amex and Hiper routings unchanged.

It is desired that only two stores in this group, 11111111111111 and 22222222222222, start to perform transactions both with Visa via Cielo and Mastercard via Stone WS, keeping the Amex and Hiper routings unchanged.

Merchants 11111111111111 and 22222222222222 after the update:

Issuer/Authorizer	Acquirer/Routing
Visa	Cielo
Mastercard	Stone WS
Hiper	Rede (old Redecard) -> Unchanged
Amex	Rede (old Redecard) -> Unchanged

It is also desired to change the store 333333333333333 to perform Visa transactions via Cielo and Amex , as in the following table.

It is also desired to change the store 333333333333333 to perform Visa transactions via Cielo and Amex transactions via Stone WS, as in the following table.

Merchant 333333333333333 after the update:

Issuer/Authorizer	Acquirer/Routing
Visa	Cielo
Mastercard	Rede (old Redecard) -> Unchanged
Hiper	Rede (old Redecard) -> Unchanged

Issuer/Authorizer	Acquirer/Routing
Visa	Cielo
Mastercard	Rede (old Redecard) -> Unchanged
Hiper	Rede (old Redecard) -> Unchanged
Amex	Stone WS (with subacquirer functionality)

The final file to be generated will be as shown below:

11111111111111;1;1125;
11111111111111;2;409;salesAffiliationKey:ABC123DEF456|subAdquirenciaHabilitada:false
22222222222222;1;1125;
22222222222222;2;409;salesAffiliationKey:ABC123DEF457|subAdquirenciaHabilitada:false
33333333333333;1;1125;
33333333333333;3;409;salesAffiliationKey:ABC123DEF458|subAdquirenciaHabilitada:true

ATTENTION: If the field 4 is empty, don't forget to put a semicolon (;) at the end of the line.

Batch Store Registration

Source: https://docs.apis-fiserv.com/latam/docs/lote-cadastro-loja

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>

Field	Field description	Format and size	Required
`field1`	`Merchant code` or `Merchant id`. this value uniquely identifies the store in the Carat Portal. Is recommended to use the company's CNPJ, without formatation, numbers and letters, in order to avoid merchant code conflicts between different stores.	< 15 AN	Yes
`field2`	Fantasy Name	< 250 AN (no accentuation)	Yes
`field3`	Corporate Name	< 250 AN (no accentuation)	Yes
`field4`	CNPJ	< 15 AN	Optional
`field5`	Address (street name and number)	< 30 AN (no accentuation)	Optional
`field6`	City	< 13 AN (no accentuation)	Optional
`field7`	State	= 2 A	Optional
`field8`	Zip Code (only numbers)	< 9 N	Optional
`field9`	Phone (Optional)	> 5 and < 20 N	Optional
`field10`	e-mail (Optional)	> 5 and < 20 AN	Optional
`field11`	Website domain	< 50 AN (no accentuation)	Optional
`field12`	Status Notification URL (HTTPS)	< 500 AN (no accentuation)	Optional
`field13`	Transaction Authenticity URL (HTTPS)	< 500 AN (no accentuation)	Optional
`field14`	URL for sending HASH (HTTPS)	< 500 AN (no accentuation)	Optional
`field15`	Success URL	< 500 AN (no accentuation)	Optional
`field16`	Failure URL	< 500 AN (no accentuation)	Optional
`field17`	Cancellation URL	< 500 AN (no accentuation)	Optional
`authorizerN`	Authorizer configurations (See the Authorizer Configuration Fields section.	-	Yes

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	Field description	Format and size
`authField1`	Authorizer's code. See the Authorizer codes Examples section to verify the allowed values.	< 5 N
`authField2`	Routing's code. See the Routing Examples section to verify the allowed values.	< 5 N
`authField3`	Minimum value allowed per installment, in cents (*).	< 8 N
`authField4`	Maximum installment with interest (*).	< 2 N
`authField5`	Maximum installment without interest (*).	< 2 N
`parameter1, parameter2, parameterN`	Authorizer parameters. N parameters may be sent. See the Routing Parameters section to verify the required fields for each routing.	-

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

Example

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZERS
AUTHORIZER 1
`Authorizer`	Visa [1]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]
AUTHORIZER 2
`Authorizer`	Mastercard [2]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZERS
AUTHORIZER 1
`Authorizer`	Visa [1]
`Routing`	Cielo [1125]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]
`Cielo affiliation code`	00000001
AUTHORIZER 2
`Authorizer`	Mastercard [2]
`Routing`	Rede (Redecard) [1005]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`Rede (Redecard) affiliation code`	00000002

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.

Cielo via SiTef

Required parameters for Cielo via SiTef routing:

Cielo affiliation code

Cielo via SiTef Example

Field	Value
`Authorizer`	Visa [1]
`Routing`	Cielo [1125]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`Cielo affiliation code`	00000001

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

Rede (Redecard) via SiTef

Required parameters for Rede (Redecard) via SiTef routing:

Rede (Redecard) affiliation code

Rede (Redecard) via SiTef Example

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	Rede (Redecard) [1005]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`Rede (Redecard) affiliation code`	00000002

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

Stone via SiTef

Required parameters for Stone via SiTef routing:

Stone affiliation code
Stone code (alphanumeric length 9)

Stone via SiTef Example

Field	Value
`Authorizer`	Visa [1]
`Routing`	Stone via SiTef [1265]
`Minimum value of each installment`	2,65 reals [265]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`Stone affiliation code`	codigoFiliacaoDaLojaNaStone32Car
`Stone code`	123456789

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

BIN via SiTef

Required parameters for BIN via SiTef routing:

BIN affiliation code
Virtual Terminal (alphanumeric length 8)

BIN via SiTef Example

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	BIN via SiTef [1229]
`Minimum value of each installment`	2 reals [200]
`Maximum installment with interest`	7 installments [7]
`Maximum installment without interest`	10 installments [10]
`BIN affiliation code`	12345678
`Virtual Terminal`	1TerVir8

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

Safra via SiTef

Required parameters for Safra via SiTef routing:

Safra affiliation code
TEF Terminal Logic Number (alphanumeric length 8)

Safra via SiTef Example

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	Safra via SiTef [1296]
`Minimum value of each installment`	6 reals [600]
`Maximum installment with interest`	6 installments [6]
`Maximum installment without interest`	11 installments [11]
`Safra affiliation code`	98765432
`TEF Terminal Logic Number`	NoLgTe12

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

Global Payments via SiTef

Required parameters for Global Payments via SiTef routing:

Global Payments affiliation code

Global Payments via SiTef Example

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	Safra via SiTef [1206]
`Minimum value of each installment`	2 reals [200]
`Maximum installment with interest`	8 installments [8]
`Maximum installment without interest`	10 installments [10]
`Global Payments affiliation code`	12345678

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

Getnet Lac via SiTef

Required parameters for Getnet Lac via SiTef routing:

Getnet Lac affiliation code
Logic Terminal (alphanumeric length 8)

Getnet Lac via SiTef Example

Field	Value
`Authorizer`	Visa [1]
`Routing`	Safra via SiTef [1181]
`Minimum value of each installment`	8 reals [800]
`Maximum installment with interest`	11 installments [11]
`Maximum installment without interest`	12 installments [12]
`Getnet Lac affiliation code`	87654321
`Logic Terminal`	TerLog18

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

Stone WS

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

salesAffiliationKey: alphanumeric.

ATTENTION: The especific parameters for this routing must be sent in the key:value format.

Stone WS Example

Field	Value
`Authorizer`	Visa [1]
`Routing`	Stone WS [409]
`Minimum value of each installment`	9 reals [900]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`salesAffiliationKey`	chaveDeIdentificacaoDaLojaNaStone

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

Cielo EC

This routing refers to the Cielo's acquirer e-commerce interface. Required parameters for Cielo EC routing:

merchantId: alphanumeric (length < 36)
merchantKey: alphanumeric (length < 40)

Cielo EC Example

Field	Value
`Authorizer`	Visa [1]
`Routing`	Cielo EC [201]
`Minimum value of each installment`	21 reals [2100]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`merchantId`	identificacaoDaLojaNaCieloEC
`merchantKey`	chaveDaLojaNaCieloEC

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

e-Rede

This routing refers to the Rede's acquirer e-commerce interface. Required parameters for e-Rede routing:

filiacao: numeric (length 9)
senha: alphanumeric (length 32)

e-Rede Example

Field	Value
`Authorizer`	Visa [1)]
`Routing`	e-Rede [1200]
`Minimum value of each installment`	13 reais [1300]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`filiacao`	123456789
`senha`	aSenhaLojaNaERedeCom32Caracteres

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

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

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	Global Payments WS [408]
`Minimum value of each installment`	8 reais [800]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`merchantCode`	123456789012345
`secretKey`	qwertyasdf0123456789
`terminal`	001

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

Getnet WS

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

username: alphanumeric (length 20)
password: alphanumeric (length 40)
merchantID: numeric (length 10)
terminalID: alphanumeric (length 7)

Getnet WS Example

Field	Value
`Authorizer`	Mastercard [2]
`Routing`	Getnet WS [407]
`Minimum value of each installment`	7 reais [700]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	12 installments [12]
`username`	nomeUsuarioDeAcessoG
`password`	senhaRelativaAoUsernameAcimaComQuarenta
`merchantID`	1234567890
`terminalID`	1234567

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

Complete File Lines Example

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

Just One Authorizer

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZER
`Authorizer`	Visa [1]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZER
`Authorizer`	Visa [1]
`Routing`	Cielo [1125]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]
`Cielo affiliation code`	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

Two Authorizers

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZERS
AUTHORIZER 1
`Authorizer`	Visa [1]
`Routing`	Cielo [1125]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]
`Cielo affiliation code`	00000001
AUTHORIZER 2
`Authorizer`	Mastercard [2]
`Routing`	Stone WS [409]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`salesAffiliationKey`	chaveDeIdentificacaoDaLojaNaStone

Field	Value
`Merchant Code`	cod_loja_comp
`Fantasy Name`	Loja dos Computadores
`Corporate Name`	Loja dos Computadores LTDA.
`CNPJ`	11137051003444
`Address`	R. dos Computadores, 3032
`City`	S Joao do Sul
`State`	SC
`Zip Code`	07022000
`Phone`	12341234
`E-mail`	[email protected]
`Domain`	https://dominio.com.br
`Status Notification URL`	https://dominio.com.br/avisoStatus.jsp
`Transaction Authenticity URL`	https://dominio.com.br/autenticidade.jsp
`Storage URL`	https://dominio.com.br/envioHash.jsp
`Success URL`	https://dominio.com.br/sucesso.jsp
`Failure URL`	http://dominio.com.br/fracasso.jsp
`Cancellation URL`	https://dominio.com.br/cancelamento.jsp
AUTHORIZERS
AUTHORIZER 1
`Authorizer`	Visa [1]
`Minimum value of each installment`	20 reais [2000]
`Maximum installment with interest`	5 installments [5]
`Maximum installment without interest`	5 installments [5]
AUTHORIZER 2
`Authorizer`	Mastercard [2]
`Routing`	Stone WS [409]
`Minimum value of each installment`	10 reals [1000]
`Maximum installment with interest`	10 installments [10]
`Maximum installment without interest`	10 installments [10]
`salesAffiliationKey`	chaveDeIdentificacaoDaLojaNaStone

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:

Authorizer	Code
`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

Routing Examples

List of some allowed routings on the importation:

Routing	Code
`Cielo`	1125
`Rede (Redecard)`	1005
`Stone WS`	409
`Cielo EC`	201
`e-Rede`	1200
`Global Payments WS`	408
`Getnet WS`	407

## Registration Via REST API ### Merchant Editing Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-edicao

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';
import ResponseCodes from './codigos-de-resposta.md';

After getting the token or signature in the previous step, the virtual store can consume the merchant editing service. For this, only the data to be altered must be sent.

Call details

Resource: /v1/merchants/{id}
HTTP Method: PUT
Request format: JSON
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained on the token creation service. Learn more.	= 66 AN	NO
`Content-Type`	Must be sent with the value `application/json`.	= 15 AN	YES
`Authorization`	The merchant's signature must be sent in the format `Bearer {signature}`. Exemple: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`.	< 2000 AN	NO

Example using token

To use this example, don't forget to define the variable {{url}} with the value

curl 
--request PUT "https://{{url}}/e-sitef/api/v1/merchants/qereIoinsd3d"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--data-binary
{
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "merchant_status":"A",
   "subacquirer_group":{
      "create":"true",
      "id":"123456",
      "cnpj":"12345678901234"
   },
   "domain":"www.testeloja.com",
   "cnpj":"123123123123",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "mcc":"1234",
   "threeds_payment_link_authentication": "1",
   "automatic_threeds_minimum_value" : "9999999",
   "automatic_threeds_maximum_value" : "100000",
   "automatic_antifraud_minimum_value" :  "0",
   "automatic_antifraud_maximum_value" : "99999",
   "antifraud_over_threeds" : "false",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "establishments":[
      {
         "code":"00000000123",
         "routing_id":"1125",
         "subacquirer_group_id":"123456"
      },
      {
         "code":"00000000321",
         "routing_id":"1005"
      }
   ],
   "authorizers":[
      {
         "id":"1",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"true",
         "acquirer_merchant_id": "12345"
      },
      {
         "id":"2",
         "routing_id":"1005",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"false",
         "acquirer_merchant_id": "11111",
         "cvv_mandatory":"true"
      }
   ]
}
--verbose

Example using signature

To use this example, don't forget to define the variable {{url}} with the value

curl --request PUT "https://{{url}}/e-sitef/api/v1/merchants/qereIoinsd3d" --header "Content-Type: application/json" --header "merchant_id: xxxxxxxx" --header "merchant_key: xxxxxxxxxxx" --header "Authorization: Bearer YYYYYYY" --data-binary { "fantasy_name":"Teste de Loja", "corporate_name":"Testes de Loja Ltda.", "merchant_status":"A", "subacquirer_group":{ "create":"true", "id":"123456", "cnpj":"12345678901234" }, "domain":"www.testeloja.com", "cnpj":"123123123123", "address":"Rua do Teste, 123", "city":"São Teste", "state":"SP", "zip_code":"12345678", "phone_number":"11912341234", "email":"[email protected]", "mcc":"1234", "threeds_payment_link_authentication": "1", "automatic_threeds_minimum_value" : "9999999", "automatic_threeds_maximum_value" : "100000", "automatic_antifraud_minimum_value" : "0", "automatic_antifraud_maximum_value" : "99999", "antifraud_over_threeds" : "false", "transactional_urls":{ "status":"https://www.testeloja.com/status", "authenticity":"https://www.testeloja.com/autent", "hash":"https://www.testeloja.com/hash" }, "return_urls":{ "success":"https://www.testeloja.com/sucesso", "failure":"https://www.testeloja.com/fracasso", "cancel":"https://www.testeloja.com/cancel" }, "permissions":{ "payment":"true", "pre_authorization":"false", "recharge":"false", "risk_analysis":"true", "schedule":"true", "iata":"false", "card_store":"false", "payment_link":"true" }, "establishments":[ { "code":"00000000123", "routing_id":"1125", "subacquirer_group_id":"123456" }, { "code":"00000000321", "routing_id":"1005" } ], "authorizers":[ { "id":"1", "routing_id":"1125", "min_installments_amount":"100", "max_installments_without_interest":"1", "max_installments_with_interest":"12", "enable_subacquirer_group":"true", "acquirer_merchant_id": "12345", "cvv_mandatory":"true" }, { "id":"2", "routing_id":"1005", "min_installments_amount":"100", "max_installments_without_interest":"1", "max_installments_with_interest":"12", "enable_subacquirer_group":"false", "acquirer_merchant_id": "11111" } ]

}

Response:

{
  "id": "qereIoinsd3d",
  "key": "9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
  "response_code": "0",
  "response_message": "OK",
  "authorizer_response_code": "0",
  "authorizer_response_message": "OK"
}

Request parameters

The table below describes the parameters of the merchant creation service:

Parameter	Description	Format	Mandatory
`{id}`	Code of the merchant to be created. Sent in the URL.	< 15 AN	YES
`fantasy_name`	Fantasy name of the merchant.	< 250 AN	NO
`corporate_name`	Corporate name of the merchant.	< 250 AN	NO
`merchant_status`	Merchant's current status. Can take the following values: `A` = Active `I` = Inactive	= 1 AN	NO
`domain`	Domain (site) of the merchant.	< 65 AN	NO
`cnpj`	CNPJ or CPF of the merchant. Numbers only.	< 14 N	NO
`address`	Address of the merchant.	< 30 AN	NO
`city`	City of the merchant.	< 13 AN	NO
`state`	State of the merchant (abbreviation).	= 2 AN	NO
`zip_code`	Zip code of the merchant.	< 9 AN	NO
`phone_number`	Phone number of the merchant.	< 30 AN	NO
`email`	E-mail address of the merchant.	< 100 AN	NO
`mcc`	Merchant Category Code.	= 4 N	NO
`threeds_payment_link_authentication`	Default authentication type that will be displayed when generating the payment link. `0` = No authentication `1` = Enable the use of 3DS. But if the 3DS server does not support the flag or fails to perform authentication, payment will be denied. `2` = Enable the use of 3DS. However, if the 3DS server does not support the flag, it does not do authentication with 3DS server. If the flag is supported and authentication is denied, the payment will be denied. `3` = Enable the use of 3DS. However, even if authentication fails, payment will not be denied in authentication.	= 1 N	NO
`automatic_threeds_minimum_value`	Minimum value in cents for the 3DS to be automatically enabled. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_threeds_maximum_value`	Maximum value in cents for the 3DS to be automatically enabled. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_antifraud_minimum_value`	Minimum value in cents for the Anti-Fraud to be automatically enabled. It will only be possible to edit this value if Anti-Fraud is pre-configured. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_antifraud_maximum_value`	Maximum value in cents for the Anti-Fraud to be automatically enabled. It will only be possible to edit this value if Anti-Fraud is pre-configured. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`antifraud_over_threeds`	Flag that turns on the functionality to activate the anti-fraud automatically in case of error or denied authentication using the 3DS Server integrated with Payment Online	< 5 AN	NO
soft_descriptor	Submerchant data.
`id`	Submerchant ID	< 22 AN	NO
`country`	Submerchant country. ISO 3166-1 numeric code.	= 3 N	NO
`fantasy_name`	Submerchant fantasy name	< 22 AN	NO
subacquirer_group	Subacquirer group data.
`create`	Flag indicating whether the subacquirer group should be created	< 5 T/F	NO
`id`	Subacquirer group ID	< 6 AN	NO
`cnpj`	Subacquirer group CNPJ	= 14 N	YES, if the field `subacquirer_group.create` is `true`
establishments	Data of the establishments to be created on SiTef.
`code`	Establishment code (logical number) to be created on SiTef	= 11 N	NO
`routing_id`	Acquirer/routing ID on Carat Portal	< 4 N	NO
`subacquirer_group_id`	Subacquirer group ID. Should be sent in case the establishment must be created for the group instead of the merchant.	= 6 N	NO
`extra_data`	Additional establishment information	< 32 AN	NO
transactional_urls	URLs used on transactional flows.
`status`	URL for receiving status notifications.	< 500 AN	NO
`authenticity`	URL for receiving authenticity POSTs.	< 500 AN	NO
`hash`	URL for receiving stored card hash/token.	< 500 AN	NO
return_urls	HTML payment return URLs.
`success`	Success return URL.	< 500 AN	NO
`failure`	Failure return URL.	< 500 AN	NO
`cancel`	Cancel return URL.	< 500 AN	NO
permissions	Transactional permissions to be attributed to the merchant. Send the value `true` to enable the desired functionality.
`payment`	Payment permission.	< 5 AN	NO
`pre_authorization`	Pre-authorization permission.	< 5 AN	NO
`recharge`	Recharge permission.	< 5 AN	NO
`risk_analysis`	Risk analysis permission.	< 5 AN	NO
`schedule`	Schedule permission.	< 5 AN	NO
`iata`	IATA permission.	< 5 AN	NO
`card_store`	Card store permission.	< 5 AN	NO
`payment_link`	Payment link permission.	< 5 AN	NO
authorizers[]	Authorizers to be registered to the merchant.
`id`	Authorizer ID on Carat Portal. Learn more.	< 4 N	YES
`routing_id`	Routing/acquirer ID on Carat Portal. Learn more.	< 4 N	YES
`status`	Send `A` to activate or `I` to inactivate the authorizer.	< 1 AN	NO
`min_installments_amount`	Minimum installment amount for HTML transactions. Default value: `1000`	< 12 N	NO
`max_installments_without_interest`	Maximum installments without interest for HTML transactions. Default value: `3`	< 2 N	NO
`max_installments_with_interest`	Maximum installments with interest for HTML transactions. Default value: `12`	< 2 N	NO
`enable_subacquirer_group`	Enable subacquirer group usage for the authorizer. Send `true` to enable or `false` to disable.	< 5 T/F	NO
`acquirer_merchant_id`	Merchant identifier designated by the acquirer. If `threeds_enabled = true` you must send at least one `acquirer_merchant_id`	< 35 AN	NO
`cvv_mandatory`	Enable mandatory card security code field. Send `true` to enable or `false` to disable.	< 5 T/F	NO
authorizers[].parameters	Specific routing parameters. Learn more.

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the merchant editing service:

Parameter	Description	Format
`response_code`	Carat Portal response code. Any code different from `0` means failure.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN
`authorizer_response_code`	Authorizer response code.	< 4 N
`authorizer_response_message`	Authorizer response message.	< 500 AN
`id`	Code of the created merchant.	< 15 AN
`key`	Key of the created merchant.	< 80 AN

Token Creation Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-token

import ResponseCodes from './codigos-de-resposta.md';
import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';

Consuming the token generation service is mandatory for creating or editing a merchant. As a result from this operation, the virtual store will obtain a token on their authenticity URL, which will be necessary for the next step of the flow.

Call details

Resource: /v1/token/merchants
HTTP Method: POST
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES

Example

Request:

To use this example, don't forget to define the variable {{url}} with the value

curl 
--request POST "https://{{url}}/e-sitef/api/v1/token/merchants"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Authenticity POST:

To use this example, don't forget to define the variable {{url}} with the value

curl  -X POST \
  https://urlDeAutenticidadeDaLoja.com.br \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'cache-control: no-cache' \
  -d 'token=1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr

Response:

{
   "response_code":0,
   "response_message":"OK. Transaction successful."
}

Authenticity POST parameters

The table below describes the parameters sent by Carat Portal on the authenticity POST:

Parameter	Description	Format
`token`	Token to be sent in the next step of the flow.	= 66 AN

Carat Portal can also send new parameters without previous warning, which means that the merchant's application must be prepared to receive additional fields and simply ignore them.

Attention: It's essential that the site hosted on the merchant's Authenticity URL receives the token and responds with HTTP 200, as this is how Carat Portal considers it a successful POST.

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the token creation service:

Parameter	Description	Format
`response_code`	Carat Portal response code. Any code different from `0`(zero) means failure. Learn more.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN

REST Merchants Registration

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-codigos-da-api

API codes

Code	Description
`0`	OK. Transaction successful.
`1`	invalid file format
`2`	null sitef_merchantid value
`3`	null sitef_ip value
`4`	null currency value
`5`	null sitef_port value
`6`	null version value
`7`	invalid currency value
`8`	invalid payment_type for merchant
`9`	invalid id value
`10`	invalid email value
`11`	null email value
`12`	null id value
`13`	invalid address value
`14`	null fantasy_name value
`15`	invalid fantasy_name value
`16`	null corporate_name value
`17`	invalid corporate_name value
`18`	null domain value
`19`	invalid domain value
`20`	null cnpj value
`21`	invalid cnpj value
`22`	invalid state value
`23`	invalid phone_number value
`24`	invalid transactional_urls.hash value
`25`	invalid transactional_urls.authenticity value
`26`	invalid return_urls.cancel value
`27`	invalid return_urls.failure value
`28`	invalid return_urls.success value
`29`	invalid transactional_urls.status value
`30`	invalid zip_code value
`31`	invalid city value
`32`	null authorizers.routing_id value
`33`	invalid authorizers.routing_id value
`34`	null authorizers.id value
`35`	invalid authorizers.id value
`36`	null authorizers.parameters.name value
`37`	invalid authorizers.parameters.name value
`38`	null authorizers.parameters.value value
`39`	invalid authorizers.parameters.value value
`40`	null request
`41`	authorizer not allowed for NPC
`42`	null cpf value
`43`	invalid cpf value
`44`	invalid cpf/cnpj value
`45`	null login value
`45`	invalid login value
`47`	login already exists
`48`	null name value
`49`	invalid name value
`50`	null access_type value
`51`	invalid access_type value
`52`	null profile value
`53`	invalid profile value
`54`	null admin_profile value
`55`	invalid admin_profile value
`56`	null prefix value
`57`	invalid prefix value
`58`	null merchant_id value
`59`	invalid merchant_id value
`60`	null merchant_key value
`61`	invalid merchant_key value
`62`	null group_id value
`63`	invalid group_id value
`64`	merchant registration not allowed
`65`	merchant permissions not allowed
`66`	invalid authorizers.min_installments_amount value
`67`	invalid authorizers.max_installments_with_interest value
`68`	invalid authorizers.max_installments_without_interest value
`69`	invalid authorizers.status value
`70`	merchant group registration error
`71`	no permission to access this merchant
`72`	invalid sitef_merchant_id value
`75`	acquirer registration error
`76`	parent merchant registration error
`77`	client communication error
`78`	null establishments.code value
`79`	null establishments.routing_id value
`80`	invalid establishments.routing_id value
`81`	null subacquirer_group.id value
`82`	null subacquirer_group.cnpj value
`83`	no permission to get merchant status
`85`	invalid merchant_status value
`86`	invalid page value
`87`	invalid limit value
`88`	Signature or Token must not be null
`89`	`mcc` cannot be null when threeds_enabled is true
`90`	invalid `threeds_enabled`
`91`	invalid `threeds_payment_link_authentication`
`93`	at least one `acquirer_merchant_id` must be registered when threeds_enabled is true
`94`	invalid `acquirer_merchant_id`
`95`	3DS registration error
`96`	invalid `automatic_antifraud_minimum_value`
`97`	invalid `automatic_antifraud_maximum_value`
`98`	invalid `automatic_threeds_maximum_value`
`99`	invalid `automatic_threeds_minimum_value`
`100`	invalid `antifraud_over_threeds`
`188`	Expired token
`189`	Token already used
`199`	Invalid token
`200`	Token signature error
`500`	error persisting data
`1000`	Unexpected error! Please contact e-SiTef Support Team.
`1026`	Merchant has no registered public key
`1027`	Signature validation error
`1028`	Signature payload validation error
`1029`	Signature expired
`1032`	Result not found

Merchant Status Query Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-consulta-status

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';
import ResponseCodes from './codigos-de-resposta.md';

After getting the token or signature in the previous step, the virtual store can consume the status merchant query service.

Attention:

The merchant requesting the status must have permission to do so and must be at the same group in which is the requested merchant. For more info on enabling Merchant Status Query Permission, contact our support team.

Call details

Resource: /v1/merchants/status/{id}
HTTP Method: GET
Request format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	NO
`token`	Token obtained on the token creation service. Learn more.	= 66 AN	NO
`Authorization`	The merchant's signature must be sent in the format `Bearer {signature}`. Exemple: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`.	< 2000 AN	NO

Example

Response:

{
  "response_code": "0",
  "response_message": "OK",
  "merchant_status": "A"
}

Response parameters

Parameter	Description	Format
`response_code`	Carat Portal response code.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN
`merchant_status`	Status of the consulted merchant. `A = ACTIVE; I = INACTIVE`	1 A

Quick Start

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-quickstart

This guide presents the merchant registration process, using Carat Portal's REST interface.

What you'll need

A merchant registered on Carat Portal with permission for consuming this API
A tool capable of making HTTP calls, such as Postman, REST Client or cURL
An application capable of receiving POST HTTPS calls, if the authenticity post is used

Authenticity POST x signature

Carat Portal has two methods of merchant authentication on the REST merchant creation, editing and query interface: authenticity POST or signature.

In the authenticity POST method, Carat Portal will send the data of the newly created recharge transaction to the registered authenticity URL of the merchant.

In the signature method, the merchant must have a public RSA encryption key registered on Carat Portal and prepare a JWT signature (JSON Web Tokens) to be sent in the Authorization header. Learn more.

Creating a token

Request method: POST

URL: https:///e-sitef/api/v1/token/merchants

Headers:

Content-Type: application/json
merchant_id: {your merchant id}
merchant_key: {your merchant key}

Request:

To use this example, don't forget to define the variable {{url}} to the value

curl
--request POST "https://{{url}}/e-sitef/api/v1/token/merchants"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Receiving the authenticity POST:

@RestController
public class MyAuthenticityController {
}

Response:

{
  "response_code": 0,
  "response_message": "OK. Transaction successful."
}

Learn more about this service.

Creating the merchant

Request method: POST

URL: https:///e-sitef/api/v1/merchants

Fill the <id> field in the URL above with the ID of the merchant to be created.

Headers:

Content-Type: application/json
merchant_id: {your merchant id}
merchant_key: {your merchant key}
token: {token obtained in the previous step}
Authorization: {signature if JWT signature is used}

Request:

To use this example, don't forget to define the variable {{url}} to the value

{
  "fantasy_name": "Teste de Loja",
  "corporate_name": "Testes de Loja Ltda.",
  "soft_descriptor": {
    "fantasy_name": "Sub-comércio da Loja",
    "country": "BR",
    "mcc": "1234",
    "id": "123456"
  },
  "subacquirer_group": {
    "create": "true",
    "id": "123456",
    "cnpj": "12345678901234"
  },
  "domain": "www.testeloja.com",
  "cnpj": "123123123123",
  "address": "Rua do Teste, 123",
  "city": "São Teste",
  "state": "SP",
  "zip_code": "12345678",
  "phone_number": "11912341234",
  "email": "[email protected]",
  "transactional_urls": {
    "status": "https://www.testeloja.com/status",
    "authenticity": "https://www.testeloja.com/autent",
    "hash": "https://www.testeloja.com/hash"
  },
  "return_urls": {
    "success": "https://www.testeloja.com/sucesso",
    "failure": "https://www.testeloja.com/fracasso",
    "cancel": "https://www.testeloja.com/cancel"
  },
  "permissions": {
    "payment": "true",
    "pre_authorization": "false",
    "recharge": "false",
    "risk_analysis": "true",
    "schedule": "true",
    "iata": "false",
    "card_store": "false",
    "payment_link": "true"
  },
  "establishments": [
    {
      "code": "00000000123",
      "routing_id": "1125",
      "subacquirer_group_id": "123456"
    },
    {
      "code": "00000000321",
      "routing_id": "1005"
    }
  ],
  "authorizers": [
    {
      "id": "1",
      "routing_id": "1125",
      "min_installments_amount": "100",
      "max_installments_without_interest": "1",
      "max_installments_with_interest": "12",
      "enable_subacquirer_group": "true"
    },
    {
      "id": "2",
      "routing_id": "201",
      "min_installments_amount": "100",
      "max_installments_without_interest": "1",
      "max_installments_with_interest": "12",
      "parameters": {
        "merchantId": "8h37e9e23oe",
        "merchantKey": "b9f374t5983t745f873tb45f93b4f2293b485ft34"
      }
    }
  ]
}

curl
--request POST "https://{{url}}/e-sitef/api/v1/merchants"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--data-binary
{
   "cnpj":"123123123123",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "soft_descriptor":{
      "fantasy_name":"Sub-comércio da Loja",
      "country":"BR",
      "mcc":"1234",
      "id":"123456"
   },
   "subacquirer_group":{
      "create":"true",
      "id":"123456",
      "cnpj":"12345678901234"
   },
   "domain":"www.testeloja.com",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "establishments":[
      {
         "code":"00000000123",
         "routing_id":"1125",
         "subacquirer_group_id":"123456"
      },
      {
         "code":"00000000321",
         "routing_id":"1005"
      }
   ],
   "authorizers":[
      {
         "id":"1",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"true"
      },
      {
         "id":"2",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
         }
      }
   ]
}
--verbose

curl
--request POST "https://{{url}}/e-sitef/api/v1/merchants"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--data-binary
{
   "cnpj":"123123123123",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "soft_descriptor":{
      "fantasy_name":"Sub-comércio da Loja",
      "country":"BR",
      "mcc":"1234",
      "id":"123456"
   },
   "subacquirer_group":{
      "create":"true",
      "id":"123456",
      "cnpj":"12345678901234"
   },
   "domain":"www.testeloja.com",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "establishments":[
      {
         "code":"00000000123",
         "routing_id":"1125",
         "subacquirer_group_id":"123456"
      },
      {
         "code":"00000000321",
         "routing_id":"1005"
      }
   ],
   "authorizers":[
      {
         "id":"1",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"true"
      },
      {
         "id":"2",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
         }
      }
   ]
}
--verbose

Response:

{
  "id": "qereIoinsd3d",
  "key": "9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
  "response_code": "0",
  "response_message": "OK"
}

Learn more about this service.

Merchant Creation Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-criacao

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';
import ResponseCodes from './codigos-de-resposta.md';

After getting the token or signature in the previous step, the virtual store must send the data of the merchant to be created on Carat Portal and SiTef (if necessary).

Attention:

Registered merchants will have the same personalization settings as the registering merchant, such as their logo, CSS and JS.

Call details

Resource: /v1/merchants
HTTP Method: POST
Request format: JSON
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained in the previous step. Learn more.	= 66 AN	NO
`Content-Type`	Must be sent with the value `application/json`.	= 15 AN	YES

Attention:

During merchant registration, the settings related to the use of 3DS and anti-fraud are automatically replicated from the registering merchant.

Example

Request:

To use this example, don't forget to define the variable {{url}} with the value

curl 
--request POST "https://{{url}}/e-sitef/api/v1/merchants"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--data-binary
{
   "cnpj":"123123123123",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "mcc":"1234",
   "threeds_enabled":"true",
   "threeds_payment_link_authentication":"1",
   "automatic_threeds_minimum_value" : "30000",
   "automatic_threeds_maximum_value" : "99999",
   "automatic_antifraud_minimum_value" :  "100000",
   "automatic_antifraud_maximum_value" : "999999",
   "antifraud_over_threeds" : "false",
   "soft_descriptor":{
      "fantasy_name":"Sub-comércio da Loja",
      "country":"BR",
      "id":"123456"
   },
   "subacquirer_group":{
      "create":"true",
      "id":"123456",
      "cnpj":"12345678901234"
   },
   "domain":"www.testeloja.com",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "establishments":[
      {
         "code":"00000000123",
         "routing_id":"1125",
         "subacquirer_group_id":"123456"
      },
      {
         "code":"00000000321",
         "routing_id":"1005"
      }
   ],
   "authorizers":[
      {
         "id":"1",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"true",
         "acquirer_merchant_id":"11111",
         "cvv_mandatory":"true"
      },
      {
         "id":"2",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
          },
         "acquirer_merchant_id":"22222"
      }
   ]
}
--verbose

To use this example, don't forget to define the variable {{url}} with the value

curl 
--request POST "https://{{url}}/e-sitef/api/v1/merchants"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer YYYYYYY"
--data-binary
{
   "cnpj":"123123123123",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "mcc":"1234",
   "threeds_enabled":"true",
   "threeds_payment_link_authentication":"1",
   "automatic_threeds_minimum_value" : "30000",
   "automatic_threeds_maximum_value" : "99999",
   "automatic_antifraud_minimum_value" :  "100000",
   "automatic_antifraud_maximum_value" : "999999",
   "antifraud_over_threeds" : "false",
   "soft_descriptor":{
      "fantasy_name":"Sub-comércio da Loja",
      "country":"BR",
      "id":"123456"
   },
   "subacquirer_group":{
      "create":"true",
      "id":"123456",
      "cnpj":"12345678901234"
   },
   "domain":"www.testeloja.com",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "establishments":[
      {
         "code":"00000000123",
         "routing_id":"1125",
         "subacquirer_group_id":"123456"
      },
      {
         "code":"00000000321",
         "routing_id":"1005"
      }
   ],
   "authorizers":[
      {
         "id":"1",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "enable_subacquirer_group":"true",
         "acquirer_merchant_id":"11111",
         "cvv_mandatory":"true",
      },
      {
         "id":"2",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
         },
         "acquirer_merchant_id":"22222"
      }
   ]
}
--verbose

Response:

{
  "id": "qereIoinsd3d",
  "key": "9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
  "response_code": "0",
  "response_message": "OK",
  "authorizer_response_code": "0",
  "authorizer_response_message": "OK"
}

Request parameters

The table below describes the parameters of the merchant creation service:

Parameter	Description	Format	Mandatory
`cnpj`	CNPJ or CPF of the merchant. Alphanumeric.	=A 14 AN	YES
`force_sitef_merchant_creation`	If the value `true` is informed, it activates the alternative generation of company numbers, allowing more than one company to be registered for the same CNPJ/CPF. If not informed, it assumes `false`, that is, it uses the standard algorithm for generating company code, which guarantees only one company for each CNPJ/CPF. Send `true` or `false`.	< 5 AN	NO
`fantasy_name`	Fantasy name of the merchant.	< 250 AN	YES
`corporate_name`	Corporate name of the merchant.	< 250 AN	YES
`domain`	Domain (site) of the merchant.	< 65 AN	NO
`address`	Address of the merchant.	< 30 AN	NO
`city`	City of the merchant.	< 13 AN	NO
`state`	State of the merchant (abbreviation).	= 2 AN	NO
`zip_code`	Zip code of the merchant.	< 9 AN	NO
`phone_number`	Phone number of the merchant.	< 30 AN	NO
`email`	E-mail address of the merchant.	< 100 AN	NO
`mcc`	Merchant Category Code - code indicating the category of the establishment (used on the anti-fraud registration). If the field `threeds_enabled=true`, `mcc` becomes mandatory. If the value's length has less than 4 digits, zeros will be added to the left of the number until it reaches size 4.	= 4 N	NO
`threeds_enabled`	Enables the merchant to integrate with the 3DS Server and performing the necessary configurations on Carat Portal, send `true` or `false`. Learn more.	< 5 AN	NO
`threeds_payment_link_authentication`	Default authentication type that will be displayed when generating the payment link. `0` = No authentication `1` = Enable the use of 3DS and if the 3DS server does not support the flag or fails to authenticate, payment will be denied. `2` = Enable the use of 3DS only with flags supported by the 3DS server. If the 3DS server does not support the flag, authentication is not performed. If the flag is supported and authentication is denied, payment will be denied. `3` = Enable the use of 3DS and if authentication fails, payment will not be denied in authentication.	= 1 N	NO
`automatic_threeds_minimum_value`	Indicates the minimum amount in cents for a transaction to automatically enable the 3DS. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_threeds_maximum_value`	Indicates the maximum amount in cents for a transaction to automatically enable the 3DS. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_antifraud_minimum_value`	Indicates the minimum amount in cents for a transaction to automatically enable Anti-Fraud. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`automatic_antifraud_maximum_value`	Indicates the maximum amount in cents of a transaction to automatically enable Anti-Fraud. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used.	< 12 N	NO
`antifraud_over_threeds`	Flag that turns on the functionality to activate the anti-fraud automatically in case of error or denied authentication using the 3DS Server integrated with Payment Online	< 5 AN	NO
soft_descriptor	Submerchant data.
`id`	Submerchant ID	< 22 AN	NO
`country`	Submerchant country. ISO 3166-1 numeric code.	= 3 N	NO
`fantasy_name`	Submerchant fantasy name	< 22 AN	NO
subacquirer_group	Subacquirer group data.
`create`	Flag indicating whether the subacquirer group should be created	< 5 T/F	NO
`id`	Subacquirer group ID	< 6 AN	NO
`cnpj`	Subacquirer group CNPJ	= 14 AN	YES, if the field `subacquirer_group.create` is `true`
establishments	Data of the establishments to be created on SiTef.
`code`	Establishment code (logical number) to be created on SiTef	= 11 N	NO
`routing_id`	Acquirer/routing ID on Carat Portal	< 4 N	NO
`subacquirer_group_id`	Subacquirer group ID. Should be sent in case the establishment must be created for the group instead of the merchant.	= 6 N	NO
`extra_data`	Additional establishment information	< 32 AN	NO
transactional_urls	URLs used on transactional flows.
`status`	URL for receiving status notifications.	< 500 AN	NO
`authenticity`	URL for receiving authenticity POSTs.	< 500 AN	NO
`hash`	URL for receiving stored card hash/token.	< 500 AN	NO
return_urls	HTML payment return URLs.
`success`	Success return URL.	< 500 AN	NO
`failure`	Failure return URL.	< 500 AN	NO
`cancel`	Cancel return URL.	< 500 AN	NO
permissions	Transactional permissions to be attributed to the merchant. Send the value `true` to enable the desired functionality.
`payment`	Payment permission.	< 5 AN	NO
`pre_authorization`	Pre-authorization permission.	< 5 AN	NO
`recharge`	Recharge permission.	< 5 AN	NO
`risk_analysis`	Risk analysis permission.	< 5 AN	NO
`schedule`	Schedule permission.	< 5 AN	NO
`iata`	IATA permission.	< 5 AN	NO
`card_store`	Card store permission.	< 5 AN	NO
`payment_link`	Payment link permission.	< 5 AN	NO
authorizers[]	Authorizers to be registered to the merchant. The presence of a SiTef routing indicates that a SiTef merchant must also be created.
`id`	Authorizer ID on Carat Portal. Learn more.	< 4 N	YES
`routing_id`	Routing/acquirer ID on Carat Portal. Learn more.	< 4 N	YES
`min_installments_amount`	Minimum installment amount for HTML transactions. Default value: `1000`	< 12 N	NO
`max_installments_without_interest`	Maximum installments without interest for HTML transactions. Default value: `3`	< 2 N	NO
`max_installments_with_interest`	Maximum installments with interest for HTML transactions. Default value: `12`	< 2 N	NO
`enable_subacquirer_group`	Enable subacquirer group usage for the authorizer. Send `true` to enable or `false` to disable.	< 5 T/F	NO
`acquirer_merchant_id`	Merchant identifier designated by the acquirer. If `threeds_enabled = true` you must send at least one `acquirer_merchant_id`	< 35 AN	NO
`cvv_mandatory`	Enable mandatory card security code field. Send `true` to enable or `false` to disable.	< 5 T/F	NO
authorizers[].parameters	Specific routing parameters. Learn more.

Routing/acquirer codes

ID	Routing
`1229`	BIN via SiTef

ID	Routing
`201`	Cielo e-Commerce
`202`	e-Rede.REST
`407`	Getnet WS
`408`	Global Payments WS
`409`	Stone WS
`1005`	Rede via SiTef
`1181`	Getnet Lac via SiTef
`1125`	Cielo via SiTef
`1206`	Global Payments via SiTef
`1229`	BIN via SiTef
`1265`	Stone via SiTef
`1296`	Safra via SiTef

Specific routing parameters

These parameters must be sent in the authorizer[].parameters field depending on the chosen acquirer.

Cielo e-Commerce

Parameter	Description
authorizers[].parameters	Specific routing parameters.
`merchantId`	Merchant identification on Cielo.
`merchantKey`	Merchant key on Cielo.

Getnet WS

Parameter	Description
authorizers[].parameters	Specific routing parameters.
`username`	Access user.
`password`	Access password.
`merchantID`	EC code registered on Getnet.
`terminal`	Terminal identification.
`subMerchantId`	Submerchant ID.

Global Payments WS

Parameter	Description
authorizers[].parameters	Specific routing parameters.
`merchantCode`	Establishment number defined by Global Payments.
`secretKey`	Merchant secret key on Global Payments.
`terminal`	Terminal number that will be defined by Global Payments.

Stone WS

Parameter	Description
authorizers[].parameters	Specific routing parameters.
`salesAffiliationKey`	Merchant identification key on Stone.
`subAdquirenciaHabilitada`	Send `true` to enable sub-acquiring or `false` otherwise.

BIN via SiTef

Parameter	Description	Format
authorizers[].parameters	Specific routing parameters.
`subacquirerMerchantId`	Submerchant code.
establishments	Data of the establishments to be created on SiTef.
`establishments.extra_data`	Terminal code. Mandatory field for integration with the Bin acquirer.	= 8 AN

e-Rede

Parameter	Description
authorizers[].parameters	Specific routing parameters.
`filiation`	Merchant filiation code on e-Rede.
`token`	Merchant public key on e-Rede.

Check more details about "e-Rede routing")

Registering merchants with anti-fraud

It's possible to automatically register new merchants with the following anti-fraud solutions: Fraud, ClearSale, CyberSource and Konduto. To do it, the merchant must contact the risk analysis institution and request the necessary credentials. Then, the merchant must pass a set of MCC's (Merchant Category Code) for each registered credential to the Carat Portal Production team, which will register this data. These MCC's will be mapped for each credential and these values will be used on the registration of each merchant. Once this pre-registration is done, it will be possible to perform the anti-fraud registration automatically using the merchant creation API.

It's possible to automatically register new merchants with the following anti-fraud solutions: Antifraude Fiserv. To do it, the merchant must contact the risk analysis institution and request the necessary credentials. Then, the merchant must pass a set of MCC's (Merchant Category Code) for each registered credential to the Carat Portal Production team, which will register this data. These MCC's will be mapped for each credential and these values will be used on the registration of each merchant. Once this pre-registration is done, it will be possible to perform the anti-fraud registration automatically using the merchant creation API.

Attention:

It's required to activate the anti-fraud permission (risk_analysis) on the merchant creation call.

Only the merchant creation service performs the automatic anti-fraud registration.

Response parameters

If successful, the HTTP response code will be 201. Any other code must be interpreted as an error. The table below describes the response parameters of the merchant creation service:

Parameter	Description	Format
`response_code`	Carat Portal response code. Any code different from `0` means failure.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN
`authorizer_response_code`	Authorizer response code.	< 4 N
`authorizer_response_message`	Authorizer response message.	< 500 AN
`id`	Code of the created merchant. Automatically generated (note: uppercase and lowercase characters are differentiated in the system).	< 15 AN
`key`	Key of the created merchant.	< 80 AN

List Merchants Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-listagem

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';

After getting the token or signature in the previous step, the virtual store may consume the store list service

Call details

Resource: /v1/merchants
HTTP Method: GET
Request format: query string
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained on the token creation service. Learn more.	= 66 AN	NO
`Authorization`	The merchant's signature must be sent in the format `Bearer {signature}`. Exemple: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`.	< 2000 AN	NO

Example

Store list using token

Request:

To use this example, don't forget to define the variable {{url}} to the value

curl
--request GET "https://{{url}}/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--verbose

Store list using signature

Request:

To use this example, don't forget to define the variable {{url}} to the value

curl
--request GET "https://{{url}}/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer YYYYYYY"
--verbose

Response:

{
  "response_code": "0",
  "response_message": "OK",
  "current_page": "0",
  "total_pages": "1",
  "count": "1",
  "merchants": [
    {
      "id": "qereIoinsd3d",
      "merchant_status": "A",
      "fantasy_name": "Teste de Loja",
      "corporate_name": "Testes de Loja Ltda.",
      "cnpj": "12345678901234"
    }
  ]
}

Request parameters

Parâmetro	Descrição	Formato	Obrigatório
`cnpj`	CNPJ of the merchant. Alphanumeric.	= 14 AN	Não
`merchant_status`	Store status. Can assume the following values: `A` = Active `I` = Inactive	= 1 N	Não
`page`	List Page. The first page value is `0`. If not set, defaults to `0`.	< 4 N	Não
`limit`	Max records by page. If not set, defaults to 100.	< 3 N	Não

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error.

Parameter	Description	Format
`response_code`	Carat Portal response code. Any code different from `0` means failure.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN
`current_page`	Current records page.	< 4 N
`total_pages`	Total pages number.	< 4 N
`count`	Total register count.	< 4 N
merchants[]	Store list returned by the query.
`id`	Code of the created merchant.	< 15 AN
`merchant_status`	Store status. Can assume the following values: `A` = Active `I` = Inactive	= 1 N
`fantasy_name`	Fantasy name of the merchant.	< 250 AN
`corporate_name`	Corporate name of the merchant.	< 250 AN
`cnpj`	CNPJ of the merchant. Alphanumeric.	= 14 AN

Merchant Query Service

Source: https://docs.apis-fiserv.com/latam/docs/cadastro-lojas-ws-consulta

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';
import ResponseCodes from './codigos-de-resposta.md';

After getting the token or signature in the previous step, the virtual store can consume the merchant query service.

Call details

Resource: /v1/merchants/{id}
HTTP Method: GET
Request format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained on the token creation service. Learn more.	= 66 AN	NO
`Authorization`	The merchant's signature must be sent in the format `Bearer {signature}`. Exemple: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`.	< 2000 AN	NO

Example

Response:

{
   "response_code":"0",
   "response_message":"OK",
   "id":"qereIoinsd3d",
   "key":"9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "sitef_merchant_id":"00000000",
   "merchant_status":"A",
   "domain":"www.testeloja.com",
   "cnpj":"123123123123",
   "address":"Rua do Teste, 123",
   "city":"São Teste",
   "state":"SP",
   "zip_code":"12345678",
   "phone_number":"11912341234",
   "email":"[email protected]",
   "mcc": "1234",
   "threeds_enabled": "true",
   "threeds_payment_link_authentication": "1",
   "automatic_threeds_minimum_value" : "9999999",
   "automatic_threeds_maximum_value" : "100000",
   "automatic_antifraud_minimum_value" :  "0",
   "automatic_antifraud_maximum_value" : "99999",
   "antifraud_over_threeds" : "false",
   "transactional_urls":{
      "status":"https://www.testeloja.com/status",
      "authenticity":"https://www.testeloja.com/autent",
      "hash":"https://www.testeloja.com/hash"
   },
   "return_urls":{
      "success":"https://www.testeloja.com/sucesso",
      "failure":"https://www.testeloja.com/fracasso",
      "cancel":"https://www.testeloja.com/cancel"
   },
   "permissions":{
      "payment":"true",
      "pre_authorization":"false",
      "recharge":"false",
      "risk_analysis":"true",
      "schedule":"true",
      "iata":"false",
      "card_store":"false",
      "payment_link":"true"
   },
   "authorizers":[
      {
         "id":"1",
         "status":"I",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "acquirer_merchant_id": "12345",
         "cvv_mandatory":"true"
         
      },
      {
         "id":"2",
         "status":"A",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "acquirer_merchant_id": "111111"
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
         }
      }
   ]
}

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error

Parameter	Description	Format
`response_code`	Carat Portal response code.	< 4 N
`response_message`	Carat Portal response message.	< 500 AN
`id`	Code of the created merchant.	< 15 AN
`key`	Key of the created merchant.	< 80 AN
`fantasy_name`	Fantasy name of the merchant.	< 250 AN
`corporate_name`	Corporate name of the merchant.	< 250 AN
`merchant_status`	Merchant's current status. Can take the following values: `A` = Active `I` = Inactive	= 1 AN
`sitef_merchant_id`	Merchant ID at SiTef.	8 N
`domain`	Domain (site) of the merchant.	< 65 AN
`cnpj`	CNPJ or CPF of the merchant. Alphanumeric.	= 14 AN
`address`	Address of the merchant.	< 30 AN
`city`	City of the merchant.	< 13 AN
`state`	State of the merchant (abbreviation).	= 2 AN
`zip_code`	Zip code of the merchant.	< 9 AN
`phone_number`	Phone number of the merchant.	< 30 AN
`email`	E-mail address of the merchant.	< 100 AN
transactional_urls	URLs used on transactional flows.
`mcc`	Merchant Category Code - code indicating the category of the establishment	= 4 N
`threeds_enabled`	Displays whether the merchant is ready for authentication using 3DS Server. Learn more.	< 5 AN	NO
`threeds_payment_link_authentication`	Default authentication type that will be displayed when generating the payment link. `0` = No authentication `1` = Enable the use of 3DS and if the 3DS server does not support the flag or fails to authenticate, payment will be denied. `2` = Enable the use of 3DS only with flags supported by the 3DS server. If the 3DS server does not support the flag, authentication is not performed. If the flag is supported and authentication is denied, payment will be denied. `3` = Enable the use of 3DS and if authentication fails, payment will not be denied in authentication.	= 1 N	NO
`automatic_threeds_minimum_value`	Minimum value in cents for the 3DS to be automatically enabled. If the minimum value is setted in and the maximum is not, the minimum value is assumed to be enabled to virtually infinity.	< 12 N
`automatic_threeds_maximum_value`	Maximum value in cents for the 3DS to be automatically enabled. If the maximum value is setted and the minimum is not, it is assumed enabled from the minimum value zero to the maximum value.	< 12 N
`automatic_antifraud_minimum_value`	Minimum value in cents for the Anti-Fraud to be automatically enabled. If the minimum value is filled and the maximum is not, it is assumed enabled from the minimum value to virtually infinite.	< 12 N
`automatic_antifraud_maximum_value`	Maximum value in cents tfor the Anti-Fraud to be automatically enabled. If the maximum value is filled and the minimum is not, it is assumed enabled from the minimum value of zero to the maximum value.	< 12 N
`antifraud_over_threeds`	Flag that indicates the functionality to activate the anti-fraud automatically in case of error or denied authentication using the 3DS Server integrated with Payment Online	< 5 AN	NO
`status`	URL for receiving status notifications.	< 500 AN
`authenticity`	URL for receiving authenticity POSTs.	< 500 AN
`hash`	URL for receiving stored card hash/token.	< 500 AN
return_urls	HTML payment return URLs.
`success`	Success return URL.	< 500 AN
`failure`	Failure return URL.	< 500 AN
`cancel`	Cancel return URL.	< 500 AN
permissions	Transactional permissions to be attributed to the merchant. Send the value `true` to enable the desired functionality.
`payment`	Payment permission.	< 5 AN
`pre_authorization`	Pre-authorization permission.	< 5 AN
`recharge`	Recharge permission.	< 5 AN
`risk_analysis`	Risk analysis permission.	< 5 AN
`schedule`	Schedule permission.	< 5 AN
`iata`	IATA permission.	< 5 AN
`card_store`	Card store permission.	< 5 AN
`payment_link`	Payment link permission.	< 5 AN
authorizers[]	Authorizers to be registered to the merchant.
`id`	Authorizer ID on Carat Portal. Learn more.	< 4 N
`routing_id`	Routing/acquirer ID on Carat Portal. Learn more.	< 4 N
`min_installments_amount`	Minimum installment amount for HTML transactions. Default value: `1000`	< 12 N
`max_installments_without_interest`	Maximum installments without interest for HTML transactions. Default value: `3`	< 2 N
`max_installments_with_interest`	Maximum installments with interest for HTML transactions. Default value: `12`	< 2 N
`acquirer_merchant_id`	Merchant identifier designated by the acquirer.	< 35 AN	NO
`cvv_mandatory`	Enable mandatory card security code field.	< 5 AN
authorizers[].parameters	Specific routing parameters. Learn more.

Updated 7 days ago

Did this page help you?