Servicio de creación de tienda
Luego de obtener el token o firma en el paso anterior, la tienda virtual debe enviar los datos de la tienda a crear en Portal Carat y en SiTef (si es necesario).
Atención:
Las tiendas registradas tendrán la misma configuración de personalización que la tienda registrada, como su logotipo, CSS y JS.
Detalles de la llamada#
- Recurso:
/v1/merchants - Método HTTP:
POST - Formato de la solicitud:
JSON - Formato da la respuesta:
JSON - Parámetros de encabezamiento:
| Parámetro | descripción | Formato | Obligatorio |
|---|---|---|---|
merchant_id | Código de tienda en 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 en el paso anterior, si la autenticación es mediante publicación de autenticidad [Más información] (registration-lojas-ws-token.md) | = 66 AN | NO |
Content-Type | Debe enviarse con el valor application / json. | = 15 AN | SI |
Authorization | La firma de autenticación de la tienda debe enviarse en el formato "Portador {firma}". Ejemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NO |
Atención:
Durante la creación de la tienda, las configuraciones relacionadas con el uso de 3DS y la lucha contra el fraude se replican automáticamente desde la tienda de registro.
Ejemplo de uso de token#
Ejemplo de uso de firma#
Respuesta:
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud del servicio de creación de tiendas:
| Parámetro | Descripción | Formato | Obligatorio | |
|---|---|---|---|---|
cnpj | CNPJ ou CPF de la tienda. Solamente números. | < 14 N | SI | |
force_sitef_merchant_creation | Si se informa el valor "verdadero", se activa la generación alternativa de números de empresa que permiten registrar más de una empresa para el mismo CNPJ / CPF. Si no se informa, asume "falso", es decir, utiliza el algoritmo estándar para la generación del código de empresa, que garantiza una empresa para cada CNPJ / CPF. Envíe "verdadero" o "falso". | < 5 AN | NO | |
fantasy_name | nombre comercial de la tienda. | < 250 AN | SI | |
corporate_name | Razón social de la tienda. | < 250 AN | SI | |
domain | Dominio (site) de la tienda. | < 500 AN | NO | |
address | Dirección de la teinda. | < 200 AN | NO | |
city | Ciudad de ola tienda. | < 50 AN | NO | |
state | Estado de la loga (sigla). | = 2 AN | NO | |
zip_code | CEP de la tienda | < 9 AN | NO | |
phone_number | Teléfono de la tienda. | < 30 AN | NO | |
email | Dirección de e-mail de la tienda. | < 100 AN | NO | |
mcc | Merchant Category Code - código que indica la categoría del establecimiento (utilizado en el [registro antifraude] (# registro-de-tiendas-con-antifraude)). Si el campo threeds_enabled = true, mcc se vuelve obligatorio. Si el valor enviado tiene menos de 4 dígitos, se agregarán ceros a la izquierda del número hasta alcanzar el tamaño 4. | = 4 N | NO | |
threeds_enabled | Permite que la tienda se integre con 3DS Server y realice los ajustes necesarios para Pagar online, enviar "verdadero" o "falso". [Más información.] (Pagado-html-3ds-server.md) | 5 AN | NO | |
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-merchant-paid-geracao-link.md)
| = 1 N | NO | |
automatic_threeds_minimum_value | Indica la cantidad mínima en centavos para que una transacción habilite automáticamente el 3DS. Atención: no se deben utilizar intervalos que permitan el uso de 3ds y antifraude juntos. | < 12 N | NO | |
automatic_threeds_maximum_value | Indica la cantidad máxima en centavos para que una transacción habilite automáticamente el 3DS. Atención: no se deben utilizar intervalos que permitan el uso de 3ds y antifraude juntos. | < 12 N | NO | |
automatic_antifraud_minimum_value | Indica el valor mínimo en centavos de una transacción para habilitar automáticamente Anti-Fraud. Atención: no se deben utilizar intervalos que permitan el uso de 3ds y antifraude juntos. | < 12 N | NO | |
automatic_antifraud_maximum_value | Indica el monto máximo en centavos de una transacción para habilitar automáticamente Anti-Fraud. Atención: no se deben utilizar intervalos que permitan el uso de 3ds y antifraude juntos. | < 12 N | NO | |
antifraud_over_threeds | Flag que liga a funcionalidade de ativar o antifraude automaticamente em caso de erro ou autenticação negada utilizando o 3DS Server integrado com o Pagamento Online | < 5 AN | NO | |
| soft_descriptor | Dados do sub-comércio. | |||
id | ID do sub-comércio. | < 22 AN | NO | |
country | País de subcomercio. Código numérico ISO 3166-1. | = 3 N | NO | |
fantasy_name | Nombre comercial de subcomercio | < 22 AN | NO | |
| subacquirer_group | Subadquisición de datos de grupo. | |||
create | Flag que indica si se debe crear el grupo de subcompra | < 5 T / F | NO | |
id | ID de grupo de subadquisición | < 6 AN | NO | |
cnpj | CNPJ del subgrupo adquirente | = 14 N | SÍ, si el campo subacquirer_group.create es true | |
| establecimientos | Datos de establecimientos a dar de alta en SiTef. | |||
code | Código de establecimiento (número lógico) que debe registrarse en SiTef | < 32 AN | NO | |
routing_id | ID de ruta (tipo de pago de Portal Carat) | < 4 N | NO | |
subacquirer_group_id | ID de grupo de sub-adquisición. Debe enviarse si este establecimiento se va a registrar para el grupo en lugar de la empresa. | < 6 AN | NO | |
extra_date | Información adicional de la propiedad. | < 32 AN | NO | |
| transaccional_urls | URL utilizadas en flujos transaccionales. | |||
status | URL para recibir avisos de estado. | < 500 AN | NO | |
autenticidad | URL para recibir POST de autenticidad. | < 500 AN | NO | |
hash | URL para recibir el hash / token de la tarjeta almacenada. | < 500 AN | NO | |
| return_urls | URL de amortización HTML. | |||
éxito | URL de retorno exitosa. | < 500 AN | NO | |
failure | URL de retorno de error. | < 500 AN | NO | |
cancel | Cancelar la URL de retorno. | < 500 AN | NO | |
| permisos | Permisos transaccionales que se asignarán a la tienda. Envíe el valor "verdadero" para habilitar la funcionalidad en cuestión. | |||
pago | Permiso de pago. | < 5 AN | NO | |
pre_authorization | Permiso de preautorización. | |||
| authorizers[] | Autorizadores para registrarse en la tienda. La presencia de un enrutamiento SiTef indica que se debe crear una empresa en SiTef. | |||
id | ID del autorizador en el Portal Carat. [Más información.] (autorizadores.md#códigos-de-autorizadores-no-e-sitef) < 4 N | SI | ||
routing_id | Identificación de enrutamiento / adquirente en el Portal Carat. [Más información.] (# Códigos-de-enrutamiento-solicitante) | < 4 N | SI | |
min_installments_amount | Importe mínimo para cuotas en transacciones HTML. Valor predeterminado: 1000 | < 12 N | NO | |
max_installments_without_interest | Número máximo de cuotas sin intereses en transacciones HTML. Valor predeterminado: 3 | < 2 N | NO | |
max_installments_with_interest | Número máximo de cuotas que devengan intereses en transacciones HTML. Valor predeterminado: 12 | < 2 N | NO | |
enable_subacquirer_group | Habilitar la marca de la tarjeta para el uso del grupo de sub-adquisición. Envíe "verdadero" para habilitarlo o "falso" para deshabilitarlo. | < 5 T / F | NO | |
purchaser_merchant_id | Identificador de tienda designado por el solicitante. Si threeds_enabled = true, debe enviar al menos un adquisr_merchant_id | < 35 AN | NO | |
cvv_mandatory | Habilite el campo de código de seguridad obligatorio de la tarjeta. Envíe true para habilitar o falso para deshabilitar. | < 5 T / F | NO | |
| authorizers[].parameters | Parámetros específicos de enrutamiento. [Más información.] (# Parámetros-específicos-de-enrutamiento) |
Códigos de enrutamiento / solicitante#
| ID | Enrutamineto |
|---|---|
201 | Cielo e-Commerce |
202 | e-Rede.REST |
407 | Getnet WS |
408 | Global Payments WS |
409 | Stone WS |
1005 | Rede via SiTef |
1181 | Getnet Lac via SiTef |
1125 | Cielo via SiTef |
1206 | Global Payments via SiTef |
1229 | BIN via SiTef |
1265 | Stone via SiTef |
1296 | Safra via SiTef |
Parámetros específicos de enrutamiento#
Estos parámetros deben enviarse en el campo authorizer []. Parameters dependiendo de la ruta elegida.
Comercio electrónico de Cielo#
| Parámetro | Descripción |
|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. |
merchantId | Identificación de la tienda Cielo. |
MerchantKey | Clave de la tienda en Cielo. |
Getnet WS#
| Parámetro | Descripción |
|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. |
username | Usuario de acceso. |
password | Contraseña de acceso. |
merchantID | Código EC registrado en GetnetWS. |
terminal | Identificación del terminal. |
subMerchantId | ID comercial secundario. |
Global Payments WS#
| Parámetro | Descripción |
|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. |
MerchantCode | Número de establecimiento definido por Global Payments. |
secretKey | Clave secreta del minorista en Global Payments. |
terminal | Número de terminal que será definido por Global Payments. |
Stone WS#
| Parámetro | Descripción |
|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. |
salesAffiliationKey | Clave de identificación de la tienda de Stone. |
subAcquireEnabled | Envíe "verdadero" para habilitar la adquisición secundaria o "falso" en caso contrario. |
BIN a través de SiTef#
| Parámetro | Descripción | Formato |
|---|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. | |
subacquirerMerchantId | Código de subcomercio. | |
| establecimientos | Datos de establecimientos a dar de alta en SiTef. | |
extra_date | Código de terminal. Campo obligatorio para la integración con Bin. | = 8 AN |
Red electrónica#
| Parámetro | Descripción |
|---|---|
| authorizers[].parameters | Parámetros específicos de enrutamiento. |
filiation | Código de afiliación a la tienda e-Rede. |
token | Clave pública de la tienda e-Rede. |
Descubra más detalles sobre el "enrutamiento e-Rede")
Registro de tiendas antifraude#
Es posible registrar automáticamente nuevas tiendas con las siguientes soluciones antifraude: Antifraude Fiserv , ClearSale, CyberSource y Konduto. Para ello, el comerciante debe ponerse en contacto con la institución de análisis de riesgos y solicitar las credenciales necesarias . Luego, el comerciante debe pasar un conjunto de MCC (Código de categoría de comerciante) para cada credencial registrada en el equipo de Producción de pagos onlines, que registrará estos datos. Estos conjuntos de MCC se asignarán a cada credencial y estos valores se utilizarán en el registro de cada tienda. Una vez realizado este prerregistro, será posible realizar el registro antifraude de forma automática utilizando la API de creación de tienda.
Atención:
- Es necesario habilitar el permiso antifraude (
risk_analysis) en el registro de la tienda.- Solo la API de creación de tiendas realiza el registro antifraude automático.
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "201". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de creación de tiendas:
| Parámetro | Descripción | Formato |
|---|---|---|
response_code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" significa error. | < 4 N |
response_message | Mensaje de respuesta de Portal Carat. | < 500 AN |
authorizer_response_code | Código de respuesta del autorizador. | < 4 N |
authorizer_response_message | Mensaje de respuesta del autorizador. | < 500 AN |
id | Código de la tienda creada. Generado automáticamente (nota: los caracteres en mayúsculas y minúsculas se diferencian en el sistema). | < 15 AN |
key | Se creó la clave de la tienda. | < 80 AN |