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 Carat Portal. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on Carat Portal. 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 parameters#
If successful, the HTTP response code will be 200. Any other code must be interpreted as an error
| Parameter | Description | Format | |
|---|---|---|---|
response_code | Carat Portal response code. | < 4 N | |
response_message | Carat Portal 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 | |
merchant_status | Merchant's current status. Can take the following values: A = Active I = Inactive | = 1 AN | |
sitef_merchant_id | Merchant ID at SiTef. | 8 N | |
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 | |
threeds_enabled | Displays whether the merchant is ready for authentication using 3DS Server. Learn more. | < 5 AN | NO |
threeds_payment_link_authentication | Default authentication type that will be displayed when generating the payment link.
| = 1 N | NO |
automatic_threeds_minimum_value | Minimum 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_value | Maximum 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_value | Minimum 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_value | Maximum 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_threeds | Flag 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 AN | NO |
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 Carat Portal. Learn more. | < 4 N | |
routing_id | Routing/acquirer ID on Carat Portal. 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 | |
acquirer_merchant_id | Merchant identifier designated by the acquirer. | < 35 AN | NO |
cvv_mandatory | Enable mandatory card security code field. | < 5 AN | |
| authorizers[].parameters | Specific routing parameters. Learn more. |