EPX
La tienda tiene la posibilidad de configurar el enrutamiento de las transacciones realizadas con tarjeta de crédito en Portal Carat mediante varios métodos de pago, uno de estos medios es el EPX.
Interfaces de Portal Carat compatibles para la integración#
Puede utilizar las siguientes interfaces para la integración con el enrutamiento EPX:
- Autorización previa REST
- Pago REST
- Cancelación REST
- Pago HTML
- Preautorización HTML
- Cancelación en el Portal del Comerciante
Credenciales requeridas#
La tienda debe obtener las credenciales que se enumeran a continuación con el EPX y pasarlas a Software Express o registrarse en el Portal del Comerciante de Portal Carat.
| Parámetro | Descripción |
|---|---|
CUST_NBR | Nivel de jerarquía del banco patrocinador del comerciante en los sistemas internos de la EPX. |
MERCH_NBR | Nivel de jerarquía de liquidación en los sistemas internos de EPX. |
DBA_NBR | Nivel de jerarquía de "doing business as" (DBA) en los sistemas internos de la EPX. |
TERMINAL_NBR | Nivel de jerarquía de terminales en sistemas internos EPX. |
Parámetros del servicio de creación de transacciones#
Requisición#
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
amount | Monto total de la compra (en centavos). Ejemplo: 1.00 = 100 o 1,100.00 = 110000 - envíe el valor sin la coma y el punto. | < 12 N | Sí |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 N | No |
order_id | Código de pedido que se mostrará al comprador, definido por el comerciante. Se recomienda que sea diferente para cada pedido para facilitar la trazabilidad. | < 40 AN | No |
soft_descriptor | Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. | < 30 A | No |
additional_data | Campos Adicionales | ||
tax_amount | Es un campo de referencia que contiene el monto del impuesto incluido en el monto de la transacción (en centavos). | < 12 N | No |
tax_exempt | Indica si la transacción está libre de impuestos. Envíe uno de los siguientes valores: Y - la transacción es libre de impuestos. N - transacción No es libre de impuestos y requiere enviar el campo tax_amount. | < 1 A | No |
tip_amount | Contiene el monto de la propina incluido en el monto de la transacción (en centavos). | < 12 N | No |
additional_data.extra_param | Parametros extras | ||
acquirer_params[] | Representa campos opcionales que el comerciante puede usar para almacenar información de transacciones. | < 80 AN | No |
additional_data.payer | Datos del comprador | ||
born_date | Fecha de nacimiento del comprador, en el formatoAAAA-MM-DDTHH:MM:SS. Ex.: 1991-01-02T08:30:00 | 19 N | No |
name | nombre del comprador | < 25 A | No |
surname | Apellido del comprador | < 25 A | No |
identification_number | Documento de identificación del comprador (CPF/RG). | < 20 AN | No |
additional_data.payer.address | Dirección del comprador | ||
street_name | Nombre de la calle del comprador. Este campo se enviará a EPX concatenado con street_number. | < 30 AN | No |
street_number | Número de dirección del comprador. | < 30 AN | No |
state | Estado de la dirección del comprador. Ex.: SP | < 2 A | No |
zip_code | Código postal de la dirección del comprador | < 9 AN | No |
additional_data.payer.phones | Teléfono del comprador | ||
number | Contiene el número de teléfono del cliente. | < 10 N | No |
type | Campo utilizado para diferenciar los tipos de teléfono: 6 - Celular 2 - Comercial 1 - Residencial | 1 N | No |
IMPORTANTE: EPX NO recibe información sobre cuotas y financiación. Como resultado, solo se admiten transacciones en efectivo.
Ejemplo de solicitud de llamada de creación de transacción#
Parámetros del servicio de pago y preautorización#
Requisición#
| Parómetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
card | Datos de la tarjeta | ||
number | número de tarjeta del comprador | < 19 N | Sí |
barcode_data | Contiene datos de códigos de barras. Este campo debe enviarse con el campo adquisitr.input_type con el valor de A y es compatible con los formatos PAN sin cifrar o TLV Visa. Más detalles aquí. | < 100 AN | No |
id | Contiene el código que representa la forma de identificación del titular de la tarjeta. Puede recibir los siguientes valores: 0 - Portador presente 1 - Portador Nopresente M - Portador presente, tarjeta ilegible | < 1 AN | No |
security_code | Código de Seguridad de la Tarjeta. | < 4 N | No |
expiry_date | Fecha de vencimiento de la tarjeta en formato "MMAY". | 4 N | No |
issue_number | Número de emisión de la tarjeta de crédito. | < 3 N | No |
issue_date | Fecha de emisión de la tarjeta de crédito en formato "MMAY". | < 4 A | No |
card.crypto | Datos de cifrado de tarjetas | ||
type | Identifica el cifrado utilizado: 0 - Utilice el campo adquisitr.input_type para identificar el formato 1 - Formato MagTek V2 2 Formato 3DES (genérica) | 1 N | No |
card.crypto | Tarjeta EMV Data | ||
data | Contiene las etiquetas EMV, en transacciones procesadas a través del chip EMV. | <510 AN | No |
track_1 ou track_2 | Contiene datos de banda magnética de tarjetas de crédito o débito. track_1 debe usarse al procesar una transacción con tarjeta de crédito, y track_2 debe usarse si track_1 no está disponible o cuando se procesa una transacción de débito o EBT. | <256 AN | No |
acquirer | Datos del adquirente | ||
aci | Identifica características específicas de la transacción. Puede recibir los siguientes valores: R - La transacción es recurrente P - La transacción es a plazos | 1 AN | No |
input_type | Modo de entrada de tarjeta. Puede recibir los siguientes valores: X - Digitado A - Código de barras H - Trilha 1 D - Trilha 2 | 1 A | Sí |
cash_back_amount | Monto del reembolso (en centavos). | < 12 N | No |
reference_number | Número de factura de electricidad, teléfono o alquiler que se paga en esta transacción. | <25 AN | No |
operator_code | Contiene el nombre de usuario de la persona que envía la transacción. | < 25 A | No |
soft_descriptor_2 | Campo utilizado para reemplazar la sección de ciudad / estado del Descriptor de comerciante en el estado de cuenta del titular de la tarjeta. | <40 A | No |
terminal | datos del terminal | ||
chip_conditions | Campo utilizado para indicar el motivo de la transacción de reserva de EMV: 0: no se aplica a las transacciones de fallback. Para transacciones VSDC debe ser 0 1 - La transacción se inició desde una tarja magnética con un código de servicio que comienza en 2 o 6 y la última lectura en el terminal VSDC fue una lectura exitosa transacción con chip o Nowas una transacción con chip.2 - La transacción se inició en un terminal compatible con un chip de banda magnética que contiene el código de servicio "2" o "6", y la transacción anterior iniciada por ese terminal fue una lectura de chip fallida. | 1 N | No |
authentication | Datos de autenticación | ||
authentication.pin | Datos del pin de autenticación | ||
value | PIN cifrado. Requerido al ingresar la contraseña en línea del titular de la tarjeta. | < 64 AN | No |
authentication.pin.crypto | Datos de cifrado de PIN de autenticación | ||
ksn | Cifrado PIN KSN. Requerido al ingresar la contraseña en línea del titular de la tarjeta. | < 20 AN | No |
detalles del campo barcode_data#
| Posición | Tamaño | Formato | Descripción |
|---|---|---|---|
| 1-3 | 3 | N | Tipo: - 000 = PAN - Sem criptografia - 001 = Visa - TLV - Sem criptografia |
| 4-N | Variable | ANS | Datos del código de barra |
Ejemplo de solicitud de llamada de pago#
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Parâmetros de resposta#
| Parámetro | Descripción | Formato |
|---|---|---|
balance | Saldo disponible después de los pagos del cupón (en centavos). | < 12 N |
avs_result | Contiene la respuesta del sistema de verificación de direcciones para la transacción solicitada. | 1 A |
authorization_number | Numero de autorización. | < 6 AN |
cvv2_response | Contiene la respuesta CVV2 para la transacción solicitada. | 1 A |
emv_data | Datos EMV. | < 510 AN |
tid | Identificación de transacciones en EPX. | < 20 AN |
authorizer_response_code | Código de respuesta EPX. | < 3 AN |
authorizer_response_message | Mensaje de respuesta EPX. | < 80 AN |
authorizer_date | Fecha de vigencia del pago devuelta por el autorizador en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 13/07/2017T16:03 | 16 AN |