Batch Routing Configuration
#
OverviewThe 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
.
#
PrerequisitesAs 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 NetworksThe routings supported for batch routing configuration are:
- Cielo via SiTef
- Rede via SiTef
- GetNet via SiTef
- Stone WS
#
Import File FormatATTENTION: 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):
Field | Description | Format | Required |
---|---|---|---|
field1 | CNPJ (or merchant code , or merchantId ). No formatting (numbers only). | < 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 CodesIssuer/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 CodesRouting/Acquirer Network | Code |
---|---|
Cielo via SiTef | 1125 |
Rede (old Redecard) via SiTef | 1005 |
GetNet via SiTef | 1181 |
e-Rede | 1200 |
Stone WS | 409 |
#
Additional ParametersSome 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.
Additional parameters are not required, but if not sent, the parameters will be set to a default value.
#
Stone WSThe 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#
ExampleAt 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
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
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 |
Amex | Stone WS (with subacquirer functionality) |
The final file to be generated will be as shown below:
ATTENTION: If the field 4 is empty, don't forget to put a semicolon (;) at the end of the line.