e-SiTef

e-SiTef

  • Portal do Desenvolvedor
  • Fale Conosco
  • English

›REST Merchants Registration

REST Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Payment effectuation service
  • Payment confirmation service
  • Transaction status query
  • Multiple transactions status query
  • Card query service
  • Payment with multiple payment methods service
  • Payment with multiple payment methods confirmation service
  • External origin payment confirmation service

REST Store

  • Overview

REST Cancel

  • Flow
  • Quick start
  • Cancel via host
  • Cancel external origin
  • Cancel creation service
  • Cancel service

REST Pre-Authorization

  • Overview
  • Quick start
  • Pre-Authorization Creation Service
  • Pre-Authorization effectuation service
  • Pre-Authorization Status Query
  • Pre-Authorization Editing Service
  • Pre-Authorization Editing External Origin Service
  • Pre-Authorization Increment Service
  • Card Query Service
  • Pre-Authorization Capture Service
  • Pre-Authorization Capture External Origin Service

REST Schedule

  • Overview
  • Quick start
  • Transaction creation service
  • Schedule activation service
  • Execution of the scheduled payments
  • Schedule editing flow
  • Quick start: schedule editing
  • Schedule editing creation service
  • Schedule editing service

REST Recharge

  • Overview
  • Quick start
  • Recharge creation service
  • List dealers service
  • List branch data service
  • Recharge effectuation service
  • Recharge confirmation service
  • Recharge query service

HTML Payment

  • Overview
  • Quick start
  • Initializing a payment transaction
  • Status notification
  • Transaction status query
  • Payment with card storage
  • Pages Customization
  • Payment link
  • Split Payment
  • Payment with multiple payment methods
  • 3DS 2.0 Integration

HTML Pre-Authorization

  • Overview

HTML Recharge

  • Overview
  • Quick start
  • Initializing a Recharge transaction

REST Generic Operations

  • Overview
  • Token creation service
  • Generic operation service

JavaScript Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's payment page
  • Transaction query service

JavaScript Store

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's page

Merchant Web Page

  • Introduction
  • Access to web page
  • Two-Factor Authentication
  • User Configuration
  • Configure Authorizers
  • Transaction Report
  • Daily Summary Report
  • Store Report
  • Recharge Report
  • Analytical Report
  • Transaction Cancellation
  • Schedule
  • Configure Risk Analysis
  • Configure Order Authorizers
  • Users Administration
  • Generate Payment Link

Retry

  • Overview
  • Flow
  • Retry and Schedule

SiTef Routings

  • Bradescard
  • Cetelem
  • GetnetLac
  • Orbitall
  • Vero
  • Bin
  • Sipag

Non SiTef Routings

  • Banco do Brasil
  • Banrisul Vero
  • Cielo e-Commerce
  • EPX
  • e.Rede Rest
  • Fepas HUB
  • Getnet WS
  • GlobalPayments WS
  • IPG
  • Itaú Shopline
  • Mercado Pago
  • PagSeguro
  • PayPal
  • SafraPay
  • Stone WS

Digital Wallet

  • Overview
  • VEE Digital Wallet via CardSE
  • Pix via CardSE
  • Google Pay
  • Visa Checkout
  • Masterpass
  • Samsung Pay
  • Apple Pay
  • Configuration for Digital Wallets

Anti-Fraud Integration

  • Overview
  • Risk analysis service on the HTML Interface
  • Risk analysis response
  • Manual review flow
  • Fraud notification service
  • ClearSale
  • CyberSource
  • Konduto
  • Fraud Detect

General Information

  • Authorizers
  • Digital Certificates
  • API codes
  • Soft Descriptor
  • Signature authentication

Batch Registrations

  • Batch Store Registration
  • Batch Routing Configuration

REST Merchants Registration

  • Overview
  • Quick start
  • Token creation service
  • Merchant creation service
  • Merchant editing service
  • Merchant query service
  • Merchant status query service
  • List merchants service
  • API codes

3DS Server

  • Overview
  • Quick start
  • Transaction creation service
  • Authentication service
  • Transaction query service
  • Challenge messages
  • Decoupled notification
  • Initiating a 3DS Method
  • API codes

Merchant creation service

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

Call details

  • Resource: /v1/merchants
  • HTTP Method: POST
  • Request format: JSON
  • Response format: JSON
  • Header parameters:
ParameterDescriptionFormatMandatory
merchant_idMerchant code on e-SiTef. The production and certification codes will be different.< 15 ANYES
merchant_keyMerchant authentication key on e-SiTef. The production and certification keys will be different.< 80 ANYES
tokenToken obtained in the previous step. Learn more.= 66 ANNO
Content-TypeMust be sent with the value application/json.= 15 ANYES

Example

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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",
   "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":"testeloja@teste.com",
   "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://esitef-homologacao.softwareexpress.com.br/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",
   "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":"testeloja@teste.com",
   "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", 
   "authorizer_response_code":"0", 
   "authorizer_response_message":"OK"
}

Request parameters

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

