Após obter o token ou assinatura na etapa anterior, a loja virtual deve enviar os dados da loja a ser criada no e-SiTef e no SiTef (caso necessário).
Detalhes da chamada
Recurso: /v1/merchants
Método HTTP: POST
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:
Parâmetro Descrição Formato Obrigatório
merchant_id
Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes. < 15 ANSIM
merchant_key
Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes. < 80 ANSIM
token
Token obtido na etapa anterior, caso a autenticação seja via post de autenticidade Saiba mais. = 66 AN NÃO
Content-Type
Deve ser enviado com o valor application/json
. = 15 AN SIM
Authorization
Deve ser enviada a assinatura de autenticação da loja no formato Bearer {assinatura}
. Exemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg
. < 2000 ANNÃO
Exemplo utilizando token
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
Exemplo utilizando assinatura
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
Resposta:
{
"id" :"qereIoinsd3d" ,
"key" :"9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D" ,
"response_code" :"0" ,
"response_message" :"OK" ,
"authorizer_response_code" :"0" ,
"authorizer_response_message" :"OK"
}
Parâmetros de requisição
Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de criação de loja:
Parâmetro Descrição Formato Obrigatório
cnpj
CNPJ ou CPF da loja. Apenas números. < 14 NSIM
fantasy_name
Nome fantasia da loja. < 250 ANSIM
corporate_name
Razão social da loja. < 250 ANSIM
domain
Domínio (site) da loja. < 500 ANNÃO
address
Endereço da loja. < 200 ANNÃO
city
Cidade da loja. < 50 ANNÃO
state
Estado da loja (sigla). = 2 AN NÃO
zip_code
CEP da loja. < 9 ANNÃO
phone_number
Telefone da loja. < 30 ANNÃO
email
Endereço de e-mail da loja. < 100 ANNÃO
mcc
Merchant Category Code - código que indica a categoria do estabelecimento (utilizado no cadastro de antifraude ) = 4 N NÃO
soft_descriptor Dados do sub-comércio.
id
ID do sub-comércio. < 22 ANNÃO
country
País do sub-comércio. Código numérico ISO 3166-1. = 3 N NÃO
fantasy_name
Nome fantasia do sub-comércio < 22 ANNÃO
subacquirer_group Dados de grupo de subadquirência.
create
Flag que indica se devemos criar o grupo de subadquirência < 5 T/FNÃO
id
ID do grupo de subadquirência < 6 ANNÃO
cnpj
CNPJ do grupo de sub-adquirência = 14 N SIM, caso o campo subacquirer_group
.create
seja true
establishments Dados dos estabelecimentos a serem cadastrados no SiTef.
code
Código do estabelecimento (número lógico) a ser cadastrado no SiTef < 32 ANNÃO
routing_id
ID do roteamento (tipo de pagamento do e-SiTef) < 4 NNÃO
subacquirer_group_id
ID do grupo de sub-adquirência. Deve ser enviado caso esse estabelecimento deva ser cadastrado para o grupo ao invés da empresa. < 6 ANNÃO
extra_data
Informação adicional do estabelecimento < 32 ANNÃO
transactional_urls URLs utilizadas em fluxos transacionais.
status
URL para recebimento de avisos de status. < 500 ANNÃO
authenticity
URL para recebimento de POSTs de autenticidade. < 500 ANNÃO
hash
URL para recebimento de hash/token de cartão armazenado. < 500 ANNÃO
return_urls URLs de retorno de pagamento HTML.
success
URL de retorno de sucesso. < 500 ANNÃO
failure
URL de retorno de fracasso. < 500 ANNÃO
cancel
URL de retorno de cancelamento. < 500 ANNÃO
permissions Permissões transacionais a serem designadas para a loja. Enviar o valor true
para habilitar a funcionalidade em questão.
payment
Permissão para pagamento. < 5 ANNÃO
pre_authorization
Permissão para pré-autorização. < 5 ANNÃO
recharge
Permissão para recarga. < 5 ANNÃO
risk_analysis
Permissão para análise de risco. < 5 ANNÃO
schedule
Permissão para agendamento. < 5 ANNÃO
iata
Permissão para IATA. < 5 ANNÃO
card_store
Permissão para armazenamento de cartão. < 5 ANNÃO
payment_link
Permissão para pagamento via link. < 5 ANNÃO
authorizers[] Autorizadoras a serem cadastradas para a loja. A presença de um roteamento SiTef indica que deve ser criada uma empresa no SiTef.
id
ID da autorizadora no e-SiTef. Saiba mais. < 4 NSIM
routing_id
ID do roteamento/adquirente no e-SiTef. Saiba mais. < 4 NSIM
min_installments_amount
Valor mínimo para parcelamento em transações HTML. Valor padrão: 1000
< 12 NNÃO
max_installments_without_interest
Número máximo de parcelas sem juros em transações HTML. Valor padrão: 3
< 2 NNÃO
max_installments_with_interest
Número máximo de parcelas com juros em transações HTML. Valor padrão: 12
< 2 NNÃO
enable_subacquirer_group
Habilitar bandeira para uso de grupo de sub-adquirência. Enviar true
para habilitar ou false
para desabilitar. < 5 T/FNÃO
authorizers[].parameters Parâmetros específicos do roteamento. Saiba mais.
Códigos de roteamento/adquirente
ID Roteamento
201
Cielo e-Commerce
407
Getnet WS
408
Global Payments WS
409
Stone WS
1005
Rede via SiTef
1181
Getnet Lac via SiTef
1125
Cielo via SiTef
1200
e-Rede
1206
Global Payments via SiTef
1229
BIN via SiTef
1265
Stone via SiTef
1296
Safra via SiTef
Parâmetros específicos do roteamento
Cielo e-Commerce
Parâmetro Descrição
authorizers[].parameters Parâmetros específicos do roteamento.
merchantId
Identificação da loja na Cielo.
merchantKey
Chave da loja na Cielo.
Getnet WS
Parâmetro Descrição
authorizers[].parameters Parâmetros específicos do roteamento.
username
Usuário de acesso.
password
Senha de acesso.
merchantID
Código de EC cadastrado na GetnetWS.
terminal
Identificação do Terminal.
subMerchantId
ID do Sub comércio.
Global Payments WS
Parâmetro Descrição
authorizers[].parameters Parâmetros específicos do roteamento.
merchantCode
Número do estabelecimento definido pela Global Payments.
secretKey
Chave secreta do lojista na Global Payments.
terminal
Número de terminal que será definido pela Global Payments.
Stone WS
Parâmetro Descrição
authorizers[].parameters Parâmetros específicos do roteamento.
salesAffiliationKey
Chave de identificação da loja na Stone.
subAdquirenciaHabilitada
Enviar true
para habilitar sub-adquirência ou false
caso contrário.
BIN via SiTef
Parâmetro Descrição Formato
authorizers[].parameters Parâmetros específicos do roteamento.
subacquirerMerchantId
Código do sub-comércio.
establishments Dados dos estabelecimentos a serem cadastrados no SiTef.
extra_data
Código de terminal. Campo obrigatório para integração com a Bin. = 8 AN
e-Rede
Parâmetro Descrição
authorizers[].parameters Parâmetros específicos do roteamento.
filiacao
Código do filiação da loja na e-Rede.
senha
Chave pública da loja na e-Rede.
Cadastro de lojas com antifraude
É possível realizar o cadastro automático de novas lojas com as seguintes soluções de antifraude: Fraud Detect , ClearSale , CyberSource e Konduto . Para isso o lojista deve entrar em contato com a instituição de análise de risco e solicitar as credenciais necessárias . Em seguida, o lojista deve passar um conjunto de MCC's (Merchant Category Code) para cada credencial registrada para a equipe de Produção do e-SiTef, que fará o cadastro desses dados. Será feito um mapeamento desses conjuntos de MCC para cada credencial e esses valores serão utilizados no cadastro de cada loja. Uma vez feito esse pré-cadastro, será possível realizar o cadastro de antifraude de forma automática utilizando a API de criação de lojas.
Atenção:
É necessário ativar a permissão de anti fraude (risk_analysis
) no cadastro da loja.
Apenas a API de criação de lojas faz o cadastro de antifraude automático.
Parâmetros de resposta
Em caso de sucesso, o código de resposta HTTP será 201
. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de criação de loja:
Parâmetro Descrição Formato
response_code
Código de resposta do e-SiTef. Qualquer código diferente de 0
significa falha. < 4 N
response_message
Mensagem de resposta do e-SiTef. < 500 AN
authorizer_response_code
Código de resposta da autorizadora. < 4 N
authorizer_response_message
Mensagem de resposta da autorizadora. < 500 AN
id
Código da loja criada. Gerado automaticamente (obs: caracteres maiúsculas e minúsculas são diferenciados no sistema). < 15 AN
key
Chave da loja criada. < 80 AN