Presentación del servicio

Este servicio te permite crear enlaces de pago por lote.

Los enlaces de pago se generan automáticamente a partir de la importación de uno o varios archivos.

Existen varios canales de difusión:

  • enlaces de pago enviados por e-mail
  • enlaces de pago enviados por SMS
  • enlaces de pago enviados por WhatsApp
  • enlaces de pago enviados manualmente
  • solicitud de pago por teléfono (RVI)
  • solicitud de pago de facturas

Ventajas:

  • Crear rápidamente enlaces de pago por lote.
  • Realice pagos seguros con 3-D Secure.
  • Simplificar el proceso de compra. Su comprador solo tiene que hacer clic en el enlace de pago para pagar su pedido.
  • Tener la opción de elegir entre varios canales de difusión en función de los productos y servicios ofrecidos.

Creación del archivo

Regla de nomenclatura

De forma predeterminada, no hay restricciones en cuanto al nombre del archivo.

El archivo (con extensión .txt o .csv) se puede editar con un editor de texto como el software Notepad++.

Sin embargo, si desea utilizar Microsoft Excel para generar su archivo, deberá registrará la carpeta en formato "CSV (DOS) (*.csv)".

Para ello:
  1. Abra el libro que desee guardar.
  2. Haga clic en Archivo > Guardar como.
  3. En Sitios, seleccione el lugar donde desea guardar el libro. Por ejemplo, seleccione Equipo para guardarlo en una carpeta local, tal como la carpeta Documentos.
  4. En el cuadro de diálogo Guardar como, vaya a la ubicación deseada.
  5. En la lista Guardar como tipo, haga clic en el formato de archivo "CSV (DOS) (*.csv)".
  6. En el cuadro Nombre de archivo, acepte el nombre sugerido o escriba otro nombre para el libro.

Ejemplo de nombre de archivo: importación_del_día.csv

Asegúrese de guardar su archivo en UTF-8.

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:

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

Canal

Descripción: Define el canal de difusión.

Tipo: VARCHAR | Longitud: 32 | Obligatorio

Equivalente API Formulario: N/A

Equivalente API REST: channelType

Valores posibles:
  • MAIL: Enlace de pago via e-mail
  • SMS: Enlaces de pago via SMS
  • URL: Enlaces de pago por URL
  • PHONE: enlace de pago por teléfono
  • WHATSAPP: Enlaces de pago via WhatsApp
  • INVOICE: solicitud de pago de factura

Ejemplo: MAIL

02

Acción

Descripción: Define la operación que se realizará. Si el campo se envía vacío, se aplica por defecto el valor PAYMENT.

Tipo: VARCHAR | Longitud: 32 | Facultativo

Equivalente Formulario API: vads_page_action

Equivalente API REST: formAction

Valores posibles:
  • PAYMENT: pago
  • REGISTER: registro del medio de pago, sin pago.

    Necesita un monto en "0". No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

  • REGISTER_PAY: registro del medio de pago al pagar

    No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

  • ASK_REGISTER_PAY: pago con proposición al portador de registrar su medio de pago

    No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

Ej.: PAYMENT

03

Referencia

Descripción: Referencia del pedido o de la factura. El único carácter especial aceptado es el guion "-".

Para una solicitud de pago de factura, esta referencia debe ser única y los datos obligatorios.

Tipo: VARCHAR | Longitud: 64 | Facultativo

Equivalente Formulario API: vads_order_id

Equivalente API REST: orderId

Ej: CX-1254

04

Monto

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 Formulario API: vads_amount

Equivalente API REST: amount

Ej: 4525 para 45,25 USD

05

Moneda

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

Ej: 840 para el dólar norteamericano (USD)

06

E-mail

Descripción: Dirección de e-mail del comprador.

Obligatorio para un enlace de pago enviado por e-mail.

Tipo: VARCHAR | Longitud: 255 | Facultativo

Equivalente Formulario API: vads_cust_email

Equivalente API REST: email

Ej.: sample@example.net

07

Teléfono

Descripción: Número de teléfono.

Obligatorio para un enlace de pago enviado por SMS.

Tipo: VARCHAR | Longitud: 255 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: phoneNumber

Ej: +33600000000

08

Validación

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 | Facultativo

Equivalente Formulario API: vads_validation_mode

Equivalente API REST: manualValidation

Valores posibles:
  • 0: para una validación automática
  • 1: para una validación manual
  • En blanco: para utilizar el modo de validación predeterminado

Ej: 0

09

Descripción

Descripción: Descripción de la factura. El campo sólo se tiene en cuenta para una solicitud de pago de factura.

Esta descripción se le presentará al comprador después de haber ingresado la referencia de la factura en el formulario de recolección de datos.

