Boleto Citibank
El Carat permite el pago de billetes a través de Citibank.
Esta página utilizará la nomenclatura "Citibank" para hacer referencia al enrutamiento en Carat.
Interfaces Carat compatible con la integración#
Puede utilizar las siguientes interfaces para la integración de enrutamiento Citibank:
- Pago REST
- Pago HTML
- Reimpresión de Billetes
Credenciales requeridas#
La tienda debe obtener de Citibank las credenciales que se enumeran a continuación, y pasarlos a Software Express.
| Campo | Descripción del campo | Formato | Obligatorio |
|---|---|---|---|
codigoBeneficiario | Código de acuerdo de la empresa (tienda) en Citibank. | = 20 N | Sí |
codigoAgenciaBeneficiario | Agencia de la empresa en Citibank | ≤ 5 N | Sí |
mensagemBeneficiario | Mensaje del beneficiario. No utilice caracteres especiales que no sean “/”, “-“ , “;” o "@". | ≤ 40 N | Sí |
La tienda también puede solicitar la configuración de algunos parámetros de billete con valores predeterminados con Software Express.
| Campo | Descripción del campo | Formato | Obligatorio |
|---|---|---|---|
quantidadeDiasCalculoVencimento | Número de días para calcular la fecha de vencimiento de la facturación estándar. | ≤ 2 N | No |
mensagemReciboPagador | Mensaje predeterminado que se muestra en el área de recibo de pago del billete. Obs.: hasta dos líneas con un máximo de 40 caracteres. | ≤ 40 AN | No |
mensagemFichaCompensacao | Mensaje predeterminado que se muestra en el área del comprobante de pago. Obs.: hasta dos líneas con un máximo de 40 caracteres. | ≤ 40 AN | No |
Flujo de pago con Citibank#
- Generado con éxito el billete.
- La transacción de pago permanecerá en estado 'Processado'.
- El comerciante recibirá de Citibank un archivo con los datos de los recibos y situación, informando si fueron pagados.
Pago REST#
El pago del billete sigue el flujo de pago normal
Crear transacción#
Más detalles en el tema Crear transacción
Ejemplo:
Ejecución de pago#
Más detalles en el tema Ejecución de pago
La respuesta de pago del efecto devuelve algunos datos únicos del comprobante de pago
| Campo | Descripción |
|---|---|
| payment.boleto | Detalles específicos de pago con billete |
digitable_line | línea digital |
url | Url para ver el billete |
Ejemplo de requisición:
Ejemplo de respuesta:
Web Checkout#
Crear transacción#
Más detalles en el tema Crear transacción
Ejemplo:
Datos opcionales en Web Checkout#
Si no se envían los datos de Nombre, Documento y Dirección del comprador, se mostrará un formulario para que el comprador complete.
Datos necesarios#
Para que um pagamento via boleto bancário seja feito pelo usuário, é necessário que a loja envie para o Carat as seguintes informações dentro do objeto additional_data na criação da transação:
| Campo | Descripción | Formato | Obligatorio |
|---|---|---|---|
| additional_data.payer | |||
name | Nombre del comprador. Obs.: la concatenación de nombre con apellido no puede exceder los 255 caracteres. | < 200 AN | SÍ |
surname | Apellido del comprador. Obs.: la concatenación del nombre con el apellido no puede exceder los 255 caracteres. | < 200 AN | SÍ |
| additional_data.payer.address | |||
street_name | Dirección del comprador. | < 255 AN | SÍ |
street_number | Número de dirección del comprador. | < 15 AN | SÍ |
complement | Complemento a la dirección del comprador. | < 50 AN | NO |
zip_code | Código Postal de la dirección del comprador. | < 9 AN | SÍ |
city | Ciudad de la dirección del comprador. | < 50 AN | NO |
state | Estado de la dirección del comprador. | = 2 AN | NO |
country | Dirección del comprador país siguiente a la AN 3166-1. Ej.: BRA | = 3 AN | NO |
| additional_data.boleto | |||
assignor_code | Código de acuerdo bancario | = 20 N | No |
bank_issuer_code | Relación agencia/número de acuerdo | < 7 AN | No |
boleto_number | Código de identificación del billete. Si no se envía, el banco debe generar un | < 14 N | No |
your_number | Número utilizado y controlado por el Cliente, para identificar el título de facturación. | < 11 AN | No |
expiration_date | Fecha de caducidad del billete en el formato dd/mm/aaaa. Obs.: Si no se envía, se generará en función de la configuración predeterminada del autorizador | < 10 AN | No |
issue_date | Fecha de emisión del billete en el formato dd/mm/aaaa. Obs.: Si no se envía, se generará en base a la fecha actual | < 10 AN | No |
specie_type | Código adoptado para identificar el tipo de documento de cobro: 01 - Cheque 02 - Comercio Duplicado 03 - Comercio Duplicado p/ Indicación | = 02 N | Sí |
fine_date | Fecha a partir de la cual se debe cobrar la multa. En su defecto, se tendrá en cuenta la fecha de vencimiento. | = 10 AN | No |
fine_amount | Importe en centavos de la sanción por retraso en el pago. | < 12 AN | No |
fine_percentage | Porcentaje de multa a aplicar sobre el valor del Título, por mora. | < 12 N | No |
company_identification | Campo destinado a ser utilizado por la Empresa Beneficiaria para identificar el Título. | < 25 AN | No |
iof_amount | valor de IOF para ser recogido | < 12 N | No |
assignor | Nombre del beneficiario | < 40 AN | No |
| additional_data.payer.assignor_document | Documento de beneficiario. Obs: Si no se envía, se utilizará un documento configurado en la tienda | ||
type | Tipo de Documento | CPF o CPNJ | No |
number | Número del Documento | < 14 N | No |
| additional_data.payer.assignor_address | Dirección del beneficiario. Obs: Si no se envía, se utilizará la dirección configurada en la tienda. | ||
street_name | Dirección del beneficiario. | < 255 AN | SÍ |
street_number | Número de domicilio del beneficiario. | < 15 AN | SÍ |
complement | Complemento de dirección del beneficiario. | < 50 AN | NO / NO |
zip_code | Código Postal de la dirección del beneficiario. | < 9 AN | SÍ |
city | Ciudad de la dirección del beneficiario. | < 50 AN | NO |
state | Estado de la dirección del beneficiario. | = 2 AN | NO |
| additional_data.boleto.instructions[] | |||
message | Texto de observaciones destinado al envío de mensajes gratuitos, para ser impreso en el campo de instrucciones del Formulario de Compensación Obs.: Si no se envía, se utilizará la configuración predeterminada del autorizador | < 40 N | No |
| additional_data.boleto.receipt_messages[] | |||
message | Texto de las observaciones destinadas al envío de mensajes gratuitos, a imprimir en el Recibo del Pagador parte del billete Obs.: Si no se envía, se utilizará la configuración predeterminada del autorizador | < 40 N | No |
| additional_data.boleto.payment | |||
allowed_quantity | Cantidad de posibles pagos | < 2 N | No |
type | Identificación del tipo de pago | < 35 AN | Sí |
minimum_amount | Monto mínimo admisible para el pago. | < 12 N | No |
maximum_amount | Monto máximo admisible para el pago. | < 12 N | No |
minimum_percentage | Valor del porcentaje mínimo admisible para el pago. | < 12 N | No |
maximum_percentage | Valor del porcentaje máximo admisible para el pago. | < 12 N | No |
Reimpresión de billete#
Es posible poner a disposición de los compradores la Reimpresión de los recibos de Citibank.
Esta funcionalidad está disponible a través de URL:
| Entorno de Producción |
|---|
| https://esitef-ec.softwareexpress.com.br/e-sitef/reissue.se?nit=XXX |
| Ambiente de Homologação |
| https://esitef-homologacao.softwareexpress.com.br/e-sitef-hml/reissue.se?nit=XXX |
Debes informar como parámetro del GET el nit utilizado de la transacción de pago original, realizada a través de Boleto Citibank. Acceder a esta URL permite visualizar el billete.
Si la transacción de pago no se encuentra en el estado esperado, se muestra un mensaje de error.
Atención
Nunca se debe usar la IP en lugar del dominio esitef-ec.softwareexpress.com.br (o esitef-homologacao.softwareexpress.com.br para entorno de aprobación). El IP puede cambiar en cualquier momento y sin previo aviso, por lo que es importante utilizar siempre el dominio para acceder el Carat.