Servicio de consulta de la tienda

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc'; import ResponseCodes from './codigos-de-resposta.md';

Después de obtener el token o la firma en el paso anterior, la tienda online puede consumir el servicio de búsqueda de tiendas.

Detalles de la llamada

  • Recurso: /v1/merchants/{id}
  • Método HTTP: GET
  • Formato de la respuesta: JSON
  • Parametros de encabezamiento:
ParámetroDescripciónFormatoObligatorio
merchant_idCódigo de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes.< 15 ANSIM
merchant_keyClave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes.< 80 AN
tokenToken obtenido del servicio de creación de tokens. Más información.= 66 ANNO
AuthorizationLa firma de autenticación de la tienda debe enviarse en el formato Bearer {assinatura}. Exemplo: Bearer {TOKEN_JWT_EXAMPLE}.< 2000 ANNO

Ejemplo

Respuesta:

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

Parámetros de respuesta

Si 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 pago. Online. | < 4 N | | response_message | Mensagem de resposta do Pagamento Online. | < 500 AN | | id | Código de la tienda consultada. | < 15 AN | | key | Clave de la tienda consultada. | < 80 AN | | fantasy_name | Nombre fantasia de la tienda. | < 250 AN | | corporate_name | Razón social de la tienda. | < 250 AN | | merchant_status | Estado de la tienda. Puede tomar los siguientes valores: A = Activo I = Inactivo | = 1 AN | | sitef_merchant_id | Código de empresa de la tienda. | 8 N | | domain | Domínio (site) de la tienda. | < 65 AN | | cnpj | CNPJ ou CPF de la tienda. Sólo números. | < 14 N | | address | Dirección tienda. | < 30 AN | | city | Ciudad de compras. | < 13 AN | | state | Estado de la tienda (sigla). | = 2 AN | | zip_code | CEP de la tienda. | < 9 AN | | phone_number | teléfono de la tienda | < 30 AN | | email | Dirección de | | e-mail. | < 100 AN | | transactional_urls | URLs utilizadas en flujos transaccional. | | mcc | Merchant Category Code - código que indica la categoría del establecimiento | = 4 N | | threeds_enabled | Muestra si la tienda está lista para la autenticación mediante 3DS Server. [Más información.] (Pago-html-3ds-server.md) | = 5 N | | threeds_payment_link_authentication | Tipo de autenticación predeterminado que se mostrará al generar un enlace de pago en el portal de comerciantes. [Más información.] (portal-lojista-pagamento-geracao-link.md)

  • 0 = Sin autenticación
  • 1 = Habilita el uso de 3DS y si el 3DS el servidor no admite la marca de la tarjeta o no se autentica, el pago será denegado.
  • 2 = Habilite el uso de 3DS solo con marcas admitidas por el servidor 3DS. Si el servidor 3DS no admite la marca, la autenticación no se realiza. Si la marca es compatible y se niega la autenticación, se denegará el pago
  • 3 = Habilita el uso de 3DS y si la autenticación falla, el pago se cancelará. no se denegará tras la autenticación.
| = 1 N | NO | | automatic_threeds_minimum_value | Valor mínimo en centavos para que el 3DS se habilite automáticamente. < 12 N | | automatic_threeds_maximum_value | Valor máximo en centavos para habilitar 3DS automáticamente. < 12 N | | automatic_antifraud_minimum_value | Valor mínimo en centavos para habilitar automáticamente Antifraude. < 12 N | | automatic_antifraud_maximum_value | Valor máximo en centavos para habilitar automáticamente Antifraude. < 12 N | | antifraud_over_threeds | Marca de la tarjeta que indica que se deniega la funcionalidad para activar el antifraude automáticamente en caso de error o autenticación utilizando el servidor 3DS integrado con Portal Carat | < 5 AN | | status | URL para recibir avisos de estado. | < 500 AN | | autenticidad | URL para recibir POST de autenticidad. | < 500 AN | | hash | URL para recibir el hash / token de la tarjeta almacenada. | < 500 AN | | return_urls | URL de amortización HTML. | | success | URL de retorno exitosa. | < 500 AN | | failure | URL de retorno de error. | < 500 AN | | cancel | Cancelar la URL de retorno. | < 500 AN | | permission | Permisos transaccionales que se asignarán a la tienda. Envíe el valor true para habilitar la funcionalidad en cuestión. | | payment | Permiso de pago. | < 5 AN | | pre_authorization | Permiso de preautorización. | < 5 AN | | recharge | Permiso para recargar. | < 5 AN | | risk_analysis | Permiso para análisis de riesgos. | < 5 AN | | schedule | Permiso para programar horario. | < 5 AN | | iata | Permiso para IATA. | < 5 AN | | card_store | Permiso para el almacenamiento de tarjetas. | < 5 AN | | payment_link | Permiso de pago mediante enlace. | < 5 AN | | ** authorizers [] ** | Autorizadores para registrarse en la tienda. | | id | ID del autorizador en el Portal Carat. [Más información.] (autorizadoras.md#códigos-de-autorizadores-no-e-sitef) | < 4 N | | routing_id | Identificación de enrutamiento / adquirente en el Portal Carat. [Más información.] (# Códigos-de-enrutamiento-adquirente) | < 4 N | | min_installments_amount | Importe mínimo para cuotas en transacciones HTML. Valor predeterminado: 1000 | < 12 N | | max_installments_without_interest | Número máximo de cuotas sin intereses en transacciones HTML. Valor predeterminado: 3 | < 2 N | | max_installments_with_interest | Número máximo de cuotas que devengan intereses en transacciones HTML. Valor predeterminado: 12 | < 2 N | | purchaser_merchant_id | Identificador de tienda designado por el adquirente. | < 35 AN | | cvv_mandatory | Habilite el campo de código de seguridad obligatorio de la tarjeta. | < 5 AN | | ** authorizers[].parameters ** | Parámetros específicos de enrutamiento. [Más información.] (# Parámetros-específicos-de-enrutamiento) |