Serviço de consulta 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 consulta de loja.

Detalhes da chamada

Recurso: /v1/merchants/{id}
Método HTTP: GET
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
`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

Resposta:

{
   "response_code":"0", 
   "response_message":"OK", 
   "id":"qereIoinsd3d",
   "key":"9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "merchant_status":"A",
   "sitef_merchant_id":"00000000",
   "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_enabled": "true",
   "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"
   },
   "authorizers":[
      {
         "id":"1",
         "status":"I",
         "routing_id":"1125",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "acquirer_merchant_id": "12345",
         "cvv_mandatory":"true"
      },
      {
         "id":"2",
         "status":"A",
         "routing_id":"201",
         "min_installments_amount":"100",
         "max_installments_without_interest":"1",
         "max_installments_with_interest":"12",
         "acquirer_merchant_id": "11111",
         "parameters":{
            "merchantId":"8h37e9e23oe",
            "merchantKey":"b9f374t5983t745f873tb45f93b4f2293b485ft34"
         }
      }
   ]
}

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.

Parâmetro	Descrição	Formato
`response_code`	Código de resposta do Carat.	< 4 N
`response_message`	Mensagem de resposta do Carat.	< 500 AN
`id`	Código da loja consultada.	< 15 AN
`key`	Chave da loja consultada.	< 80 AN
`fantasy_name`	Nome fantasia da loja.	< 250 AN
`corporate_name`	Razão social da loja.	< 250 AN
`merchant_status`	Status da loja. Pode assumir os seguintes valores: `A` = Ativa `I` = Inativa	= 1 AN
`sitef_merchant_id`	Código de empresa da loja.	8 N
`domain`	Domínio (site) da loja.	< 65 AN
`cnpj`	CNPJ ou CPF da loja. Apenas números.	< 14 N
`address`	Endereço da loja.	< 30 AN
`city`	Cidade da loja.	< 13 AN
`state`	Estado da loja (sigla).	= 2 AN
`zip_code`	CEP da loja.	< 9 AN
`phone_number`	Telefone da loja.	< 30 AN
`email`	Endereço de e-mail da loja.	< 100 AN
`mcc`	Merchant Category Code - código que indica a categoria do estabelecimento	= 4 N
`threeds_enabled`	Exibe se a loja está preparada para a autenticação utilizando o 3DS Server. Saiba mais.	= 5 N
`threeds_payment_link_authentication`	Tipo de autenticação padrão que será exibida na geração de link de pagamento no portal do lojista. Saiba mais. `0` = Sem autenticação `1` = Habilitar o uso de 3DS e se o 3DS server não suportar a bandeira ou falhar para realizar a autenticação, o pagamento será negado. `2` = Habilitar o uso de 3DS apenas com bandeiras suportadas pelo 3DS server. Se o 3DS server não suportar a bandeira, a autenticação não é realizada.Caso a bandeira seja suportada e a autenticação seja negada, o pagamento será negado `3` = Habilitar o uso de 3DS e se autenticação falhar, o pagamento não será negado na autenticação.	= 1 N
`automatic_threeds_minimum_value`	Valor mínimo em centavos para que seja habilitado automaticamente o 3DS.	< 12 N
`automatic_threeds_maximum_value`	Valor máximo em centavos para que seja habilitado automaticamente o 3DS.	< 12 N
`automatic_antifraud_minimum_value`	Valor mínimo em centavos para que seja habilitado automaticamente o Antifraude.	< 12 N
`automatic_antifraud_maximum_value`	Valor máximo em centavos para que seja habilitado automaticamente o Antifraude.	< 12 N
`antifraud_over_threeds`	Flag que indica que está ligada 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
`version`	Versão em que a loja está configurada.	1 N
transactional_urls	URLs utilizadas em fluxos transacionais.
`status`	URL para recebimento de avisos de status.	< 500 AN
`authenticity`	URL para recebimento de POSTs de autenticidade.	< 500 AN
`hash`	URL para recebimento de hash/token de cartão armazenado.	< 500 AN
return_urls	URLs de retorno de pagamento HTML.
`success`	URL de retorno de sucesso.	< 500 AN
`failure`	URL de retorno de fracasso.	< 500 AN
`cancel`	URL de retorno de cancelamento.	< 500 AN
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
`pre_authorization`	Permissão para pré-autorização.	< 5 AN
`recharge`	Permissão para recarga.	< 5 AN
`risk_analysis`	Permissão para análise de risco.	< 5 AN
`schedule`	Permissão para agendamento.	< 5 AN
`iata`	Permissão para IATA.	< 5 AN
`card_store`	Permissão para armazenamento de cartão.	< 5 AN
`payment_link`	Permissão para pagamento via link.	< 5 AN
authorizers[]	Autorizadoras a serem cadastradas para a loja.
`id`	ID da autorizadora no Carat. Saiba mais.	< 4 N
`routing_id`	ID do roteamento/adquirente no Carat. Saiba mais.	< 4 N
`min_installments_amount`	Valor mínimo para parcelamento em transações HTML. Valor padrão: `1000`	< 12 N
`max_installments_without_interest`	Número máximo de parcelas sem juros em transações HTML. Valor padrão: `3`	< 2 N
`max_installments_with_interest`	Número máximo de parcelas com juros em transações HTML. Valor padrão: `12`	< 2 N
`acquirer_merchant_id`	Identificador da loja designado pelo adquirente.	< 35 AN
`cvv_mandatory`	Habilitar a obrigatoriedade do campo código de segurança do cartão.	< 5 AN
authorizers[].parameters	Parâmetros específicos do roteamento. Saiba mais.