En la zona "Descripción" puede mostrarle al comprador información para explicar la factura, esta le sirve de guía y para darle confianza respecto a su tienda.

Para cumplir con el RGPD, se recomienda limitar la publicación de información personal en este campo.

Por ejemplo, para el pago de un alquiler, especificar el período de facturación y la referencia de la vivienda en lugar del nombre del inquilino.

Tipo: VARCHAR | Longitud: 128 | Facultativo

Equivalente Formulario API: vads_order_description

Equivalente API REST: description

Ej: My order description

10

Validez

Descripción: Fecha de vencimiento del enlace 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 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: expirationDate

Ej: 20210603

11

Tasa del IVA

Descripción: Tipo de impuesto aplicado a todo el pedido. El valor es el porcentaje que se aplica (19,6 para 19,6 %).

Tipo: NUMERIC | Longitud: 4 | Facultativo

Equivalente Formulario API: vads_tax_rate

Equivalente API REST: taxRate

Ej: 19,6

12

Preferencia 3-D Secure

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 | Facultativo

Equivalente Formulario API: vads_threeds_mpi

Equivalente API REST: strongAuthentication

Valores posibles:
  • FRICTIONLESS: solicitud de autenticación sin interacción del comprador
  • NO_PREFERENCE: delegación al emisor de la tarjeta
  • CHALLENGE_REQUESTED: solicitud de autenticación con interacción del comprador
  • CHALLENGE_MANDATE: solicitud de autenticación con interacción del comprador por razones reglamentarias

Ej.: NO_PREFERENCE

13

Formulario de recolección de datos

Descripción: Uso del formulario de recolección de datos. Este campo se debe valorar a true si se transmite.

Tipo: BOOLEAN | Longitud: 1 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: dataCollectionForm

Ej: true

14

Referencia RVI

Descripción: Referencia de la solicitud de pago en el respuesta vocal interactiva (RVI). Este campo sólo se tiene en cuenta para una solicitud de pago por teléfono.

Tipo: VARCHAR | Longitud: 20 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: ivrPaymentOrderId

Ej: 1234

Ejemplos de archivo

  • ejemplo básico:
02;12345678;TEST;ALL
MAIL;REGISTER_PAY;CX-1253;3500;840;sample@example.net;;;;;5.5;;;
URL;PAYMENT;CX-1255;4000;840;sample@example.net;;;;;5.5;;;
SMS;PAYMENT;CX-1254;3000;840;;+330600000000;;;;5.5;;true;
INVOICE;PAYMENT;CX-1256;2000;840;sample@example.net;;;My order description;;5.5;;;
  • ejemplo avanzado:
02;12345678;TEST;ALL
MAIL;PAYMENT;CX-1253;3500;840;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;true;
MAIL;REGISTER;CX-1254;0;840;sample@example.net;+330600000000;0;;20240603;5.5;;;
URL;PAYMENT;CX-1255;4500;840;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;true;
SMS;PAYMENT;CX-1256;3000;840;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;;

Descargar el pack de ejemplos: https://payzen.io/doc/static/samples/sample-files-lat.zip

Encontrará los archivos de ejemplo en la carpeta PaymentOrder/V2.

Formato V3

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:

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 03
02 ID de la tienda 12345678
03 Modo TEST o PRODUCTION
04 Canal ALL

El registro de detalles

Pos. Descripción
01

Canal

Descripción: Define el canal de difusión.

Tipo: VARCHAR | Longitud: 32 | Obligatorio

Equivalente API Formulario: N/A

Equivalente API REST: channelType

Valores posibles:
  • MAIL: Enlace de pago via e-mail
  • SMS: Enlaces de pago via SMS
  • URL: Enlaces de pago por URL
  • PHONE: enlace de pago por teléfono
  • WHATSAPP: Enlaces de pago via WhatsApp
  • INVOICE: solicitud de pago de factura

Ejemplo: MAIL

02

Acción

Descripción: Define la operación que se realizará. Si el campo se envía vacío, se aplica por defecto el valor PAYMENT.

Tipo: VARCHAR | Longitud: 32 | Facultativo

Equivalente Formulario API: vads_page_action

Equivalente API REST: formAction

Valores posibles:
  • PAYMENT: pago
  • REGISTER: registro del medio de pago, sin pago.

    Necesita un monto en "0". No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

  • REGISTER_PAY: registro del medio de pago al pagar

    No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

  • ASK_REGISTER_PAY: pago con proposición al portador de registrar su medio de pago

    No compatible con la utilización del formulario de recolección de datos. No está disponible en las solicitudes de pago por teléfono.

Ej.: PAYMENT

03

Referencia

Descripción: Referencia del pedido o de la factura. El único carácter especial aceptado es el guion "-".

