Cielo

La tienda tiene la capacidad de configurar el enrutamiento de las transacciones realizadas con tarjeta de crédito en el Portal Carat para varios métodos de pago, uno de estos medios es Cielo e-Commerce.

En esta página se utilizará la nomenclatura "CieloEC" para hacer referencia al enrutamiento en Portal Carat.

Así, la tienda puede configurar el Portal Carat para que las transacciones realizadas con tarjetas VISA, por ejemplo, se enruten a través del CieloEC mientras que los hechos con MASTERCARD son enrutados por el CIELO.

Interfaces Portal Carat apoyado para la integración

Puede utilizar las siguientes interfaces para la integración con el enrutamiento CieloEC:

• Interfaz de autorización previa REST
• Interfaz de pago REST
• Interfaz de cancelación REST
• Interfaz de pago HTML
• Interfaz de autorización previa HTML

Observación: Esta integración también admite el envío de datos de autenticación 3DS (eci, xid e cavv). Sepa mas.

Autorizadores permitidos

Los siguientes autorizadores son compatibles con el enrutamiento CieloEC:

• CRÉDITO

  • VISA (1)
  • MASTERCARD (2)
  • AMERICAN EXPRESS (3)
  • ELO (41)
  • AURA (6)
  • JCB (43)
  • DINERS (33)
  • DISCOVER (44)

• DÉBITO

  • VISA ELECTRON (221)
  • MASTERCARD DÉBITO (286)

• TRANSFERÊNCIA

  • BRADESCO (8)
  • BANCO DO BRASIL (408)

• ZERO DÓLLAR

  • VISA (1)
  • VISA ELECTRON (221)
  • MASTERCARD (2)
  • MASTERCARD DÉBITO (286)
  • ELO (41)

Credenciales requeridas

La tienda debe obtener con el CieloEC las credenciales que se enumeran a continuación, y pasarlos a Software Express o regístrese como se explica más adelante en este documento.

Campo	Descripción	Formato
merchantID	Identificador de tienda en el CieloEC	< 36 AN
merchantKey	Clave pública para doble autenticación en CieloEC.	< 40 AN

Importante para el pago HTML: En caso de que un autorizador de la tienda no haya registrado estas credenciales, este autorizador no se mostrará en la pantalla de selección de la tarjeta de crédito durante la operación de pago.

Registro de información a través del portal del comerciante

El dueño de la tienda puede registrar la información obtenida con el CieloEC en el Portal del Comerciante do Portal Carat. Para ello, el comerciante debe seleccionar el autorizador e ingresar a la pantalla de edición como se muestra en el siguiente ejemplo:

Registro de SoftDescriptor en Portal Carat

El registro de SoftDescriptor es opcional, Tiene tamaño 13, no acepta caracteres especiales y solo está disponible para Visa y Mastercard.

Flujos

En este apartado se presentarán las particularidades del flujo transaccional CieloEC.

Pago REST

Esta interfaz admite el envío de de campos de autenticación externos

Crédito

Puede enviar los siguientes campos en el paso de finalización del pago:

Parámetro	Descripción	Formato	Obligatorio
card
holder	Nombre del titular de la tarjeta impreso en la tarjeta	< 25 AN	NO
external_authentication
eci	Eletronic Commerce Indicator – indica el nivel de seguridad de la transacción con autenticación del titular de la tarjeta	< 3 N	NO
xid	Identificador de la transacción de autenticación del titular de la tarjeta en 3DS, realizada en un servicio externo a Carat (En nuestro 3DS, el xid está referenciado por three_ds_server.trans_id en la respuesta del servicio de creación de transacciones de 3DS).	< 40 N	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
cavv	Cardholder Authentication Verification Value - Código que indica o resultado da autenticação do dono do cartão.	< 40 N	NO
version	Versión de 3DS utilizada en el proceso de autenticación.	1 AN	SI para versión 2 de 3DS
reference_id	RequestID devuelto en el proceso de autenticación.	36 AN	SI para versión 2 de 3DS

Crédito con autenticacion

Puede enviar el siguiente campo en el paso de creación de la transacción:

Parámetro	Descripción	Formato	Obligatorio
authorizer_authentication	Define si el comerciante quiere un pago con autenticación. Mandar true si positivo.	< 5 AN	SI para crédito con autenticacion

