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 e-SiTef. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no e-SiTef. 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:
{
"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",
"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"
},
{
"id":"2",
"status":"A",
"routing_id":"201",
"min_installments_amount":"100",
"max_installments_without_interest":"1",
"max_installments_with_interest":"12",
"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 e-SiTef. | < 4 N | |
response_message | Mensagem de resposta do e-SiTef. | < 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:
| = 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 | |
transactional_urls | URLs utilizadas em fluxos transacionais. | ||
mcc | Merchant Category Code - código que indica a categoria do estabelecimento | = 4 N | |
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 e-SiTef. Saiba mais. | < 4 N | |
routing_id | ID do roteamento/adquirente no e-SiTef. 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 | |
authorizers[].parameters | Parâmetros específicos do roteamento. Saiba mais. |