Para una solicitud de pago de factura, esta referencia debe ser única y los datos obligatorios.

Tipo: VARCHAR | Longitud: 64 | Facultativo

Equivalente Formulario API: vads_order_id

Equivalente API REST: orderId

Ej: CX-1254

04

Monto

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 Formulario API: vads_amount

Equivalente API REST: amount

Ej: 4525 para 45,25 USD

05

Moneda

Descripción: Código alfabético de la moneda del pago (según la norma ISO 4217).

Tipo: VARCHAR | Longitud: 3 | Obligatorio

Debe corresponder a la moneda de la empresa.

Equivalente Formulario API: vads_currency

Equivalente API REST: currency

Ej: USD para el dólar estadounidense

06

E-mail

Descripción: Dirección de e-mail del comprador.

Obligatorio para un enlace de pago enviado por e-mail.

Tipo: VARCHAR | Longitud: 255 | Facultativo

Equivalente Formulario API: vads_cust_email

Equivalente API REST: email

Ej.: sample@example.net

07

Teléfono

Descripción: Número de teléfono.

Obligatorio para un enlace de pago enviado por SMS.

Tipo: VARCHAR | Longitud: 255 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: phoneNumber

Ej: +33600000000

08

Validación

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 | Facultativo

Equivalente Formulario API: vads_validation_mode

Equivalente API REST: manualValidation

Valores posibles:
  • 0: para una validación automática
  • 1: para una validación manual
  • En blanco: para utilizar el modo de validación predeterminado

Ej: 0

09

Descripción

Descripción: Descripción de la factura. El campo sólo se tiene en cuenta para una solicitud de pago de factura.

Esta descripción se le presentará al comprador después de haber ingresado la referencia de la factura en el formulario de recolección de datos.

En la zona "Descripción" puede mostrarle al comprador información para explicar la factura, esta le sirve de guía y para darle confianza respecto a su tienda.

Para cumplir con el RGPD, se recomienda limitar la publicación de información personal en este campo.

Por ejemplo, para el pago de un alquiler, especificar el período de facturación y la referencia de la vivienda en lugar del nombre del inquilino.

Tipo: VARCHAR | Longitud: 128 | Facultativo

Equivalente Formulario API: vads_order_description

Equivalente API REST: description

Ej: My order description

10

Validez

Descripción: Fecha de vencimiento del enlace 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 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: expirationDate

Ej: 20210603

11

Tasa del IVA

Descripción: Tipo de impuesto aplicado a todo el pedido. El valor es el porcentaje que se aplica (19,6 para 19,6 %).

Tipo: NUMERIC | Longitud: 4 | Facultativo

Equivalente Formulario API: vads_tax_rate

Equivalente API REST: taxRate

Ej: 19,6

12

Preferencia 3-D Secure

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 | Facultativo

Equivalente Formulario API: vads_threeds_mpi

Equivalente API REST: strongAuthentication

Valores posibles:
  • FRICTIONLESS: solicitud de autenticación sin interacción del comprador
  • NO_PREFERENCE: delegación al emisor de la tarjeta
  • CHALLENGE_REQUESTED: solicitud de autenticación con interacción del comprador
  • CHALLENGE_MANDATE: solicitud de autenticación con interacción del comprador por razones reglamentarias

Ej.: NO_PREFERENCE

13

Formulario de recolección de datos

Descripción: Uso del formulario de recolección de datos. Este campo se debe valorar a true si se transmite.

Tipo: BOOLEAN | Longitud: 1 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: dataCollectionForm

Ej: true

14

Referencia RVI

Descripción: Referencia de la solicitud de pago en el respuesta vocal interactiva (RVI). Este campo sólo se tiene en cuenta para una solicitud de pago por teléfono.

Tipo: VARCHAR | Longitud: 20 | Facultativo

Equivalente API Formulario: N/A

Equivalente API REST: ivrPaymentOrderId

Ej: 1234

Ejemplos de archivo

  • ejemplo básico:
03;12345678;TEST;ALL
MAIL;REGISTER_PAY;CX-1253;3500;USD;sample@example.net;;;;;5.5;;;
URL;PAYMENT;CX-1255;4000;USD;sample@example.net;;;;;5.5;;;
SMS;PAYMENT;CX-1254;3000;USD;;+330600000000;;;;5.5;;true;
INVOICE;PAYMENT;CX-1256;2000;USD;sample@example.net;;;My order description;;5.5;;;
  • ejemplo avanzado:
