E.Rede

La tienda tiene la capacidad de configurar el enrutamiento de las transacciones realizadas con tarjetas de crédito y débito en el Portal Carat por diversos medios de pago, uno de estos medios es el e.Rede REST. Esta es la plataforma de comercio electrónico del adquirente Rede.

Se utilizará la nomenclatura "e.Rede REST" para hacer referencia a la ruta en el Portal Carat.

Atención: Portal Carat tiene enrutamiento e-Rede, sin embargo, esta integración es una versión anterior con funcionalidad limitada y ya no admitirá actualizaciones. Por tanto, la opción e.Rede REST se recomienda actualmente.

Interfaces Portal Carat apoyado para la integración#

Puede utilizar las siguientes interfaces para la integración con el enrutamiento e.Rede REST:

Pago REST
Autorización previa de REST
Captura de REST
Cancelación de REST
Pago HTML
Autorización previa HTML
Cancelación en Portal del Comerciante

Credenciales requeridas#

La tienda debe obtener las credenciales que se enumeran a continuación de e.Rede , y pasarlas a Software Express o registrarse en Portal Carat Portal del Comerciante, como se explicará más adelante en este documento.

Campo	Descripción	Formato
`filiation`	Código identificador generado por la Red para establecimientos afiliados. El PV (punto de venta) es único para cada establecimiento.	< 8 AN
`token`	Código de seguridad generado por la Red utilizado para garantizar la integridad de la transacción. Es parte, junto con el PV, de las credenciales de autenticación de API.	< 32 AN
`threeDSecureOnFailure`	Indica si se debe continuar con la autorización en caso de error de autenticación de 3DS	no procede ni procede
`subacquirerMerchantId`	Código de sub tendero. Solo se puede usar cuando se usa Dynamic MCC	< 32 AN
`independentSalesOrganizationId`	Código de organización de ventas independiente. Solo se puede usar cuando se usa Dynamic MCC	< 11 AN
`paymentFacilitatorId`	Código de facilitador. Solo se puede utilizar cuando se utiliza Dynamic MCC.	< 11 N

Aviso 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 por Portal del Comerciante Portal Carat#

El dueño de la tienda puede registrar la información obtenida con el e.Rede en Portal del Comerciante del 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:

Portal e.Rede REST -no-filter

Descubra más detalles sobre elPortal del Comerciante.

Flujos#

En este apartado se presentarán las particularidades del flujo transaccional e.Rede REST.

Atualmente, o e.Rede REST no permite cuotas que devengan intereses de la compañía de tarjetas, es decir, el campo installments_type NO pode receber os valores 3 ou 6. O campo installments permite o máximo de 12 parcelas.

Criação de Transação de Pagamento (HTML e REST)#

MCC Dinâmico#

Campos relevantes na chamada descrita no Serviço de criação de transação HTML e no Serviço de criação de transação REST:

Elemento para enviar datos adicionales.

Parámetro	Descripción	Formato	Obligatorio
`soft_descriptor` (*)	Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. Sepa mas	< 13 AN	NO
additional_data
`mcc` (*)	El MCC (Merchant Category Code) Es un código que clasifica a una empresa por el tipo de bienes o productos suministrados.	< 4 N	NO
`postpone_confirmation`	Campo que permite a la tienda mantener la transacción como Pendiente de Confirmación, y luego confirmarla o cancelarla.	< 5 A	NO
iata	Este elemento contiene campos específicos que serán obligatorios, si las transacciones son con IATA.
`code`	Código iata de la empresas en el segmento del transporte aéreo.	< 9 N	Condicional (uso obligatorio solo para transacciones IATA - venta de boletos aéreos)
`departure_tax`	Impuesto de salida en centavos.	< 10 N	Condicional (uso obligatorio solo para transacciones IATA - venta de boletos aéreos)

(*) Aviso sobre SoftDescriptor y MCC: En el contexto de marketplace o facilitador de pagos, se permite utilizar ambos campos mediante solicitud o utilizando datos registrados en el backoffice del Portal Carat. Los valores enviados mediante solicitud tienen prioridad sobre los valores registrados. Adicionalmente, para el mismo contexto, se puede registrar en el Portal Carat el ID de SubLoja para ser informado sobre el pago. Sobre el registro de estos valores, póngase en contacto con el equipo de atención al cliente Portal Carat.

Autenticación 3DS Rede#

Nota: Esta interfaz es compatible con la autenticación 3DS 2.0. Sepa mas.

Campos relevantes en la convocatoria descrita en Servicio de creación de Transacciones HTML y en el Servicio de Creación de Transacciones REST:

