Merchant query service

After getting the token or signature in the previous step, the virtual store can consume the merchant query service.

Call details

Resource: /v1/merchants/{id}
HTTP Method: GET
Request format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on e-SiTef. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on e-SiTef. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained on the token creation service. Learn more.	= 66 AN	NO
`Authorization`	The merchant's signature must be sent in the format `Bearer {signature}`. Exemple: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`.	< 2000 AN	NO

Example

Response:

{
   "response_code":"0", 
   "response_message":"OK", 
   "id":"qereIoinsd3d",
   "key":"9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
   "fantasy_name":"Teste de Loja",
   "corporate_name":"Testes de Loja Ltda.",
   "sitef_merchant_id":"00000000",
   "merchant_status":"A",
   "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"
         }
      }
   ]
}

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error

Parameter	Description	Format
`response_code`	e-SiTef response code.	< 4 N
`response_message`	e-SiTef response message.	< 500 AN
`id`	Code of the created merchant.	< 15 AN
`key`	Key of the created merchant.	< 80 AN
`fantasy_name`	Fantasy name of the merchant.	< 250 AN
`corporate_name`	Corporate name of the merchant.	< 250 AN
`sitef_merchant_id`	Merchant ID at SiTef.	8 N
`merchant_status`	Merchant's current status. Can take the following values: `A` = Active `I` = Inactive	= 1 AN
`domain`	Domain (site) of the merchant.	< 65 AN
`cnpj`	CNPJ or CPF of the merchant. Numbers only.	< 14 N
`address`	Address of the merchant.	< 30 AN
`city`	City of the merchant.	< 13 AN
`state`	State of the merchant (abbreviation).	= 2 AN
`zip_code`	Zip code of the merchant.	< 9 AN
`phone_number`	Phone number of the merchant.	< 30 AN
`email`	E-mail address of the merchant.	< 100 AN
transactional_urls	URLs used on transactional flows.
`mcc`	Merchant Category Code - code indicating the category of the establishment	= 4 N
`status`	URL for receiving status notifications.	< 500 AN
`authenticity`	URL for receiving authenticity POSTs.	< 500 AN
`hash`	URL for receiving stored card hash/token.	< 500 AN
return_urls	HTML payment return URLs.
`success`	Success return URL.	< 500 AN
`failure`	Failure return URL.	< 500 AN
`cancel`	Cancel return URL.	< 500 AN
permissions	Transactional permissions to be attributed to the merchant. Send the value `true` to enable the desired functionality.
`payment`	Payment permission.	< 5 AN
`pre_authorization`	Pre-authorization permission.	< 5 AN
`recharge`	Recharge permission.	< 5 AN
`risk_analysis`	Risk analysis permission.	< 5 AN
`schedule`	Schedule permission.	< 5 AN
`iata`	IATA permission.	< 5 AN
`card_store`	Card store permission.	< 5 AN
`payment_link`	Payment link permission.	< 5 AN
authorizers[]	Authorizers to be registered to the merchant.
`id`	Authorizer ID on e-SiTef. Learn more.	< 4 N
`routing_id`	Routing/acquirer ID on e-SiTef. Learn more.	< 4 N
`min_installments_amount`	Minimum installment amount for HTML transactions. Default value: `1000`	< 12 N
`max_installments_without_interest`	Maximum installments without interest for HTML transactions. Default value: `3`	< 2 N
`max_installments_with_interest`	Maximum installments with interest for HTML transactions. Default value: `12`	< 2 N
authorizers[].parameters	Specific routing parameters. Learn more.