Formato V1
Cada archivo debe estar compuesto por una serie de registros.
Se llama “registro” a una lista de parámetros separados por el carácter “;” y terminados por un retorno de carro.
Los archivos tienen la siguiente estructura:
- Un registro de encabezado que proporciona información sobre la transmisión.
- Un número variable de registros que corresponden cada uno a una solicitud de pago.
El registro de encabezado
Pos. | Descripción | Valores |
---|---|---|
01 | Versión del encabezado | 01 |
02 | Identificador de la tienda | 12345678 |
03 | Modo | TEST o PRODUCTION |
04 | Canal |
El registro de detalles
Pos. | Descripción |
---|---|
01 | Descripción: Define la operación a realizar. Si el campo se envía vacío, se aplica por defecto el valor "PAYMENT”. Tipo: VARCHAR | Longitud: 32 | Opcional Equivalente Formulario API: vads_page_action Equivalente API REST: formAction Valores posibles:
Ejemplo: PAYMENT |
02 | Descripción: Referencia de la solicitud de pago o del pedido. El único carácter especial aceptado es el guion "-". Tipo: VARCHAR | Longitud: 64 | Opcional Equivalente Formulario API: vads_order_id Equivalente API REST: orderId Ejemplo: CX-1254 |
03 | Descripción: Monto de la transacción expresado en la unidad más pequeña de la moneda. El monto no se puede valorar en 0. Tipo: NUMERIC | Longitud: 13 | Obligatorio Equivalente Formulario API: vads_amount Equivalente API REST: amount Ejemplo: 4525 para 45,25 EUR |
04 | Descripción: Código numérico de la moneda del pago, según la norma ISO 4217. Tipo: NUMERIC | Longitud: 3 | Obligatorio Debe corresponder a la moneda de la empresa. Equivalente Formulario API: vads_currency Equivalente API REST: currency Ejemplo: 978 para el euro (EUR) (Ver capitulo Lista de monedas aceptadas en anexos) |
05 | Descripción: Dirección de correo electrónico del comprador. Tipo: VARCHAR | Longitud: 255 | Obligatorio Equivalente Formulario API: vads_cust_email Equivalente API REST: customer.email Ej.: sample@example.net |
06 | Descripción: Modo de validación. Para más informaciones, consulte el capítulo Configurar el modo de validación por defecto del manual usuario "Gestión de las transacciones". Tipo: NUMERIC | Longitud: 1 | Opcional Equivalente Formulario API: vads_validation_mode Equivalente API REST: cardOptions.manualValidation Valores posibles:
Ejemplo: 0 |
07 | Descripción: Descripción de la factura. Se ignora el campo para una solicitud de pago por e-mail. Tipo: VARCHAR | Longitud: 255 | Opcional |
08 | Descripción: Fecha de vencimiento de la solicitud de pago. No puede ser anterior a la fecha actual ni superar los 90 días. Si este parámetro no se ha enviado, el valor aplicado será el definido en la configuración de la tienda (Menú Configuración > Tienda, pestaña Configuración). Tipo: NUMERIC | Longitud: 8 | Opcional Equivalente Formulario API: N/A Equivalente API REST: expirationDate Ejemplo: 20210603 |
09 | Descripción: Campo específico para América Latina. Tasa de impuesto aplicada para todo el pedido. El valor debe ser el porcentaje a aplicar (19,6 para 19,6%). Tipo: NUMERIC | Longitud: 4 | Opcional Equivalente Formulario API: vads_tax_rate Equivalente API REST: taxRate Ejemplo: 19,6 |
10 | Descripción: Preferencia vendedor relativa a la autenticación 3DS. Si el campo se envía vacío, se aplica por defecto el valor "NO_PREFERENCE". Tipo: VARCHAR | Longitud: 32 | Opcional Equivalente Formulario API: vads_threeds_mpi Equivalente API REST: strongAuthentication Valores posibles:
Ejemplo: NO_PREFERENCE |
11 | Descripción: Uso del formulario de recaudación de datos. Solo se puede enviar a true si la acción a realizar es PAYMENT. Tipo: BOOLEAN | Longitud: 1 | Opcional Equivalente Formulario API: N/A Equivalente API REST: dataCollectionForm Valores posibles:
Ejemplo: true |
Ejemplos de archivo
- ejemplo básico:
01;12345678;TEST;MAIL PAYMENT;CX-1254;3000;978;sample@example.net;;;;;; REGISTER;CX-1255;0;978;sample@example.net;;;;;; REGISTER_PAY;CX-1256;3990;978;sample@example.net;;;;;; ASK_REGISTER_PAY;CX-1257;11000;978;sample@example.net;;;;;;
- ejemplo avanzado:
01;12345678;TEST;MAIL PAYMENT;CX-1254;3000;978;sample@example.net;0;;20210603;;NO_PREFERENCE;true REGISTER;CX-1255;0;978;sample@example.net;0;;20210603;;NO_PREFERENCE; REGISTER_PAY;CX-1256;3990;978;sample@example.net;0;;20210603;;NO_PREFERENCE; ASK_REGISTER_PAY;CX-1257;11000;978;sample@example.net;0;;20210603;;NO_PREFERENCE;
Descargar el pack de ejemplos: https://docs.lyra.com/files/samples/sample-files.zip.
Encontrará los archivos de ejemplo en la carpeta MAIL.