Parámetro	Descripción	Formato	Obligatorio
`authorizer_authentication`	Define si el comerciante desea un pago con autenticación en la autoridad autorizante. Mandar `true` si positivo.	< 5 AN	SI para crédito con autenticación

Es posible realizar un pago con la autenticación de MPI 3DS Rede, siempre que esta funcionalidad esté activa en la cuenta del comerciante en el e.Rede. Para utilizar esta función en Portal Carat, solo envía el Parámetro authorizer_authentication con valor true en el paso de creación de la transacción.

Para pagos con tarjeta de débito, la autenticación es obrigatória, NO estar en el caso de Auxílio Emergencial.

Ejemplo de solicitud de pago de creación de transacción REST:

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":"123456789",
    "order_id":"pedido001",
    "amount":"2200",
    "authorizer_id":"2",
    "installments":"2",
    "installment_type":"4",
    "authorizer_authentication":"true"
}
--verbose

En caso de falla de autenticación, el comerciante puede optar por continuar con el pago o interrumpir el pago (NO continuar). Este comportamiento debe registrarse en el backoffice del Portal Carat, su valor predeterminado es Não prosseguir caso a autenticação falhe. Para esta configuración, consulte con el equipo de atención al cliente Portal Carat o esto se puede hacer a través de Portal del Comerciante.

Pago REST#

Nota: Esta interfaz es compatible con la autenticación 3DS 2.0. Sepa mas.

Esta interfaz admite el envío de datos de autenticación 3DS externos en la etapa de pago. Sepa mas.

Esta integración admite el uso de la cartera digital. Visa Checkout.

Campos relevantes en la convocatoria descrita en la etapa de pago:

Parámetro	Descripción	Formato	Obligatorio
`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	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
`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	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
`reference_id`	RequestID devuelto en el proceso de autenticación.	36 AN	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)

Pago HTML#

En el caso de pago con tarjeta de débito que NO sea elegible para asistencia de emergencia, el Portal Carat forzará la autenticación 3DS con MPI Rede, independientemente de la presentación de campo authorizer_authentication en el paso de creación de la transacción.

Esta integración admite el uso de la cartera digital. Masterpass.

La Confirmación del Pago#

Es posible confirmar un valor menor que el valor de las autorizaciones creadas via HTML o via REST usando el campo additional_data.postpone_confirmation igual a true.

Para ello, envíe la confirmación REST el valor de amount deseado:

Parámetro	Descripción	Formato	Obligatorio
`confirm`	Este campo debe enviarse con el valor `true` si desea confirmar la transacción, o `false`, en caso de que desee deshacer el pago.	< 5 T/F	SI
`amount`	Valor en centavos del valor que se confirmará. Si se envía NO, se confirmará el monto total de la transacción.	< 12 N	NO

En la e.Rede REST, la confirmación de pago genera una nueva "NSU autorizador" y una "fecha de vigencia del pago".

Preautorización REST#

Nota: Esta interfaz es compatible con la autenticación 3DS 2.0. Sepa mas.

Esta interfaz admite el envío de datos de autenticación externos 3DS en la etapa de preautorización. Sepa más.

También es posible enviar los campos soft_descriptor y mcc en el paso de creación de la transacción, de la misma manera que en el Pago REST (ver arriba)

Esta integración admite el uso de Cartera digital. Visa Checkout.

Campos relevantes en la convocatoria descrita en la etapa de preautorización:

Parámetro	Descripción	Formato	Obligatorio
`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	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
`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 o resultado da autenticação do dono do cartão.	< 40 N	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)
`reference_id`	RequestID devuelto en el proceso de autenticación.	36 AN	Condicional (uso obligatorio solo para transacciones autenticadas de 3DS 2.0)

En el flujo de preautorización / captura, los datos de las cuotas deben enviarse solo en la preautorización.

Preautorización HTML#

Esta integración acepta el uso de la cartera digital Masterpass.

También es posible enviar los campos soft_descriptor y mcc en el paso de creación de la transacción, de la misma manera que en el Pago HTML (ver arriba).

En el flujo de preautorización / captura, los datos de las cuotas deben enviarse solo en la preautorización.

Reaparición#

La e.Rede REST acepta los parámetros de señalización de recurrencia de transacciones. Para ello, envíe el campo en la llamada de pago REST. acquirer.recurrency igual que valor true. Si NO es la primera transacción de la recurrencia, envíe también el TID de la primera transacción de la recurrencia en el campoacquirer.recurrency_tid.

Para obtener más información, consulte la página sobre Servicio de eficiencia de pago REST.

Se requieren datos específicos según el adquirente / enrutamiento.