03;12345678;TEST;ALL
MAIL;PAYMENT;CX-1253;3500;USD;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;true;
MAIL;REGISTER;CX-1254;0;USD;sample@example.net;+330600000000;0;;20240603;5.5;;;
URL;PAYMENT;CX-1255;4500;USD;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;true;
SMS;PAYMENT;CX-1256;3000;USD;sample@example.net;+330600000000;0;;20240603;5.5;NO_PREFERENCE;;

Descargar el pack de ejemplos: https://payzen.io/doc/static/samples/sample-files-lat.zip

Encontrará los archivos de ejemplo en la carpeta PaymentOrder/V3.

Importación del archivo

  1. Conéctese a su Back Office Vendedor:
  2. Vaya al menú Gestión > Solicitudes de pago o Solicitudes de pago de TEST según su necesidad.
  3. Haga clic en la barra de acciones situada a la derecha del botón Crear un enlace.
  4. Seleccione Importar desde un archivo.
  5. Seleccione la tienda en la que desea crear los enlaces de pago.
  6. Haga clic en Elija un archivo.
  7. Seleccione el archivo que desea importar.

    El tamaño del archivo no debe exceder 1 KB.

  8. Si el archivo es válido, una nueva pantalla le propone importar el archivo. Haga clic en Importar para crear los enlaces de pago.
  9. En caso de error, corrija los errores en su archivo. A continuación, haga clic en y vuelva a seleccionar su archivo para validar su estructura.

Manejo de errores

La plataforma verifica el formato del archivo antes de ofrecerle la posibilidad de importarlo.

En caso de error, se visualiza un informe e indica el error detectado y la línea correspondiente.

Para más información, consulte la lista de errores.

Si el informe no se muestra y aparece el mensaje Error al leer el archivo, verifique la codificación:

  1. Abra el archivo con el Bloc de notas de Windows (clic derecho y luego Modificar en el Bloc de notas).
  2. Haga clic en Archivo > Guardar como.
  3. Seleccione UTF-8 en la lista desplegable Codificación.
  4. Haga clic en Guardar.
  5. Vuelva a importar su archivo haciendo clic en .

Lista de errores

Errores en la línea Registro de encabezado

Mensaje de error Descripción Header incorrect La primera línea del archivo debe ser de la forma "version;shopId;MODE;CHANNEL". Número de versión de archivo incorrecto El primer campo de header de debe valorizar a “02”. Número de tienda incorrecto El ID de la tienda se debe expresar en 8 cifras y debe corresponder con la tienda seleccionada para el importador del archivo. Modo incorrecto Dos valores posibles: "TEST" o "PRODUCTION".

Desde el menú “Solicitudes de pago de PRUEBA” usted no puede enviar el valor PRODUCTION.

Desde el menú “Solicitudes de pago” usted no puede enviar el valor TEST.

Canal incorrecto El canal se debe valorizar en "ALL".

Errores en la línea Registro de detalles

Mensaje de error Descripción
Nombre erróneo de parámetros Este mensaje es devuelto en los siguientes casos:
  • la línea está vacía
  • Falta 1 o varios parámetros en la línea
  • Hay uno o varios parámetros de más en la línea
Canal incorrecto Los valores posibles son:
  • MAIL
  • SMS
  • URL
  • PHONE
  • WHATSAPP
  • INVOICE
Acción inválida Los valores posibles son:
  • PAYMENT
  • REGISTER
  • REGISTER_PAY
  • ASK_REGISTER_PAY
Acción inválida para el formulario de recaudación de datos Solo se acepta el valor PAYMENT si desea utilizar el formulario de recaudación de datos (posición 13 del archivo).
Falta número de teléfono El número de teléfono es obligatorio para el canal SMS.
Falta el e-mail La dirección de correo electrónico es obligatoria para el canal MAIL o si la acción es REGISTER, REGISTER_PAY o ASK_REGISTER_PAY.
Monto ausente El monto no se puede enviar vacío.
Monto no válido para la acción PAYMENT El monto debe ser superior a 0 y debe estar expresado en la unidad más pequeña de la moneda utilizada.
Monto no válido para la acción REGISTER El monto debe ser igual a 0 en el caso de registro del medio de pago sin pago.
Moneda ausente La moneda no se puede enviar vacía.
Moneda inválida El valor transmitido debe corresponder al código ISO 4217 (código digital) de la moneda de la empresa.
E-mail inválido La dirección e-mail transmitida no respeta el formato esperado.
Modo de validación inválido Valores posibles: 0 o 1.
Fecha de fin de validez inválida No puede ser anterior a la fecha actual ni superar los 90 días.
Tipo de IVA inválido La tasa de IVA transmitida no respeta el formato esperado.
Preferencia 3DS inválida Los valores posibles son:
  • "FRICTIONLESS"
  • "NO_PREFERENCE"
  • "CHALLENGE_REQUESTED"
  • "CHALLENGE_MANDATE"