Serviço de edição de loja

import ApiDoc from '../../src/components/api-doc/ApiDoc'; import ResponseCodes from './codigos-de-resposta.md';

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âmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`token`	Token obtido no serviço de criação de token. 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 {TOKEN_JWT_EXAMPLE}`.	< 2000 AN	NÃO

Exemplo utilizando token

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl
--request PUT "https://{{url}}/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",
   "version": "5",
   "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",
         "cvv_mandatory":"true"
      },
      {
         "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

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl
--request PUT "https://{{url}}/e-sitef/api/v1/merchants/qereIoinsd3d"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer {TOKEN_JWT_EXAMPLE}"
--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",
   "version": "5",
   "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",
         "cvv_mandatory":"true"
      },
      {
         "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âmetro	Descrição	Formato	Obrigatório
`{id}`	Código da loja a ser editada. Presente na própria URL.	< 15 AN	SIM
`fantasy_name`	Nome fantasia da loja.	< 250 AN	NÃO
`corporate_name`	Razão social da loja.	< 250 AN	NÃO
`merchant_status`	Status da loja. Pode assumir os seguintes valores: `A` = Ativa `I` = Inativa	= 1 AN	NÃO
`domain`	Domínio (site) da loja.	< 500 AN	NÃO
`cnpj`	CNPJ ou CPF da loja. Apenas números.	< 14 N	NÃO
`address`	Endereço da loja.	< 200 AN	NÃO
`city`	Cidade da loja.	< 50 AN	NÃO
`state`	Estado da loja (sigla).	= 2 AN	NÃO
`zip_code`	CEP da loja.	< 9 AN	NÃO
`phone_number`	Telefone da loja.	< 30 AN	NÃO
`email`	Endereço de e-mail da loja.	< 100 AN	NÃO
`mcc`	Merchant Category Code.	= 4 N	NÃO
`threeds_payment_link_authentication`	Tipo 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 N	NÃO
`automatic_threeds_minimum_value`	Valor 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 N	NÃO
`automatic_threeds_maximum_value`	Valor 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 N	NÃO
`automatic_antifraud_minimum_value`	Valor 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 N	NÃO
`automatic_antifraud_maximum_value`	Valor 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 N	NÃO
`antifraud_over_threeds`	Flag que liga a funcionalidade de ativar o antifraude automaticamente em caso de erro ou autenticação negada utilizando o 3DS Server integrado com o Carat	< 5 AN	NÃO
`version`	Especifica a versão em que a loja será configurada. Caso este campo não seja enviado, será atribuído o valor configurado na loja cadastradora. Somente são aceitos os valores `4` ou `5`	1 N	NÃO
subacquirer_group	Dados de grupo de subadquirência.
`create`	Flag que indica se devemos criar o grupo de subadquirência	< 5 T/F	NÃO
`id`	ID do grupo de subadquirência	< 6 AN	NÃ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 AN	NÃO
`routing_id`	ID do roteamento (tipo de pagamento do Carat)	< 4 N	NÃ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 AN	NÃO
`extra_data`	Informação adicional do estabelecimento	< 32 AN	NÃO
transactional_urls	URLs utilizadas em fluxos transacionais.
`status`	URL para recebimento de avisos de status.	< 500 AN	NÃO
`authenticity`	URL para recebimento de POSTs de autenticidade.	< 500 AN	NÃO
`hash`	URL para recebimento de hash/token de cartão armazenado.	< 500 AN	NÃO
return_urls	URLs de retorno de pagamento HTML.
`success`	URL de retorno de sucesso.	< 500 AN	NÃO
`failure`	URL de retorno de fracasso.	< 500 AN	NÃO
`cancel`	URL de retorno de cancelamento.	< 500 AN	NÃ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 AN	NÃO
`pre_authorization`	Permissão para pré-autorização.	< 5 AN	NÃO
`recharge`	Permissão para recarga.	< 5 AN	NÃO
`risk_analysis`	Permissão para análise de risco.	< 5 AN	NÃO
`schedule`	Permissão para agendamento.	< 5 AN	NÃO
`iata`	Permissão para IATA.	< 5 AN	NÃO
`card_store`	Permissão para armazenamento de cartão.	< 5 AN	NÃO
`payment_link`	Permissão para pagamento via link.	< 5 AN	NÃO
authorizers[]	Autorizadoras a serem cadastradas para a loja.
`id`	ID da autorizadora no Carat. Saiba mais.	< 4 N	SIM
`routing_id`	ID do roteamento/adquirente no Carat. Saiba mais.	< 4 N	SIM
`status`	Enviar `A` para ativar ou `I` para inativar a autorizadora.	< 1 AN	NÃO
`min_installments_amount`	Valor mínimo para parcelamento em transações HTML. Valor padrão: `1000`	< 12 N	NÃO
`max_installments_without_interest`	Número máximo de parcelas sem juros em transações HTML. Valor padrão: `3`	< 2 N	NÃO
`max_installments_with_interest`	Número máximo de parcelas com juros em transações HTML. Valor padrão: `12`	< 2 N	NÃO
`enable_subacquirer_group`	Habilitar bandeira para uso de grupo de sub-adquirência. Enviar `true` para habilitar ou `false` para desabilitar.	< 5 T/F	NÃO
`acquirer_merchant_id`	Identificador da loja designado pelo adquirente. Caso `threeds_enabled = true` deve-se enviar pelo menos um `acquirer_merchant_id`	< 35 AN	NÃO
`cvv_mandatory`	Habilitar a obrigatoriedade do campo código de segurança do cartão. Enviar `true` para habilitar ou `false` para desabilitar.	< 5 T/F	NÃO
authorizers[].parameters	Parâ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âmetro	Descrição	Formato
`response_code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha.	< 4 N
`response_message`	Mensagem de resposta do Carat.	< 500 AN
`authorizer_response_code`	Authorizer response code.	< 4 N
`authorizer_response_message`	Authorizer response message.	< 500 AN
`id`	Código da loja alterada.	< 15 AN
`key`	Chave da loja alterada.	< 80 AN