Si el pago es exitoso, el servicio devolverá la transacción con estado PEN (pendiente) y tendrá el siguiente campo:

Parámetro	Descripción	Formato
authentication_url	URL a la que el comerciante debe redirigir al comprador para realizar la autenticación .	< 56 AN

Después de una autenticación exitosa, el pago siempre se confirmará (status CON),es decir, un crédito con autenticación sin autoconfirmación no es posible.

En la imagen a continuación, puede verificar el funcionamiento del flujo de una transacción con autenticación:

Débito

Con la excepción de las transacciones realizadas a través del Corona Voucher, todas las operaciones de débito siempre requieren autenticación y, por tanto, son independientes del envío del campo. authorizer_authentication. El flujo a seguir es el mismo que un crédito con autenticación. Cada transacción de débito se autoconfirma, por lo que no permitimos débitos con confirmación tardía.

Crédito con análisis de fraude

Para realizar un crédito con análisis de fraude, es necesario enviar el campo additional_data que contiene información adicional para la lucha contra el fraude. Su valor sigue el formato JSON como se muestra a continuación:

{

"amount":"1000",

"authorizer_id":"1",

"installments":"1",

"installment_type":"4",

"additional_data":{

"payer":{

"name":"Comprador",

"surname":"credito AF",

"email":"compradorteste@live.com",

"city":"Rio de Janeiro",

"state":"RJ",

"address_street_name":"Rua Jupiter",

"address_street_number":"174",

"address_zip_code":"21241140",

"born_date":"1991-01-02T08:30:00",

"address_street_complement":"AP 201",

"address_country":"BRA"

},

"shipment":{

"method":"LOW_COST",

"name":"Sr Comprador Teste",

"phones":[

{

"number":"21114740",

"ddd":"16",

"ddi":"55"

}

],

"receiver_address":{

"complement":"AP 201",

"city":"Rio de Janeiro",

"state":"RJ",

"country":"BRA",

"zip_code":"21241140",

"street_number":"174",

"street_name":"Rua Jupiter"

}

},

"connections":[

{

"from":"RAO",

"to":"SAO",

"flight_date":"2020-01-02T20:15:00"

}

],

"gift":"false",

"browser":{

"email":"compradorteste@live.com",

"agent":"Chrome",

"cookies_accepted":"false",

"host_name":"Teste",

"ip_address":"200.190.150.350"

},

"items":[

{

"title":"ItemTeste",

"quantity":"1",

"id":"1487337308522",

"risk":"HIGH",

"hedge":{

"time":"NORMAL",

"host":"OFF",

"nonSensical":"OFF",

"obscenities":"OFF",

"phone":"OFF",

"velocity":"HIGH"

},

"passenger":{

"name":"Comprador accept",

"email":"compradorteste@live.com",

"rating":"ADULT",

"phone":{

"number":"999994444",

"ddd":"11",

"ddi":"55"

},

"legal_document":"1234567890",

"customer_class":"Gold"

},

"unit_price":"1000",

"category_id":"other",

"gift_category":"OFF"

}

],

"extra_param":{

"acquirer_params":[

{

"key":"95",

"value":"Eu defini isso"

}

]

},

"anti_fraud":"enabled_before_auth",

"anti_fraud_institution":"AUTHORIZER",

"anti_fraud_criteria":"ALWAYS",

"finger_print_id":"074c1ee676ed4998ab66491013c565e2",

"returns_accepted":"true",

"journey_type":"OUTWARD"

}

}

La siguiente tabla describe los campos JSON:

Datos adicionales de comprador

