Servicio de fichas de tiendas
Después de obtener el token o la firma en el paso anterior, la tienda online puede consumir el servicio de listado de tiendas.
#
Detalles de la llamada- Recurso:
/v1/merchants
- Método HTTP:
GET
- Formato de solicitud:
query string
- Formato de respuesta:
JSON
- Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
| :-------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------: | :---------: |
|
merchant_id
| Código de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI | |merchant_key
| Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. | < 80 AN | SI | |token
| Token obtenido del servicio de creación de tokens. [Más información.] (Registration-stores-ws-token.md) | = 66 AN | NO | |Authorization
| La firma de autenticación de la tienda debe enviarse en el formato "Bearer {firma}". Ejemplo:Bearer JHVGytfdgauygdauiw78264284527852897hagdg
. | < 2000 AN | NO |
#
EjemploAbajo, se muestran algunos ejemplos de cómo llamar al servicio de fichas de tiendas con la herramienta cURL.
#
Ficha de la tienda usando tokenSolicitud:
#
Ficha de la tienda mediante firmaSolicitud:
Respuesta:
#
Parámetros de solicitudParámetro | Descripción | Formato | Obligatorio |
---|---|---|---|
cnpj | CNPJ de la tienda. | = 14 N | No |
merchant_status | Status de la tienda. Puede tomar los siguientes valores: A = Activo I = Inactivo | = 1 N | No |
page | Página de listado. La primera página tiene un valor de "0". Si no se envía, asumiremos el valor "0". | < 4 N | No |
limit | Número máximo de registros por página. Si no se envía, asumiremos el valor máximo de 100. | < 3 N | No |
#
Parámetros de respuestaSi tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error.
Parámetro | Descripción | Formato |
---|---|---|
response_code | Código de respuesta de Portal Carat. | < 4 N |
response_message | Mensaje de respuesta de Portal Carat. | < 500 AN |
current_page | Página actual de registros. | < 4 N |
total_pages | Número total de páginas. | < 4 N |
count | Recuento total de registros. | < 4 N |
merchants [] | Lista de tiendas devueltas en la consulta. | |
id | Código de la tienda consultada. | < 15 AN |
merchant_status | Status de la tienda. Puede tomar los siguientes valores: A = Activo I = Inactivo | = 1 N |
fantasy_name | Nombre comercial de la tienda. | < 250 AN |
corporate_name | Nombre de la empresa de la tienda. | < 250 AN |
cnpj | CNPJ o CPF de la tienda. Sólo números. | < 14 N |