Serviço de consulta de loja
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 JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NÃO |
Exemplo#
Resposta:
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.
| = 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. |