Parámetro	Descripción	Formato	Obligatorio
anti_fraud_institution	Institución que realizará el análisis de fraude para la tienda. Debe enviarse con el valor AUTHORIZER.	< 10 AN	SÍ para análisis de fraude
anti_fraud	Habilita el servicio de análisis de fraudes. Valores permitidos: enabled_before_auth – el análisis de fraude se realizará ANTES de la autorización del pago. Si se rechaza el análisis, no se iniciará el pago. enabled_after_auth – el análisis de fraude se realizará DESPUÉS de la autorización del pago. Si se rechaza el análisis, se cancelará el pago que ya ha sido autorizado.	< 19 AN	SÍ para análisis de fraude
anti_fraud_criteria	Criterios para la realización del análisis de fraude. Valores permitidos: ON_SUCCESS – solo realiza el análisis si la transacción es exitosa. ALWAYS – siempre realiza el análisis.	< 10 AN	NO
finger_print_id	Identificador utilizado para cruzar la información obtenida por el navegador del usuario de Internet con los datos enviados para su análisis. Sepa mas	< 50 AN	NO
gift	Indica si el pedido es para regalo o no.	< 5 T/F	NO
returns_accepted	Define si se aceptan devoluciones del pedido.	< 5 T/F	NO
journey_type	Tipo de viaje. Valores permitidos: ROUND_TRIP – ida y vuelta. OUTWARD - ida RETURN- regreso.	< 10 AN	NO
payer
name	Nombre del comprador. Obs .: la concatenación de nombre y apellido no puede exceder los 255 caracteres.	< 200 AN	NO
surname	Apellido del comprador. Obs .: la concatenación de nombre y apellido no puede exceder los 255 caracteres.	< 200 AN	NO
email	Correo electrónico del comprador.	< 255 AN	NO
born_date	Fecha de nacimiento del comprador, en el formato YYYY-MM-DDTHH:MM:SS Ex.: 1991-01-02T08:30:00	19 AN	NO
adress_street_name	Dirección del comprador.	< 255 AN	NO
adress_street_number	Número de dirección del comprador.	< 15 AN	NO

| address_street_complement | Complemento de la dirección del comprador. | < 50 AN | NO |

| address_zip_code | Código postal de la dirección del comprador. Ex.: 21241140. | < 9 AN | NO | | city | Ciudad de la dirección del comprador. | < 9 AN | NO |

| state | Estado de la dirección del comprador. Ej. SP | 2 AN | NO |

| addres_country | País de la dirección del comprador. Ex. BRA | < 35 AN | NO | | shipment
.receiver_address |

Detalles adicionales de la dirección de entrega |

| street_name | Dirección de entrega.
| < 255 AN | NO | | street_number | Número de dirección de entrega. | < 15 AN | NO |

| complemento | Complemento de dirección de entrega. | < 50 AN | NO |

| zip_code | Código postal de la dirección de entrega. Por ejemplo: "21241-140". | < 9 AN | NO | | city | Ciudad de dirección de entrega. | < 50 AN | NO |

| state | Estado de la dirección de entrega. | < 2 AN | NO |

| country | País de dirección de entrega según ISO 3166-1. Por ejemplo: BRA | 3 AN | NO | | browser |

Datos adicionales del navegador | | cookies_accepted | Identifica si el navegador del cliente acepta cookies. Mandar ‘true’ si positivo. | < 5 AN | NO | | email | Correo electrónico registrado en el navegador del comprador. | < 100 AN | NO |

| host_name | Nombre de host donde se encontraba el comprador antes de ingresar al sitio web de la tienda.
| < 60 AN | NO | | ip_address | Dirección IP del comprador. Se recomienda encarecidamente que envíe este campo. | < 15 AN | NO | | agent | Nombre del navegador utilizado por el comprador. Por ejemplo: Chrome. | < 40 AN | NO |

| elementos [] |

Datos de productos adicionales | | gift_category | Campo que evaluará las direcciones de facturación y entrega para diferentes ciudades, estados o países. Puede adoptar los siguientes valores:

OFF - Omite el análisis de riesgo para direcciones divergentes.
YES - En caso de discrepancia entre las direcciones de facturación y entrega, marque con riesgo pequeño.
NO - En caso de discrepancia entre las direcciones de facturación y entrega, marque con alto riesgo. | < 3 AN | NO | | risk | Nivel de riesgo del producto. Puede adoptar los siguientes valores:

LOW - El producto tiene un historial de pocas chargebacks.
NORMAL - El producto tiene un historial de chargebacks considerados normales.
HIGH - El producto tiene un historial de chargebacks Por cima de la media. | < 6 AN | NO | | title | Nombre del producto. | < 255 AN | NO | | cantidad | Cantidad de producto a comprar. | < 15 N | NO | | id | Código de comerciante de identificador de producto. | < 255 AN | NO | | unit_price | Precio unitario del producto en centavos. | < 15 N | NO | | category_id | Tipo de producto. Puede adoptar los siguientes valores: art, baby, coupon, donation, computing, camera, video_game, television, car_electronic, electronic, automotive, entertainment, fashion, game, home, musical, phone, service, learning, ticket, travel, virtual_good, physical, other, adult_content, gift_certificate, handling, shipping, shipping_and_handling ou subscription | < 21 AN | NO | | items[]
.hedge | Detalles adicionales de compra de productos | | time | Nivel de importancia de la hora del día del pedido del cliente. Puede adoptar los siguientes valores:

