Banco de Brasil
Esta documentación describe la integración con la plataforma de pago Banco do Brasil. También se explican los ajustes que deben realizarse necesariamente en el entorno de Portal Carat.
Interfaces de Portal Carat compatibles para la integración#
La tienda puede utilizar los siguientes servicios de Portal Carat para la integración con la plataforma Banco do Brasil (los documentos respectivos deben ser consultados para más detalles):
- Interfaz de pago HTML
- Reedición de facturas
Configuración necesaria de Portal Carat#
Antes de realizar transacciones de Banco do Brasil con Portal Carat, se deben seguir los siguientes pasos de configuración.
Datos de registro del Banco do Brasil#
La tienda debe tener una cuenta activa con Banco do Brasil para realizar una transacción.
La siguiente tabla muestra las credenciales del Banco do Brasil que debe obtener la tienda y los datos adicionales a ingresar en el comprobante bancario, que luego se registrarán en el Portal Carat:
| Nombre del parámetro | Descripción
| Formato | Obligatorio|
| :---------------: | :-----------------------------------------------------------------------------------------------------------------: | :------------: | :---------: |
| idConvComercio | Identificador de acuerdo de Comercio Electrónico del Banco do Brasil
| 6 N | SÍ |
| idConvCobranca | Identificador de convenio de cobranza en Banco do Brasil | < 7 N | SÍ |
| diasVencimento | Número de días que se deben agregar a la fecha de generación del comprobante de pago que darán como resultado la fecha de vencimiento del comprobante. | N | SÍ |
| mensagem_boleto | Mensaje que se mostrará en la zona de observaciones del boleto generado. | 480 N | NO |
También es necesario que algunos datos relativos al Portal Carat sean configurados en el portal del Banco do Brasil, en la cuenta del cliente:
Valores durante la etapa de Homologación:
URL de Retorno: https://esitef-homologacao.softwareexpress.com.br
URL de Informação: https://esitef-homologacao.softwareexpress.com.br
Tan pronto como se finalice la homologación y se active la tienda en producción, los valores registrados deben ser modificados:
Valores para el entorno Producción :
URL de Retorno: https://esitef-ec.softwareexpress.com.br
URL de Informação: https://esitef-ec.softwareexpress.com.br
Ingrese los datos de registro en el Portal Carat#
Teniendo en mano los datos de registro de Banco do Brasil mencionados anteriormente, el comerciante debe solicitar al equipo de servicio de Portal Carat:
- La activación de Banco do Brasil como autorizador activo en el registro de Portal Carat.
- Si no dispone de usuario y contraseña para acceder al Portal del Comerciante en Portal Carat.
Una vez que el autorizador Banco do Brasil sea asociado a la tienda, el comerciante debe acceder al Portal del Comerciante e informar los datos de registro del Banco do Brasil en el ítem Configuración del autorizador, con los parámetros idConvComercio , idConvCobranca, diasVencimento, messagem_boleto mencionado anteriormente.
Para obtener más detalles sobre cómo registrar estos datos en el portal del comerciante, consulte el ítem sobre el Portal del comerciante - Configuración de autorización.
Código de autorización del Banco do Brasil en el Portal Carat#
Para realizar pagos con el autorizador predefinido, envíe una de las siguientes identificaciones de autorizador refiriéndose a Banco do Brasil:
- 404 - Factura
- 415 - Débito PF
- 416 - Débito PF y PJ
- 417 - Crediário
Parámetros para pago HTML vía Banco do Brasil#
Sobre el flujo inicial para iniciar una transacción HTML en Portal Carat con Banco do Brasil, vea el ítem sobre el [Pago HTML] (pagamento-html-begin).
Nota: Los datos referentes a cuotas no se transfieren al Banco do Brasil.
Atención: Las transacciones realizadas con Banco do Brasil, cuando el cliente haya optado por generar un comprobante bancario, tendrán su status final como Procesado (PRO), NO significa que ya hayan pagado, pero solo que fue emitido. Este comportamiento se debe a la falta de herramientas para dicha verificación por parte del Banco do Brasil.
Parámetros para transacción vía Banco do Brasil#
El comerciante puede enviar los parámetros del Banco do Brasil para generar facturas a través de Portal Carat.
Objeto additional_data#
En el objeto JSON additional_data, se pueden enviar los siguientes parámetros:
| Parámetro | Descripción
| Formato
| Obligatorio |
| :-----------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :---------: |
| discount_amount | Importe de descuento en centavos. Se utiliza sólo para las facturas. | < 12 N | NO |
| discount_limit_date | Fecha de vencimiento del descuento en formato DDMMYYYY.
Se usa solo para las facturas.
| 8 N | NO |
| duplicata_type | Informa el tipo de título que originará la factura:
DM - Duplicata Mercantil - utilizado cuando se venden bienes/productos;
DS - Duplicata de serviços - cuando la tienda virtual vende la prestación de servicios. | 2 A | SIM¹ |
- ¹ Obligatorio para palanquilla.
Objeto additiona_data.payer#
En el objeto additional_data.payer, se pueden enviar los siguientes parámetros:
| Parámetro | Descripción
| Formato | Obligatorio |
| :-----------------------: | :------------------------------------------------------------------------------------------------------------: | :-----------: | :---------: |
| name | Nombre del comprador.
| AN & sup2; | SÍ |
| surname | Apellido del comprador.
| AN² | SÍ |
| address_street_name | Dirección del comprador.
| AN³ | SÍ |
| address_street_number | Número de dirección del comprador.
| AN³ | SÍ |
| address_street_complement | Complemento de la dirección del comprador. | AN³ | SÍ |
| address_zip_code | Código Postal del comprador | 8 N | SÍ |
| city | Ciudad del comprador
| < 18 A | SÍ |
| state | Estado (UF) del comprador | < 2 A | SÍ |
| identification_number | Número de documento (CPF o CNPJ) del comprador, sin formato. | < 14 N | SIM¹ |
| identification_type | Indica que el campo identification_number enviado representa:
1 - pessoa física
2 - pessoa jurídica | 1 N | SIM¹ |
¹ Obligatorio para factura.
² El tamaño de los campos name y surname sumados no puede ser superior a 59 caracteres. Se cuenta un espacio de un carácter entre los campos, para hacer un total de 60 caracteres.
³ El tamaño de los campos address_street_name, address_street_number y address_street_complement no debe ser superior a 58 caracteres. Se cuenta un espacio de un carácter entre cada uno de los campos, para hacer un total de 60 caracteres.
Nota : Tamaños de campo según documentación proporcionada por Banco do Brasil .
Flujo de pago del Banco do Brasil#
Después de enviar los datos de creación de la transacción y elegir el método de pago Banco do Brasil , se iniciará el siguiente flujo de pantallas:
La siguiente figura muestra la pantalla antes de la redirección del comprador.
La siguiente figura muestra la pantalla del Banco do Brasil, donde se realiza el pago:
Reedición de facturas#
Portal Carat pone a disposición la reemisión de los comprobantes bancarios del Banco do Brasil. Para ello, simplemente redirija al comprador a la siguiente URL:
https://esitef-homologacao.softwareexpress.com.br/e-sitef/reissue.se?nit=XXXXXXXXXXXXX
(homologação)https://esitef-ec.softwareexpress.com.br/e-sitef/reissue.se?nit=XXXXXXXXXXXXX
(produção)
El envío del parámetro nit es obligatorio y debe referirse a una transacción de pago con status Procesado (PRO) con el autorizador del Banco do Brasil.
Si la transacción de pago no se encuentra en el estado esperado, se muestra la siguiente pantalla:
Simplemente al acceder a esta URL ya permite la visualización directa de la factura reemitida con los mismos datos que la primera emisión, como se muestra en la figura abajo:
Ejemplo de solicitud en Pago HTML#
URL de endpoint en el entorno de homologación:
https://esitef-homologacao.softwareexpress.com.br/e-sitef/init.se
Ejemplo del parámetro “request” con los parámetros de la transacción Portal Carat + datos del Banco do Brasil (additional_data) en formato JSON: