Serviço de edição de loja

Após obter o token ou assinatura na etapa anterior, a loja virtual pode consumir o serviço de edição de loja. Para isso, apenas os dados a serem alterados devem ser enviados.

Detalhes da chamada#

  • Recurso: /v1/merchants/{id}
  • Método HTTP: PUT
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Pagamento Online. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Pagamento Online. As chaves de produção e certificação serão diferentes.< 80 ANSIM
tokenToken obtido no serviço de criação de token. Saiba mais.= 66 ANNÃO
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM
AuthorizationDeve ser enviada a assinatura de autenticação da loja no formato Bearer {assinatura}. Exemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg.< 2000 ANNÃO

Exemplo utilizando token#

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/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":"testeloja@teste.com",
"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"
}
]
}
--verbose

Exemplo utilizando assinatura#

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/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":"testeloja@teste.com",
"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"
}
]
}
--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 edição de loja:

ParâmetroDescriçãoFormatoObrigatório
{id}Código da loja a ser editada. Presente na própria URL.< 15 ANSIM
fantasy_nameNome fantasia da loja.< 250 ANNÃO
corporate_nameRazão social da loja.< 250 ANNÃO
merchant_statusStatus da loja. Pode assumir os seguintes valores: A = Ativa I = Inativa= 1 ANNÃO
domainDomínio (site) da loja.< 500 ANNÃO
cnpjCNPJ ou CPF da loja. Apenas números.< 14 NNÃO
addressEndereço da loja.< 200 ANNÃO
cityCidade da loja.< 50 ANNÃO
stateEstado da loja (sigla).= 2 ANNÃO
zip_codeCEP da loja.< 9 ANNÃO
phone_numberTelefone da loja.< 30 ANNÃO
emailEndereço de e-mail da loja.< 100 ANNÃO
mccMerchant Category Code.= 4 NNÃO
threeds_payment_link_authenticationTipo de autenticação padrão que será exibida na geração de link de pagamento. Saiba mais.
  • 0 = Sem autenticação
  • 1 = Habilitar o uso de 3DS. Mas, se o 3DS server não suporta a bandeira ou falhe para realizar a autenticação, o pagamento será negado.
  • 2 = Habilitar o uso de 3DS. Porém, se o 3DS server não suporta a bandeira, não faz autenticação com 3DS server. Se a bandeira for suportada e a autenticação negar, o pagamento será negado
  • 3 = Habilitar o uso de 3DS. Entretanto, mesmo se a autenticação falhar, o pagamento não será negado na autenticação.
= 1 NNÃO
automatic_threeds_minimum_valueValor mínimo em centavos para que seja habilitado automaticamente o 3DS. Atenção: intervalos que possibilitem a utilização de 3ds e antifraude juntos não devem ser utilizados.< 12 NNÃO
automatic_threeds_maximum_valueValor máximo em centavos para que seja habilitado automaticamente o 3DS. Atenção: intervalos que possibilitem a utilização de 3ds e antifraude juntos não devem ser utilizados.< 12 NNÃO
automatic_antifraud_minimum_valueValor mínimo em centavos para que seja habilitado automaticamente o Antifraude. Só será possível editar este valor caso o Antifraude esteja pré configurado. Atenção: intervalos que possibilitem a utilização de 3ds e antifraude juntos não devem ser utilizados.< 12 NNÃO
automatic_antifraud_maximum_valueValor máximo em centavos para que seja habilitado automaticamente o Antifraude. Só será possível editar este valor caso o Antifraude esteja pré configurado. Atenção: intervalos que possibilitem a utilização de 3ds e antifraude juntos não devem ser utilizados.< 12 NNÃO
antifraud_over_threedsFlag que liga a funcionalidade de ativar o antifraude automaticamente em caso de erro ou autenticação negada utilizando o 3DS Server integrado com o Pagamento Online< 5 ANNÃO
subacquirer_groupDados de grupo de subadquirência.
createFlag que indica se devemos criar o grupo de subadquirência< 5 T/FNÃO
idID do grupo de subadquirência< 6 ANNÃO
cnpjCNPJ do grupo de sub-adquirência= 14 NSIM, caso o campo subacquirer_group.create seja true
establishmentsDados dos estabelecimentos a serem cadastrados no SiTef.
codeCódigo do estabelecimento (número lógico) a ser cadastrado no SiTef< 32 ANNÃO
routing_idID do roteamento (tipo de pagamento do Pagamento Online)< 4 NNÃO
subacquirer_group_idID 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_dataInformação adicional do estabelecimento< 32 ANNÃO
transactional_urlsURLs utilizadas em fluxos transacionais.
statusURL para recebimento de avisos de status.< 500 ANNÃO
authenticityURL para recebimento de POSTs de autenticidade.< 500 ANNÃO
hashURL para recebimento de hash/token de cartão armazenado.< 500 ANNÃO
return_urlsURLs de retorno de pagamento HTML.
successURL de retorno de sucesso.< 500 ANNÃO
failureURL de retorno de fracasso.< 500 ANNÃO
cancelURL de retorno de cancelamento.< 500 ANNÃO
permissionsPermissões transacionais a serem designadas para a loja. Enviar o valor true para habilitar a funcionalidade em questão.
paymentPermissão para pagamento.< 5 ANNÃO
pre_authorizationPermissão para pré-autorização.< 5 ANNÃO
rechargePermissão para recarga.< 5 ANNÃO
risk_analysisPermissão para análise de risco.< 5 ANNÃO
schedulePermissão para agendamento.< 5 ANNÃO
iataPermissão para IATA.< 5 ANNÃO
card_storePermissão para armazenamento de cartão.< 5 ANNÃO
payment_linkPermissão para pagamento via link.< 5 ANNÃO
authorizers[]Autorizadoras a serem cadastradas para a loja.
idID da autorizadora no Pagamento Online. Saiba mais.< 4 NSIM
routing_idID do roteamento/adquirente no Pagamento Online. Saiba mais.< 4 NSIM
statusEnviar A para ativar ou I para inativar a autorizadora.< 1 ANNÃO
min_installments_amountValor mínimo para parcelamento em transações HTML. Valor padrão: 1000< 12 NNÃO
max_installments_without_interestNúmero máximo de parcelas sem juros em transações HTML. Valor padrão: 3< 2 NNÃO
max_installments_with_interestNúmero máximo de parcelas com juros em transações HTML. Valor padrão: 12< 2 NNÃO
enable_subacquirer_groupHabilitar bandeira para uso de grupo de sub-adquirência. Enviar true para habilitar ou false para desabilitar.< 5 T/FNÃO
acquirer_merchant_idIdentificador da loja designado pelo adquirente. Caso threeds_enabled = true deve-se enviar pelo menos um acquirer_merchant_id< 35 ANNÃO
authorizers[].parametersParâmetros específicos do roteamento. Saiba mais.

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 200. 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 edição de loja:

ParâmetroDescriçãoFormato
response_codeCódigo de resposta do Pagamento Online. Qualquer código diferente de 0 significa falha.< 4 N
response_messageMensagem de resposta do Pagamento Online.< 500 AN
authorizer_response_codeAuthorizer response code.< 4 N
authorizer_response_messageAuthorizer response message.< 500 AN
idCódigo da loja alterada.< 15 AN
keyChave da loja alterada.< 80 AN