LOW - Bax importancia en la hora del día en que se realizó la compra, para análisis de riesgo.
NORMAL - Importancia media en el momento del día en que se realizó la compra, para análisis de riesgo.
HIGH - Gran importancia en el momento del día en que se realizó la compra, para el análisis de riesgos.
OFF - El tiempo de compra NO afecta el análisis de riesgos. | < 6 AN | NO | | host | Nivel de importancia del correo electrónico y las direcciones IP de los clientes en riesgo de puntuación. Puede adoptar los siguientes valores:

LOW - Baja importancia del correo electrónico y la dirección IP en el análisis de riesgos.
NORMAL - Importancia media del correo electrónico y la dirección IP en el análisis de riesgos.
HIGH - Gran importancia del correo electrónico y la dirección IP en el análisis de riesgos.
OFF - El correo electrónico y la dirección IP NO afectan el análisis de riesgos. | < 6 AN | NO | | non_sensical | Nivel de prueba realizado en los datos del comprador con pedidos recibidos sin sentido. Puede asumir los siguientes valores:

LOW - Baja importancia de la verificación realizada en el pedido del comprador, en el análisis de riesgo.
NORMAL - Importancia media de la verificación realizada en el pedido del comprador, en el análisis de riesgos.
HIGH - Gran importancia de la verificación realizada en el pedido del comprador, en el análisis de riesgo.
OFF - La verificación del pedido del comprador NO afecta el análisis de riesgo. | < 6 AN | NO | | obscenities | Nivel de obscenidad de las órdenes recibidas. Puede tomar los siguientes valores:

LOW - Baja importancia de verificar las obscenidades del pedido del comprador, en el análisis de riesgo.
NORMAL - Importancia media de la verificación de obscenidades del pedido del comprador, en el análisis de riesgo.
HIGH- Alta importancia de verificar las obscenidades del pedido del comprador, en el análisis de riesgo.
OFF - La verificación de obscenidad en el pedido del comprador NO afecta el análisis de riesgo. | < 6 AN | NO | | phone | Nivel de pruebas realizadas con números de teléfono. Puede tomar los siguientes valores:

LOW - Baja importancia en pruebas realizadas con números de teléfono.
NORMAL - Importancia media en pruebas realizadas con números de teléfono.
HIGH - Gran importancia en las pruebas realizadas con números de teléfono.
OFF: la prueba del número de teléfono NO afecta el análisis de riesgo. | < 6 AN | NO | | velocity | Nivel de importancia de la frecuencia de compra del cliente. Puede tomar los siguientes valores:

LOW - Baja importancia en el número de compras realizadas por el cliente en los últimos 15 minutos.
NORMAL - Importancia media en el número de compras realizadas por el cliente en los últimos 15 minutos.
HIGH - Gran importancia en el número de compras realizadas por el cliente en los últimos 15 minutos.
OFF: la frecuencia de las compras realizadas por el cliente NO afecta el análisis de fraude. | < 6 AN | NO | | items[]
.passenger | Datos adicionales de pasajeros | | email | Correo electrónico del pasajero. | < 255 AN | NO | | legal_document | Cédula del pasajero a quien se le emitió el boleto. | < 32 AN | NO | | name | Nombre del pasajero. | < 120 AN | NO | | rating | Clasificación de pasajeros. Puede tomar los siguientes valores:

ADULT - Pasajero adulto.
CHILD - Pasajero infantil.
INFANT - Pasajero infantil.
YOUTH - Pasajero adolescente.
STUDENT - Pasajero estudiante.
SENIOR_CITIZEN - Pasajero mayor.
MILITARY - Pasajero militar. | < 14 AN | NO | | customer_class | Clasificación de aerolínea. Puede utilizar valores como Gold o Platinum. | < 32 AN | NO | | items[]
.passenger
.phone | Datos adicionales del teléfono del pasajero | | ddi | Ccódigo de país del teléfono del pasajero. Para pedidos fuera de EE. UU., Se recomienda que envíe este campo. | < 3 N | NO | | ddd | Código de área del teléfono del pasajero. | < 3 N | NO | | number | Número de teléfono del pasajero. | < 9 N | NO | | extra_param
.acquirer_params[] | Parámetros adicionales del adquirente | | key | Id de la información adicional que se enviará. | < 1024 N | NO | | value | Valor de la información adicional a enviar. | < 1024 AN | NO | | shipment | Detalles del servicio de entrega | | name | Nombre del destinatario de la entrega. | < 255 AN | NO | | method | Tipo de servicio de entrega de productos. Puede tomar los siguientes valores:

SAME_DAY - Servicio de entrega el mismo día.
ONE_DAY - Servicio de entrega nocturno o al día siguiente.
TWO_DAY - Servicio de entrega en dos días.
THREE_DAY - Servicio de entrega en tres días.
LOW_COST - Servicio de entrega de bajo costo.
PICKUP - Producto retirado de la tienda.
OTHER - Otro método de entrega.
NONE - No hay servicio de entrega, ya que es un servicio o suscripción. | < 9 AN | NO | | shipment
.phones | datos en el teléfono del destinatario | | ddi | Código de país del teléfono del destinatario de la entrega. Para pedidos fuera de EE. UU., Se recomienda enviar este campo. | < 3 AN | NO | | ddd | Código de área del teléfono del destinatario de la entrega. | < 3 AN | NO | | number | Número de teléfono del destinatario de la entrega. | < 9 AN | NO | | connections[] | Datos de conexión de vuelo | | flight_date | Fecha, hora y minuto de salida del vuelo en formato YYYY-MM-DDTHH:MM:SS Ex.: 1991-01-02T08:30:00 | < 19 AN | NO | | from | Código de aeropuerto del punto de origen del viaje. Ex.: CGH. | < 3 AN | NO | | to | Código de aeropuerto del punto de destino del viaje. Ex.: GYN. | < 3 AN | NO |

La devolución de pago tendrá los siguientes campos adicionales:

Datos de análisis de fraude

Parâmetro	Descrição	Formato
payment .analysis

| code | Código de respuesta de la operación de análisis de fraude. | < 4 N |

| message | Mensaje de respuesta a la operación de análisis de fraude. | < 200 AN | | status | Estado de transacción de análisis de fraude de Portal Carat. Este campo puede tomar los siguientes valores:

NOV – Nova.
EXP – Expirada.
ACC – Aceita
REJ – Rejeitada
REV – Em revisão
INV – Inválida | = 3 AN |

Cero Dóllar

La llamada Zero Dollar consiste en una llamada de pago con el campo de monto con un valor igual a cero y se puede realizar a Visa, Mastercard y Elo, Crédito y Débito, utilizando la interfaz REST.

Pago HTML

Los temas a continuación se refieren al paso de creación de la transacción, en el que el comerciante envía un documento JSON a Portal Carat. Para obtener más información sobre cómo realizar un pago a través de la interfaz HTML, consulte [el pago a través de la página HTML].(pagamento-html-begin).

Crédito

Sin particularidades en relación a otros métodos de pago.

Crédito con autenticacion

Para realizar un crédito con autenticación, se debe enviar el siguiente parámetro: | Parámetro | Descripción | Formato | Obligatorio | | :-: | :- | :-: | :-: | | authorizer_authentication | Define si el comerciante quiere un pago con autenticación. Mandar true si positivo o false si contrário. Este campo debe enviarse con el valor true si desea confirmar la transacción, o false, en caso de querer deshacer el pago. | < 5 AN | SÍ para crédito con autenticacion |

Ejemplo:

{

"merchant_id": "LOJATESTE",

"order_id": "20150925001",

"amount": "1000",

"transaction_type": "payment",

"authorizer_authentication": "true"

}

Débito

Las operaciones de débito siempre requieren autenticación y, por lo tanto, son independientes del envío de campo. authorizer_authentication.

Cada transacción de débito se autoconfirma, por lo que NO le permitimos realizar un débito con confirmación tardía.

Crédito con análisis de fraude

El comerciante debe enviar el elemento additional_data os campos que se refieren al análisis de fraude. Ejemplo:

{

"merchant_id": "LOJACIELOEC",

"merchant_usn": "9876",

"order_id": "11",

"redirect": "M",

"authorizer_id": "",

"amount": "1000",

"installments": "",

"installment_type": "",

"style": "N",

"soft_descriptor": "",

"transaction_type": "payment",

"back_url": {

"url_success": "lojateste/loja/loja-index.jsp?pagina=sucesso",

"url_failure": "lojateste/loja/loja-index.jsp?pagina=fracasso",

"url_cancel": "lojateste/loja/loja-index.jsp?pagina=fracasso"

},

"additional_data": {

"payer": {

"name": "Comprador",

"surname": "credito AF",

"email": "compradorteste@live.com",

"city": "Rio de Janeiro",

"state": "RJ",

"address_street_name": "Rua Jupiter",

"address_street_number": "174",

"address_zip_code": "21241140",

"born_date": "1991-01-02T08:30:00",

"address_street_complement": "AP 201",

"address_country": "BRA"

},

"shipment": {

"method": "LOW_COST",

"name": "Sr Comprador Teste",

"phones": [

{

"number": "21114740",

"ddd": "16",

"ddi": "55"

}

],

"receiver_address": {

"complement": "AP 201",

"city": "Rio de Janeiro",

"state": "RJ",

"country": "BRA",

"zip_code": "21241140",

"street_number": "174",

"street_name": "Rua Jupiter"

}

},

"connections": [

{

"from": "RAO",

"to": "SAO",

"flight_date": "2020-01-02T20:15:00"

}

],

"gift": "false",

"browser": {

"email": "compradorteste@live.com",

"agent": "Chrome",

"cookies_accepted": "false",

"host_name": "Teste",

"ip_address": "200.190.150.350"

},

"items": [

{

"title": "ItemTeste",

"quantity": "1",

"id": "1488392648367",

"risk": "HIGH",

"hedge": {

"time": "NORMAL",

"host": "OFF",

"17efine17ical": "OFF",

"obscenities": "OFF",

"phone": "OFF",

"velocity": "HIGH"

},

"passenger": {

"name": "Comprador accept",

"email": "compradorteste@live.com",

"rating": "ADULT",

"phone": {

"number": "999994444",

"ddd": "11",

"ddi": "55"

},

"legal_document": "1234567890",

"customer_class": "Gold"

},

"unit_price": "1000",

"category_id": "other",

"gift_category": "OFF"

}

],

"extra_param": {

"acquirer_params": [

{

"key": "95",

"value": "Eu 17efine isso"

}

]

},

"anti_fraud": "enabled_before_auth",

"anti_fraud_institution": "AUTHORIZER",

"anti_fraud_criteria": "ALWAYS",

"finger_print_id": "074c1ee676ed4998ab66491013c565e2",

"returns_accepted": "true",

"journey_type": "OUTWARD"

}

}

Transferencia electronica

Sin particularidades en relación a otros métodos de pago.

Preautorización REST

Crédito

Es posible enviar el campo a continuación en el paso de ejecución de la autorización previa:

Parámetro	Descripción	Formato	Obligatorio
card
holder	Nombre del titular de la tarjeta impreso en la tarjeta	< 25 AN	NO
external_authentication
eci	Eletronic Commerce Indicator – indica el nivel de seguridad de la transacción con autenticación del titular de la tarjeta	< 3 N	NO
xid	Identificador de la operación de autenticación del titular de la tarjeta, realizada en un servicio externo al Portal Carat	< 40 N	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
cavv	Cardholder Authentication Verification Value - Código que indica el resultado de la autenticación del titular de la tarjeta.	< 40 N	NO
version	Versión de 3DS utilizada en el proceso de autenticación.	1 AN	SÍ para versão 2 do 3DS
reference_id	RequestID devuelto en proceso de autenticación.	36 AN	SÍ para versión 2 de 3DS

Crédito con análisis de fraude

Para realizar un crédito con análisis de fraude, es necesario enviar el campo additional_data que contiene información adicional antifraude. El formato de su valor es el mismo que se describe aquí.

Tras la devolución de la preautorización, se devolverán adicionalmente los siguientes campos:

Datos de análisis de fraude

Parámetro	Descripción	Formato
pre_authorization .analysis
code	Código de respuesta de la operación de análisis de fraude.	< 4 N
message	Mensaje de respuesta a la operación de análisis de fraude.	< 200 AN
status	Status de la transacción de Análisis de fraude de pagos en línea. Este campo puede tomar los siguientes valores: NOV – Nova. EXP – Expirada. ACC – Aceita REJ – Rejeitada REV – Em revisão INV – Inválida	= 3 AN

Plazos