Parámetro	Descripción	Formato	Obligatorio
acquirer
`recurrency`	Flag que define si el pago es recurrente o NO.	< 5 T/F	NO
`recurrency_tid`	Id. De transacción (TID) en el indicador, que se refiere a la primera transacción de la recurrencia. Identificador que diferencia la primera recurrencia de las posteriores. Solo se usa cuando se trata de una recurrencia. Campo utilizado solo para banderas Visa y Mastercard.	< 16 AN	NO

Cancelación#

La cancelación de una transacción se puede hacer enPortal del Comerciante o vía Web Service REST.

Las solicitudes de cancelación se pueden realizar en un plazo de 7 días para transacciones de débito y para transacciones de crédito el valor predeterminado es de hasta 90 días, pero puede variar según la rama de actividad de cada establecimiento.

Para cancelaciones solicitadas el mismo día de la transacción de autorización o autorización con captura automática, el procesamiento se realizará de inmediato, en caso contrario, el procesamiento se realizará el D + 1.

Cancelación parcial disponible solo en D + 1 y para transacciones con captura.

Campos de MCC dinámicos#

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

Solicitar parámetros#

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 e.Rede REST:

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	SI
additional_data
`mcc`	MCC do subinquilino.	= 4 N	SI
`subacquirer_merchant_id`	Código de subinquilino. Campo legado!!! Dar preferencia a `additional_data.subacquirer_merchant.id`	< 15 N	NO
additional_data.subacquirer_merchant
`id`	Código del subinquilino	< 15 N	SI
`address`	Dirección de subinquilino.	< 48 AN	NO
`city`	Ciudad de subinquilino.	< 13 AN	NO
`state`	Estado de subinquilino, en formato de acrónimo de dos dígitos (ex.: SP).	= 2 A	SI
`country`	País del subinquilino. seguir el modelo ISO 3166-1 alpha-2 (ex.: BR).	= 2 A	SI
`zip_code`	Código postal de subinquilino.	< 9 AN	SI
`identification_number`	CNPJ del subinquilino.	< 18 N	SI
`payment_facilitator_id`	Código del facilitador.	< 11 N	SI
`independent_sales_organization_id`	Código de la organización de ventas independiente.	< 11 N	NO

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": "21042858195",
    "order_id": "21042858195",
    "amount": "102",
    "installments": "1",
    "installment_type": "4",
    "mcc": "1111",
    "soft_descriptor": "LOJADOZE",
    "additional_data": {
         "subacquirer_merchant": {
            "id": "1234567890",
            "address": "Rua Acre",
            "city": "CAPIVARI",
            "state": "SP",
            "country": "BR",
            "zip_code": "07064-010",
            "identification_number": "71.789.371/0001-42",
            "payment_facilitator_id": "22349202212",
            "independent_sales_organization_id": "1234567"
        }
    }
}

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "pre_authorization": {
        "status": "NOV",
        "nit": "c2d2887a2961a218e6e6effa8a39f281d386d581c8c8b4dc23a3af03b5c6b8c4",
        "order_id": "21042858195",
        "merchant_usn": "21042858195",
        "amount": "102"
    }
}

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

Además de los campos mencionados en Servicio de pago REST y Serviço de efetivação de Pré-Autorização REST, Los campos siguientes se utilizan en el escenario dinámico específico de MCC de integración con el e.Rede REST:

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, es equivalente al nombre del subinquilino. Obligatorio solo si NO se envió el `soft_descriptor` del paso de inicialización de la transacción.	< 18 AN	COND.
`mcc`	MCC del subinquilino. Obligatorio solo si NO se envió el `additional_data.mcc` del paso de inicialización de la transacción.	= 4 N	COND.
`subacquirer_merchant_id`	Código de subinquilino. Obligatorio solo si NO se envió el `additional_data.subacquirer_merchant.id` del paso de inicio 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 o se registra, los otros campos de MCC NO dinámico serán transferidos. Este campo es necesario para identificar que el comerciante desea enviar datos de sub-adquisición.

Ejemplo#

Requisición:

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
{
    "authorizer_id":"2",
    "installments":"1",
    "installment_type":"4",
    "soft_descriptor":"outraloja",
    "mcc": "2234",
    "subacquirer_merchant_id": "223456",
    "card":{
        "number":"5448280000000007",
        "expiry_date":"0121",
        "security_code":"123"
    }
}

Respuesta:

