Merchant status query service
After getting the token or signature in the previous step, the virtual store can consume the status merchant query service.
Attention:
The merchant requesting the status must have permission to do so and must be at the same group in which is the requested merchant. For more info on enabling Merchant Status Query Permission, contact our support team.
Call details#
- Resource:
/v1/merchants/status/{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 | NO |
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#
| Parameter | Description | Format |
|---|---|---|
response_code | Carat Portal response code. | < 4 N |
response_message | Carat Portal response message. | < 500 AN |
merchant_status | Status of the consulted merchant. A = ACTIVE; I = INACTIVE | 1 A |