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â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
AuthorizationDeve ser enviada a assinatura de autenticação da loja no formato Bearer {assinatura}. Exemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg.< 2000 ANNÃ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",
"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"
},
{
"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âmetroDescriçãoFormato
response_codeCódigo de resposta do Pagamento Online.< 4 N
response_messageMensagem de resposta do Pagamento Online.< 500 AN
idCódigo da loja consultada.< 15 AN
keyChave da loja consultada.< 80 AN
fantasy_nameNome fantasia da loja.< 250 AN
corporate_nameRazão social da loja.< 250 AN
merchant_statusStatus da loja. Pode assumir os seguintes valores: A = Ativa I = Inativa= 1 AN
sitef_merchant_idCódigo de empresa da loja.8 N
domainDomínio (site) da loja.< 65 AN
cnpjCNPJ ou CPF da loja. Apenas números.< 14 N
addressEndereço da loja.< 30 AN
cityCidade da loja.< 13 AN
stateEstado da loja (sigla).= 2 AN
zip_codeCEP da loja.< 9 AN
phone_numberTelefone da loja.< 30 AN
emailEndereço de e-mail da loja.< 100 AN
transactional_urlsURLs utilizadas em fluxos transacionais.
mccMerchant Category Code - código que indica a categoria do estabelecimento= 4 N
threeds_enabledExibe se a loja está preparada para a autenticação utilizando o 3DS Server. Saiba mais.= 5 N
threeds_payment_link_authenticationTipo 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_valueValor mínimo em centavos para que seja habilitado automaticamente o 3DS.< 12 N
automatic_threeds_maximum_valueValor máximo em centavos para que seja habilitado automaticamente o 3DS.< 12 N
automatic_antifraud_minimum_valueValor mínimo em centavos para que seja habilitado automaticamente o Antifraude.< 12 N
automatic_antifraud_maximum_valueValor máximo em centavos para que seja habilitado automaticamente o Antifraude.< 12 N
antifraud_over_threedsFlag 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 Pagamento Online< 5 AN
statusURL para recebimento de avisos de status.< 500 AN
authenticityURL para recebimento de POSTs de autenticidade.< 500 AN
hashURL para recebimento de hash/token de cartão armazenado.< 500 AN
return_urlsURLs de retorno de pagamento HTML.
successURL de retorno de sucesso.< 500 AN
failureURL de retorno de fracasso.< 500 AN
cancelURL de retorno de cancelamento.< 500 AN
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 AN
pre_authorizationPermissão para pré-autorização.< 5 AN
rechargePermissão para recarga.< 5 AN
risk_analysisPermissão para análise de risco.< 5 AN
schedulePermissão para agendamento.< 5 AN
iataPermissão para IATA.< 5 AN
card_storePermissão para armazenamento de cartão.< 5 AN
payment_linkPermissão para pagamento via link.< 5 AN
authorizers[]Autorizadoras a serem cadastradas para a loja.
idID da autorizadora no Pagamento Online. Saiba mais.< 4 N
routing_idID do roteamento/adquirente no Pagamento Online. Saiba mais.< 4 N
min_installments_amountValor mínimo para parcelamento em transações HTML. Valor padrão: 1000< 12 N
max_installments_without_interestNúmero máximo de parcelas sem juros em transações HTML. Valor padrão: 3< 2 N
max_installments_with_interestNúmero máximo de parcelas com juros em transações HTML. Valor padrão: 12< 2 N
acquirer_merchant_idIdentificador da loja designado pelo adquirente.< 35 AN
authorizers[].parametersParâmetros específicos do roteamento. Saiba mais.