{
    "code":"0",
    "message":"OK. Transaction successful.",
    "pre_authorization":{
        "authorizer_code":"000",
        "authorizer_message":"Transacao OK.",
        "status":"CON",
        "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "customer_receipt":"=== CUSTOMER RECEIPT ===",
        "merchant_receipt":"=== MERCHANT RECEIPT ===",
        "authorizer_id":"2",
        "authorizer_date":"09/11/2018T19:40",
        "acquirer_id":"1005",
        "acquirer_name":"Redecard",
        "authorization_number":"013245",
        "merchant_usn":"20190101",
        "esitef_usn":"181109017689784",
        "order_id":"orderID",
        "sitef_usn":"212194",
        "host_usn":"999212194",
        "amount":"100",
        "issuer":"2",
        "payment_type":"C",
        "authorizer_merchant_id":"000000000000000"
    }
}

Tabla de correspondencia de campos#

A continuación se muestra la tabla de correspondencia entre los campos dinámicos de MCC definidos por interface do e.Rede REST y los campos del Portal Carat.

Campo e.Rede REST	Campo Portal Carat	Observaciones
softDescriptor	soft_descriptor	El campo softDescriptor de e.Rede REST se puede enviar en el paso de creación de la transacción, previo pago o preautorización de REST, o registrado por el equipo de servicio al cliente Portal Carat.
PaymentFacilitatorID	additional_data / subacquirer_merchant / payment_facilitator_id ou paymentFacilitatorId	El campo PaymentFacilitatorID de e.Rede REST se puede enviar en el paso de creación de la transacción o configurarse cuando una autoridad de autorización se enruta 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 por solicitud al equipo de servicio del Portal Carat.
IndependentSalesOrganizationID	additional_data / subacquirer_merchant / independent_sales_organization_id ou independentSalesOrganizationId	El campo IndependentSalesOrganizationID de e.Rede REST puede enviarse en el paso de creación de la transacción o configurarse cuando una autorización de autorización se enruta 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 por solicitud al equipo de servicio del Portal Carat.
SubMerchant / MCC	additional_data / mcc ou mcc	El campo SubMerchant / MCC de e.Rede REST se puede enviar en el paso de creación de la transacción, previo pago o preautorización de REST, o registrado por el equipo de servicio al cliente Portal Carat.
SubMerchant / SubMerchantID	additional_data / subacquirer_merchant_id ou additional_data / subacquirer_merchant / id ou subacquirer_merchant_id ou subacquirerMerchantId	El campo SubMerchant / SubMerchantID de e.Rede REST 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 una autorización de autorización se enruta a través de e.Rede REST . En el último caso, su valor se puede cambiar por Portal del Comerciante ("Autorizadoras" > "Configurar Autorizadoras") o por solicitud al equipo de servicio del Portal Carat.
SubMerchant / Address	additional_data / subacquirer_merchant / address	EL campo SubMerchant / Address de e.Rede REST se puede enviar en la creación de 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.
SubMerchant / City	additional_data / subacquirer_merchant / city	El campo SubMerchant / City de e.Rede REST se puede enviar en la creación de 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.
SubMerchant / State	additional_data / subacquirer_merchant / state	El campo SubMerchant / State de e.Rede REST se puede enviar en la creación de 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.
SubMerchant / Country	additional_data / subacquirer_merchant / country	el campo SubMerchant / Country de e.Rede REST se puede enviar en la creación de 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.
SubMerchant / CEP	additional_data / subacquirer_merchant / zip_code	El campo SubMerchant / CEP de e.Rede REST se puede enviar en la creación de 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.
SubMerchant / Cnpj	additional_data / subacquirer_merchant / identification_number	El campo SubMerchant / Cnpj de e.Rede REST se puede enviar en la creación de 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.

¡ATENCIÓN!
Cuando un campo se puede enviar de más de una forma, siempre tendrá prioridad el valor del campo enviado más recientemente o del campo más específico . En otras palabras, la prioridad sigue la regla: más reciente> más específico> catastral.
Ejemplo: si el campo SubMerchant / SubMerchantID se envía al finalizar, tendrá prioridad sobre el enviado al inicio, que tiene prioridad sobre el campo de registro.

Home

Interfaces Portal Carat apoyado para la integración#

Credenciales requeridas#

Registro de información por Portal del Comerciante Portal Carat#

Flujos#

Criação de Transação de Pagamento (HTML e REST)#

MCC Dinâmico#

Autenticación 3DS Rede#

Pago REST#

Pago HTML#

La Confirmación del Pago#

Preautorización REST#

Preautorización HTML#

Reaparición#

Cancelación#

Campos de MCC dinámicos#

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

Solicitar parámetros#

Ejemplo#

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

Ejemplo#

Tabla de correspondencia de campos#