ParameterDescriptionFormatMandatory
cnpjCNPJ or CPF of the merchant. Numbers only.< 14 NYES
fantasy_nameFantasy name of the merchant.< 250 ANYES
corporate_nameCorporate name of the merchant.< 250 ANYES
domainDomain (site) of the merchant.< 65 ANNO
addressAddress of the merchant.< 30 ANNO
cityCity of the merchant.< 13 ANNO
stateState of the merchant (abbreviation).= 2 ANNO
zip_codeZip code of the merchant.< 9 ANNO
phone_numberPhone number of the merchant.< 30 ANNO
emailE-mail address of the merchant.< 100 ANNO
mccMerchant Category Code - code indicating the category of the establishment (used on the anti-fraud registration)= 4 NNO
soft_descriptor Submerchant data.
idSubmerchant ID< 22 ANNO
countrySubmerchant country. ISO 3166-1 numeric code.= 3 NNO
fantasy_nameSubmerchant fantasy name< 22 ANNO
subacquirer_group Subacquirer group data.
createFlag indicating whether the subacquirer group should be created< 5 T/FNO
idSubacquirer group ID< 6 ANNO
cnpjSubacquirer group CNPJ= 14 NYES, if the field subacquirer_group
.create is true
establishments Data of the establishments to be created on SiTef.
codeEstablishment code (logical number) to be created on SiTef= 11 NNO
routing_idAcquirer/routing ID on e-SiTef< 4 NNO
subacquirer_group_idSubacquirer group ID. Should be sent in case the establishment must be created for the group instead of the merchant.= 6 NNO
extra_dataAdditional establishment information< 32 ANNÃO
transactional_urls URLs used on transactional flows.
statusURL for receiving status notifications.< 500 ANNO
authenticityURL for receiving authenticity POSTs.< 500 ANNO
hashURL for receiving stored card hash/token.< 500 ANNO
return_urls HTML payment return URLs.
successSuccess return URL.< 500 ANNO
failureFailure return URL.< 500 ANNO
cancelCancel return URL.< 500 ANNO
permissions Transactional permissions to be attributed to the merchant. Send the value true to enable the desired functionality.
paymentPayment permission.< 5 ANNO
pre_authorizationPre-authorization permission.< 5 ANNO
rechargeRecharge permission.< 5 ANNO
risk_analysisRisk analysis permission.< 5 ANNO
scheduleSchedule permission.< 5 ANNO
iataIATA permission.< 5 ANNO
card_storeCard store permission.< 5 ANNO
payment_linkPayment link permission.< 5 ANNO
authorizers[] Authorizers to be registered to the merchant. The presence of a SiTef routing indicates that a SiTef merchant must also be created.
idAuthorizer ID on e-SiTef. Learn more.< 4 NYES
routing_idRouting/acquirer ID on e-SiTef. Learn more.< 4 NYES
min_installments_amountMinimum installment amount for HTML transactions. Default value: 1000< 12 NNO
max_installments_without_interestMaximum installments without interest for HTML transactions. Default value: 3< 2 NNO
max_installments_with_interestMaximum installments with interest for HTML transactions. Default value: 12< 2 NNO
enable_subacquirer_groupEnable subacquirer group usage for the authorizer. Send true to enable or false to disable.< 5 T/FNO
authorizers[].parameters Specific routing parameters. Learn more.

Routing/acquirer codes

IDRouting
201Cielo e-Commerce
407Getnet WS
408Global Payments WS
409Stone WS
1005Rede via SiTef
1181Getnet Lac via SiTef
1125Cielo via SiTef
1200e-Rede
1206Global Payments via SiTef
1229BIN via SiTef
1265Stone via SiTef
1296Safra via SiTef

Specific routing parameters

Cielo e-Commerce

ParameterDescription
authorizers[].parameters Specific routing parameters.
merchantIdMerchant identification on Cielo.
merchantKeyMerchant key on Cielo.

Getnet WS

ParameterDescription
authorizers[].parameters Specific routing parameters.
usernameAccess user.
passwordAccess password.
merchantIDEC code registered on Getnet.
terminalTerminal identification.
subMerchantIdSubmerchant ID.

Global Payments WS

ParameterDescription
authorizers[].parameters Specific routing parameters.
merchantCodeEstablishment number defined by Global Payments.
secretKeyMerchant secret key on Global Payments.
terminalTerminal number that will be defined by Global Payments.

Stone WS

ParameterDescription
authorizers[].parameters Specific routing parameters.
salesAffiliationKeyMerchant identification key on Stone.
subAdquirenciaHabilitadaSend true to enable sub-acquiring or false otherwise.

BIN via SiTef

ParameterDescriptionFormat
authorizers[].parameters Specific routing parameters.
subacquirerMerchantId Submerchant code.
establishments Data of the establishments to be created on SiTef.
establishments.extra_dataTerminal code. Mandatory field for integration with the Bin acquirer.= 8 AN

e-Rede

ParameterDescription
authorizers[].parameters Specific routing parameters.
filiacaoMerchant filiation code on e-Rede.
senhaMerchant public key on e-Rede.

Registering merchants with anti-fraud

It's possible to automatically register new merchants with the following anti-fraud solutions: Fraud Detect, 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 e-SiTef 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:

ParameterDescriptionFormat
response_codee-SiTef response code. Any code different from 0 means failure.< 4 N
response_messagee-SiTef response message.< 500 AN
authorizer_response_codeAuthorizer response code.< 4 N
authorizer_response_messageAuthorizer response message.< 500 AN
idCode of the created merchant. Automatically generated (note: uppercase and lowercase characters are differentiated in the system).< 15 AN
keyKey of the created merchant.< 80 AN
← Token creation serviceMerchant editing service →
  • Call details
  • Example
  • Request parameters
    • Routing/acquirer codes
    • Specific routing parameters
    • Registering merchants with anti-fraud
  • Response parameters
e-SiTef
Relacionamento com o cliente
+55 (11) 3170-5300+55 (11) 4766-8000comercial@softwareexpress.com.br
Acessos
Portal do DesenvolvedorPortal e-SiTefVersão para impressão
Copyright © 2021 Software Express Informática Ltda - Todos os direitos reservados