Los datos de las cuotas deben enviarse en la etapa de vigencia de la autorización previa y si se envía NO, Portal Carat asume que la transacción es en efectivo. Luego, en la captura, se deben enviar los mismos datos de la cuota.

Preautorización HTML

Los temas a continuación se refieren al paso de creación de la transacción, en el que el comerciante envía un documento JSON a Portal Carat. Para obtener más información sobre cómo realizar una autorización previa a través de la interfaz HTML, consulte la página de autorización previa.

Crédito con / sin análisis de fraude

Los parámetros a enviar siguen el mismo formato que un pago HTML.

Plazos

En el paso de captura, se deben enviar los mismos datos de cuotas utilizados en la preautorización .

Cancelación REST

[Obtenga más información sobre esta interfaz].(cancelamento-rest-fluxo.md)

Tarjetas de prueba

Cielo proporciona el siguiente número de tarjeta para realizar la prueba:

Bandera	Número de tarjeta	Vencimiento	CVV
VISA	4024007197692931	12/2022	123

Restricciones

El enrutamiento CieloEC NO admite pagos tipo IATA (International Air Transport Association).

Campos de MCC dinámicos

Inicialización de preautorización o transacción de pago REST

Parámetros de solicitud

Además de los campos mencionados en Servicio de creación de transacciones REST, Los campos siguientes se utilizan en el escenario dinámico específico de MCC de integración con el Cielo ECommerce:

Elemento para enviar datos adicionales. Elemento de envío de datos referentes al comerciante de un subcomprador.

Parámetro	Descripción	Formato	Obligatorio
soft_descriptor	Frase personalizada que quedará impresa en la factura al portador. Para obtener información sobre el MCC dinámico, equivale al nombre del subinquilino.	< 18 AN	SÍ
additional_data
mcc	Substore MCC.	= 4 N	SÍ
subacquirer_merchant_id	Código de substore. Campo legado!!! Dar preferencia a additional_data.subacquirer_merchant.id	< 15 N	NO
additional_data.subacquirer_merchant
id	Código de substore.	< 15 N	SÍ
phone_number	Número de teléfono del subinquilino.	< 14 AN	NO
address	Dirección de substore.	< 48 AN	NO
city	Ciudad del subarrendatario.	< 13 AN	NO
state	Estado de subinquilino, en formato de acrónimo de dos dígitos (ex.: SP).	= 2 A	SÍ
country	País del subarrendatario. seguir el modelo ISO 3166-1 alpha-2 (ex.: BR).	= 2 A	SÍ
zip_code	Código postal del comerciante.	< 9 AN	SÍ
identification_number	CNPJ del propietario de la sub-tienda.	< 18 N	SÍ
payment_facilitator_id	Código de facilitador.	< 11 N	SÍ

Ejemplo

Requisição:

curl

--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-binary

{

"merchant_usn": "19035815234",

"order_id": "1616438400044",

"installments": "1",

"installment_type": "4",

"authorizer_id": "2",

"amount": "1300",

"soft_descriptor": "L012121",

"additional_data": {

"mcc": "1111",

"subacquirer_merchant": {

"id": "12345",

"address": "Avenida Paulista, 2000",

"city": "São Paulo",

"state": "SP",

"country": "BR",

"zip_code": "01107001",

"identification_number": "53455823000178",

"payment_facilitator_id": "654321",

"phone_number": "+55 11 99999-9999"

}

}

}

Resposta:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"status": "NOV",

"nit": "6215a32a557f5dc4627b540f517e40abd6a8411cf89a2e073913aa25d7c95590",

"order_id": "1616438400044",

"merchant_usn": "19035815234",

"amount": "1300"

}

}

Parámetros para efectuar el pago o la preautorización REST

Además de los campos mencionados en Servicio de pago REST y Servicio de autorización previa REST, Los campos siguientes se utilizan en el escenario dinámico específico de MCC de integración con el Cielo EC:

Parámetro	Descripción	Formato	Obligatorio
soft_descriptor	Frase personalizada que quedará impresa en la factura al portador. Para obtener información sobre el MCC dinámico, equivale al nombre del subinquilino. Requerido solo si NO se envía el soft_descriptor del paso de inicialización de la transacción.	< 18 AN	COND.
mcc	Substore MCC. Requerido solo si NO se envió en el additional_data.mcc del paso de inicialización de la transacción.	= 4 N	COND.
subacquirer_merchant_id	Código de substore. Requerido solo si NO se envió en el additional_data.subacquirer_merchant.id del paso de inicialización de la transacción.	< 15 N	COND.

