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:
ParameterDescriptionFormatMandatory
merchant_idMerchant code on Carat Portal. The production and certification codes will be different.< 15 ANYES
merchant_keyMerchant authentication key on Carat Portal. The production and certification keys will be different.< 80 ANYES
tokenToken obtained on the token creation service. Learn more.= 66 ANNO
AuthorizationThe merchant's signature must be sent in the format Bearer {signature}. Exemple: Bearer JHVGytfdgauygdauiw78264284527852897hagdg.< 2000 ANNO

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",
"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",
"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": "111111"
"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

ParameterDescriptionFormat
response_codeCarat Portal response code.< 4 N
response_messageCarat Portal response message.< 500 AN
idCode of the created merchant.< 15 AN
keyKey of the created merchant.< 80 AN
fantasy_nameFantasy name of the merchant.< 250 AN
corporate_nameCorporate name of the merchant.< 250 AN
merchant_statusMerchant's current status. Can take the following values: A = Active I = Inactive= 1 AN
sitef_merchant_idMerchant ID at SiTef.8 N
domainDomain (site) of the merchant.< 65 AN
cnpjCNPJ or CPF of the merchant. Numbers only.= 14 N
addressAddress of the merchant.< 30 AN
cityCity of the merchant.< 13 AN
stateState of the merchant (abbreviation).= 2 AN
zip_codeZip code of the merchant.< 9 AN
phone_numberPhone number of the merchant.< 30 AN
emailE-mail address of the merchant.< 100 AN
transactional_urlsURLs used on transactional flows.
mccMerchant Category Code - code indicating the category of the establishment= 4 N
threeds_enabledDisplays whether the merchant is ready for authentication using 3DS Server. Learn more.< 5 ANNO
threeds_payment_link_authenticationDefault authentication type that will be displayed when generating the payment link.
  • 0 = No authentication
  • 1 = Enable the use of 3DS and if the 3DS server does not support the flag or fails to authenticate, payment will be denied.
  • 2 = Enable the use of 3DS only with flags supported by the 3DS server. If the 3DS server does not support the flag, authentication is not performed. If the flag is supported and authentication is denied, payment will be denied.
  • 3 = Enable the use of 3DS and if authentication fails, payment will not be denied in authentication.
= 1 NNO
automatic_threeds_minimum_valueMinimum value in cents for the 3DS to be automatically enabled. If the minimum value is setted in and the maximum is not, the minimum value is assumed to be enabled to virtually infinity.< 12 N
automatic_threeds_maximum_valueMaximum value in cents for the 3DS to be automatically enabled. If the maximum value is setted and the minimum is not, it is assumed enabled from the minimum value zero to the maximum value.< 12 N
automatic_antifraud_minimum_valueMinimum value in cents for the Anti-Fraud to be automatically enabled. If the minimum value is filled and the maximum is not, it is assumed enabled from the minimum value to virtually infinite.< 12 N
automatic_antifraud_maximum_valueMaximum value in cents tfor the Anti-Fraud to be automatically enabled. If the maximum value is filled and the minimum is not, it is assumed enabled from the minimum value of zero to the maximum value.< 12 N
antifraud_over_threedsFlag that indicates the functionality to activate the anti-fraud automatically in case of error or denied authentication using the 3DS Server integrated with Payment Online< 5 ANNO
statusURL for receiving status notifications.< 500 AN
authenticityURL for receiving authenticity POSTs.< 500 AN
hashURL for receiving stored card hash/token.< 500 AN
return_urlsHTML payment return URLs.
successSuccess return URL.< 500 AN
failureFailure return URL.< 500 AN
cancelCancel return URL.< 500 AN
permissionsTransactional permissions to be attributed to the merchant. Send the value true to enable the desired functionality.
paymentPayment permission.< 5 AN
pre_authorizationPre-authorization permission.< 5 AN
rechargeRecharge permission.< 5 AN
risk_analysisRisk analysis permission.< 5 AN
scheduleSchedule permission.< 5 AN
iataIATA permission.< 5 AN
card_storeCard store permission.< 5 AN
payment_linkPayment link permission.< 5 AN
authorizers[]Authorizers to be registered to the merchant.
idAuthorizer ID on Carat Portal. Learn more.< 4 N
routing_idRouting/acquirer ID on Carat Portal. Learn more.< 4 N
min_installments_amountMinimum installment amount for HTML transactions. Default value: 1000< 12 N
max_installments_without_interestMaximum installments without interest for HTML transactions. Default value: 3< 2 N
max_installments_with_interestMaximum installments with interest for HTML transactions. Default value: 12< 2 N
acquirer_merchant_idMerchant identifier designated by the acquirer.< 35 ANNO
cvv_mandatoryEnable mandatory card security code field.< 5 AN
authorizers[].parametersSpecific routing parameters. Learn more.