Batch Routing Configuration

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:

  • 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
FieldDescriptionFormatRequired
field1CNPJ (or merchant code, or merchantId). No formatting (numbers only).< 15 ANYes
field2Issuer/Authorizer code. Check the codes in the Issuer/Authorizer Codes section.< 15 NYes
field3Routing/Acquirer Network code. Check the codes in the Routing/Acquirer Network Codes section.< 15 NYes
paramter1, paramter2, paramterNAdditional parameters that may vary according the acquirer network/routing.-No

Issuer/Authorizer Codes#

Issuer/AuthorizerCode
VISA1
MASTERCARD2
AMERICAN EXPRESS (AMEX)3
HIPERCARD5
AURA6
CABAL12
VALECARD28
SOROCRED29
DINERS33
ELO41
GOODCARD42
JCB43
DISCOVER44
CHINA UNION PAY45
CREDZ46
AGIPLAN47
VEROCHEQUE48
PAN122
AVISTA CREDITO192

Routing/Acquirer Network Codes#

Routing/Acquirer NetworkCode
Cielo via SiTef1125
Rede (old Redecard) via SiTef1005
GetNet via SiTef1181
e-Rede1200
Stone WS409

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:

FieldDescription
salesAffiliationKeyIdentification of the merchant on the Stone Acquirer.
subAdquirenciaHabilitadaAllowed 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/AuthorizerAcquirer/Routing
VisaRede (old Redecard)
MastercardRede (old Redecard)
HiperRede (old Redecard)
AmexRede (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 via Stone WS, keeping the Amex and Hiper routings unchanged.

Merchants 11111111111111 and 22222222222222 after the update:

Issuer/AuthorizerAcquirer/Routing
VisaCielo
MastercardStone WS
HiperRede (old Redecard) -> Unchanged
AmexRede (old Redecard) -> Unchanged

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/AuthorizerAcquirer/Routing
VisaCielo
MastercardRede (old Redecard) -> Unchanged
HiperRede (old Redecard) -> Unchanged
AmexStone 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.