¡ATENCIÓN!

Es en la ejecución que enviamos los datos MCC dinámicos acumulados. Sin embargo, si el campo mcc NO se envía en cualquier momento y no está registrado, se enviarán los otros campos de MCC NO dinámico. Este campo es necesario para identificar que el comerciante desea enviar datos de sub-adquisición.

Ejemplo

Requisição:

curl

--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/preauthorizations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-binary

{

"card": {

"number": "4024007197692931",

"expiry_date": "1222",

"security_code": "123"

}

}

Resposta:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"authorizer_code": "6",

"authorizer_message": "Operation Successful",

"status": "CON",

"nit": "6215a32a557f5dc4627b540f517e40abd6a8411cf89a2e073913aa25d7c95590",

"order_id": "1616438400044",

"customer_receipt":"=== CUSTOMER RECEIPT ===",

"merchant_receipt":"=== MERCHANT RECEIPT ===",

"authorizer_id": "2",

"acquirer_id": "201",

"acquirer_name": "Cielo e-Commerce",

"authorizer_date": "22/03/2021T15:40",

"authorization_number": "316176",

"merchant_usn": "19035815234",

"esitef_usn": "210322068747730",

"host_usn": "362400",

"tid": "9fcd1663-0662-4761-9b9b-b269217cfc32",

"amount": "1300",

"payment_type": "C",

"authorizer_merchant_id": "6d29e58f-b29f-4e7e-8bf2-4d53b71acc1e",

"payment_date": "22/03/2021T15:40"

}

}

Tabla de correspondencia de campo

A continuación se muestra la tabla de correspondencia entre los campos dinámicos de MCC definidos por la interfaz de Cielo ECommerce y los campos de Portal Carat.

Campo Cielo EC	Campo Portal Carat	Comentarios
Softdescriptor(1)	soft_descriptor	O campo soft_descriptor do Pagamento Online Puede enviarse en el paso de creación de la transacción o registrarse por el equipo de servicio en Portal Carat.
EstablishmentCode(3)	additional_data / subacquirer_merchant / payment_facilitator_id o paymentFacilitatorId	El campo PaymentFacilitatorID de Cielo ECommerce puede enviarse en el paso de creación de la transacción o configurarse cuando se realiza un enrutamiento de autorización a través de e.Rede REST. En este último caso, su valor se puede cambiar a través del Portal del comerciante. ("Autorizadoras" > "Configurar Autorizadoras") o mediante solicitud al equipo de servicio de Portal Carat.
Mcc(2)	additional_data / mcc ou mcc	El campo mcc del Portal Carat se puede enviar en el paso de creación de la transacción, en la ejecución del pago o de la preautorización REST o bien registrado por el equipo de servicio de Portal Carat.
EstablishmentCode(2)	additional_data / subacquirer_merchant_id ou additional_data / subacquirer_merchant / id ou subacquirer_merchant_id ou subacquirerMerchantId	El campo SubMerchant / SubMerchantID se puede enviar en el paso de creación de la transacción, en el paso de preautorización de pago o REST, o se puede configurar cuando se realiza un enrutamiento de autorización a través de Cielo ECommerce.En este último caso, su valor se puede cambiar a través del Portal del comerciante. ("Autorizadoras" > "Configurar Autorizadoras") o mediante solicitud al equipo de servicio de Portal Carat.
Identity(2)	additional_data / subacquirer_merchant / identification_number	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
Address(2)	additional_data / subacquirer_merchant / address	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
City(2)	additional_data / subacquirer_merchant / city	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
State(2)	additional_data / subacquirer_merchant / state	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
CountryCode(2)	additional_data / subacquirer_merchant / country	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
PostalCode(2)	additional_data / subacquirer_merchant / zip_code	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.
PhoneNumber(2)	additional_data / subacquirer_merchant / phone_number	Este campo se puede enviar al crear la transacción. Es posible registrar un valor predeterminado. Comuníquese con Portal Carat para registrarse o cambiar el valor predeterminado de este campo en su tienda.

Leyenda de estructuras
(1) Estrutura Payment
(2) Estrutura PaymentFacilitator.SubEstablishment
(3) Estrutura PaymentFacilitator