Formato V2
Cada archivo debe estar compuesto por una serie de registros.
Se llama “registro” a una lista de parámetros separados por el carácter comas ";" 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.
Notas a los usuarios de Microsoft Excel
- Un "registro" corresponde a una línea de la carpeta.
- El registro de encabezado corresponde a la primera línea del archivo.
- Las posiciones ("Pos.") indicadas en las siguientes tablas (01, 02, etc...) corresponden a las columnas de su carpeta. Por ejemplo: "Pos. 01" corresponde a la columna "A", "Pos. 02" corresponde a la columna B.
- Si no desea valorizar un dato, dejar la celda correspondiente vacía.
- Cerciórese de que todas las celdas están en formato "Texto".
El registro de encabezado
| Pos. | Descripción | Valores |
|---|---|---|
| 01 | Versión del encabezado | 02 |
| 02 | ID de la tienda | 12345678 |
| 03 | Modo | TEST o PRODUCTION |
| 04 | Canal | ALL |
El registro de detalles
| Pos. | Descripción |
|---|---|
| 01 | Descripción: Define el canal de difusión. Tipo: VARCHAR | Longitud: 32 | Obligatorio Equivalente API Formulario: N/A Equivalente API REST: channelOptions.channelType Valores posibles:
Ejemplo: MAIL |
| 02 | Descripción: Define la operación que se va a realizar. Si el campo se envía vacío, se aplica por defecto el valor "PAYMENT”. Tipo: VARCHAR | Longitud: 32 | Opcional Equivalente API Formulario: vads_page_action Equivalente API REST: formAction Valores posibles:
Ejemplo: PAYMENT |
| 03 | 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 API Formulario: vads_order_id Equivalente API REST: orderId Ejemplo: CX-1254 |
| 04 | 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, salvo que la operación a realizar (Posición 02) sea "REGISTER". Tipo: NUMERIC | Longitud: 13 | Obligatorio Equivalente API Formulario: vads_amount Equivalente API REST: amount Ejemplo: 4525 para 45,25 EUR |
| 05 | 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 API Formulario: vads_currency Equivalente API REST: currency Ejemplo: 978 para el euro (EUR) (Ver capitulo Lista de monedas aceptadas en anexos) |
| 06 | Descripción: E-mail del comprador. Obligatorio para una solicitud de pago via e-mail. Tipo: VARCHAR | Longitud: 255 | Opcional Equivalente API Formulario: vads_cust_email Equivalente API REST: customer.email Ej.: sample@example.net |
| 07 | Descripción: Número de teléfono Obligatorio para una solicitud de pago por SMS Tipo: VARCHAR | Longitud: 255 | Opcional Equivalente API Formulario: N/A Equivalente API REST: channelOptions.smsOptions.phoneNumber Ejemplo: +33600000000 |
| 08 | 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 API Formulario: vads_validation_mode Equivalente API REST: cardOptions.manualValidation Valores posibles:
Ejemplo: 0 |
| 09 | |
| 10 | 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 API Formulario: N/A Equivalente API REST: expirationDate Ejemplo: 20210603 |
| 11 | Dejar en blanco. |
| 12 | 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 API Formulario: vads_threeds_mpi Equivalente API REST: strongAuthentication Valores posibles:
Ejemplo: NO_PREFERENCE |
| 13 | Descripción: Uso del formulario de recogida de datos. Este campo se debe valorar a true si se transmite. Tipo: BOOLEAN | Longitud: 1 | Opcional Equivalente API Formulario: N/A Equivalente API REST: dataCollectionForm Ej: true |
| 14 | Descripción: Referencia de la solicitud de pago en el servidor vocal interactivo (SVI). Este campo sólo se tiene en cuenta para una solicitud de pago por teléfono. Tipo: VARCHAR | Longitud: 20 | Opcional Equivalente API Formulario: N/A Equivalente API REST: channelOptions.ivrOptions.ivrPaymentOrderId Ejemplo: 1234 |
Ejemplos de archivo
- ejemplo básico:
02;12345678;TEST;ALL MAIL;REGISTER_PAY;CX-1253;3500;978;sample@example.net;;;;;;;; URL;PAYMENT;CX-1255;4000;978;sample@example.net;;;;;;;; SMS;PAYMENT;CX-1254;3000;978;;+330600000000;;;;;;true;
- ejemplo avanzado:
02;12345678;TEST;ALL MAIL;PAYMENT;CX-1253;3500;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true; MAIL;REGISTER;CX-1254;0;978;sample@example.net;+330600000000;0;;20240603;;;; URL;PAYMENT;CX-1255;4500;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true; SMS;PAYMENT;CX-1256;3000;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;;
Descargar el pack de ejemplos: https://docs.lyra.com/files/samples/sample-files-collect.zip.
Encontrará los archivos de ejemplo en la carpeta PaymentOrder/V2.