Saltar al contenido principal

Crea un enlace de servicios redirección de pago

POST 
/EPGCheckout/rest/online/tokenize - Integración de Quix - Servicios
Crea un enlace de servicios redirección de pago

Parámetros de consulta

  • merchantId string required

    Identificador de tu comercio en la plataforma de Addon Payments.

    Ejemplo: 123456
  • encrypted string required
    • Cifrado de los parámetros de consulta claros.
    • Los datos finales enviados estarán en formato base64.
    • Para el objeto, consulte el Cuerpo de la solicitud
    Ejemplo: yGbFUz+X9hDK/R39QFRpckGojl/vSCJPCETpxxwPTXw+q+NQMeHUQDbj7OJYy6ZsKE+sbQIedQ36YUc8yKt7/aOU5xyyFamFaUM5MzU4oOAPNwBEkeBrbGdb0uwyJEJObij0tao1+r5XSCLBKGd1FM8pAhROaGJ8SqdFFWlgx2x9zvhtARDdU79AUPK79uAu9h34PK8eJCpPzLD2jRX7EruCtHeDjuPPZWUo2yhAMO33cKmTv8pGOGnFr0U+KbacbZZMZk2l0X+KADpKOLVFMvLJAOKR7kpqNXcqQulgaU8VtlXizk4bj6Gc/EilVcfyb7Ibyb9AO2hO3VvUk6/b9yCzIE4kIaKnKTmi5QuBKbR9zPDnPgjstMNZgpa9iY5XWxPR+FQA3DGgprnMUxwB6b6y5YQz7Z3Y4TBsjDTSb/2kl/pGBwx0C8kFleLcBZQbr7dgLO3OxAO+RnMOrU4SdTjKTJ9XcWeLsVlw0Ti7a625lpsFTej/q279KyEcoPmJaQnraXbm+ERM8hz5nPeQzvmmyXSnNB5noWbhAQGOnZVqopor9c14rH1NCasAyqgq7auzk39WdVlVCXKvQ01MIerjfr7jQhKHrnQ9Nz/T0hpbxMGxxsMLzjIe5xAz8VfCfwUaS96wQLqU+NCV9PBY79fH55rUPChEFZaQoFzOema6UEC+qvYScceiGtU15Abr+yjGCnAvHjpbdJykwTgEcWcNjOvntuLrpkTrnc/4L5VYyqvW2SUfQ7UKpfuEIoy4KU54dih1jM3MCIhh/vGrqBUsi2mmJUxrkkREkKrCR36CI6I0zv/sp2l7htzB3f8v1wq6rMCyo6a2yLSpHXSdk9jcEkwUbfEhb5SAsbTIw/Hpumr8POkXHiENx9ntg7htB8j4ON7ubnG5Qb93ktWI8uPuSQDf/+rCMii33YI2yjS59w/z5I40FG40lVDwgU0H1xSFiLbICFda78oQCOXHiFcTLlL7joV1JTHiwBYa5gz2Cwkm6toLZkVLW6O6ZmFtMMu++VjIcyeJaA+IssCpptSQq5mtq/tzLb2UzER0xSGRLzX0lVIi21P31KaVws4dX1rrx3McAoJArsrITamPI8kN+hzmgaErpQfwH994ivNBT/1jUlOvs6CXvEawU5vrCegp1ayofYeeyIo7JIvbjPfI6C58KJMxwHr+IWbTOFY+GErQxo3k5UTBmSICmkekzcgToaxzKYS6v/55VPJpNCl5lBNLoyj6u67jsQooYgkInnaYBidEW8Tc/mryz07P
  • integrityCheck string required
    • Sha256 de los parámetros de consulta claros en UTF_8 bytes.
    • Enviado en forma hexadecimal en minúsculas.
    Ejemplo: c4ca128afe39a4e2c5c3c529813f536d0265b5b90f30eeb3278236406d67db7c

Parámetros del encabezado

  • apiVersion string required

    Versión del API de AP por la cual debe tramitarse la petición.

    • Los valores admitidos son 3, 4 y 5 (recomendado)
    Ejemplo: 5
  • encryptionMode string required

    Tipo de cifrado AES-256 usado (CBC)

    Ejemplo: CBC
  • iv string required

    Vector inicial utilizado en el proceso de encriptación en Forma Base64

    Ejemplo: gH9j/x+Qu7M2r2SYPfa3UA==

Cuerpo

-- NO ENVÍE ESTE CUERPO DE SOLICITUD, ES SOLO PARA DESCRIPCIÓN -- Este es el objeto utilizado en el campo "encrypted"
    merchantId Integer numeric 4~7 digitsrequired

    Identificador de tu comercio en la plataforma de AP.

    • Es un código numérico facilitado por Soporte en el correo de bienvenida.
    • Tiene de 4 a 7 dígitos y es común para ambos entornos (pruebas/producción).
    merchantTransactionId Alfanumérico Máx. 45 caracteresrequired

    Identificador de la transacción en tu plataforma de comercio electrónico. Sirve para que tu plataforma enlace las notificaciones recibidas conel pedido del cliente.

    • No puede repetirse entre transacciones.
    • Máx. 45 caracteres - Página de códigos Latin-1 (ISO-8859-1)
    amount Numérico decimal 0~1000000.00required

    Importe de la transacción.

    • Si el importe contiene decimales, se usa el punto (.) como separador decimal.
    • No se puede incluir separador de millares.
    • En transacciones que no generen movimiento monetario, como por ejemplo el registro de la tarjeta de un cliente, se debe enviar cero (0) como importe.
    • Por ejemplo, 1.234,56€ se enviaría 1234.56
    currency stringrequired

    Possible values: [EUR]

    Moneda de la transacción.

    • Código ISO-4217.3 de la divisa de la transacción (EUR, USD, GBP, etc.).
    • Por ahora solo aceptamos EUR.
    country Countryrequired

    Possible values: [AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, TP, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KV, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, ME, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

    País desde el que se envía la transacción. Código ISO-3166.2 del país desde la cual se envía la transacción (ES, US, UK, etc.).

    paymentSolution stringrequired

    Nombre de la solución de pago por la cual debe procesarse la transacción (creditcards, bizum, paypal, quix, etc.).

    • Obligatorio en los siguientes casos:
      • Si se ha seleccionado el tipo de cajero “Sólo formulario”.
      • Si se quiere limitar al cliente a la solución de pago enviada.
    customerId Alfanumérico Máx. 80 caracteresrequired

    ID. del cliente en tu plataforma de comercio electrónico.

    • Alfanumérico – Max. 80 caracteres.
    operationType stringrequired

    Possible values: [DEBIT, CREDIT]

    Especifica el tipo de operación a realizar.

    • Si no se envía el parámetro, se utilizará "DEBIT" por defecto.
    • Possible values are:
      • DEBIT: payment transaction, that is, cash travels from the customer's account to the merchant.
      • CREDIT: transacción de ingreso en cuenta de cliente, es decir, el efectivo viaja desde el comercio a la cuenta del cliente, como por ejemplo el pago de un premio. No confundir con las devoluciones, que tienen su propio tipo de transacción.
    productId Integer numeric 6~11 digitsrequired

    Altamente recomendado Identificador del producto creado en tu comercio en AP por el cual se debe procesar la transacción.

    • Se facilita en el correo de bienvenida.
    • Tiene de 6 a 11 dígitos numéricos.
    • El producto es el que limita qué soluciones de pago de las activadas para el comercio se ofrecen al cliente.
    • AP permite que los comercios dispongan de varios productos configurados a sus necesidades.
    • Si no se envía, AP usará el primer producto del comercio que esté marcado en BBDD como “por defecto”.
      • Si el comercio no tiene ningún producto marcado “por defecto” y no se envía el parámetro, la petición generará error.
    • Puede ser diferente dependiente del entorno (pruebas y producción).
    • Por ejemplo:
      • Un comercio dispone de las soluciones de pago tarjeta, Bizum y Quix activadas.
      • TEl comercio dispone de dos productos, uno para clientes nacionales con todas las soluciones de pago activadas, y otro para clientes internacionales con únicamente pago con tarjeta.
      • El comercio indica el identificador de uno u otro producto en la petición dependiendo de la nacionalidad de su cliente.
      • Con ello evita ofrecer soluciones de pago como Bizum o Quix, que únicamente pueden operar con clientes nacionales, a clientes internacionales.
    language string

    Possible values: [ES, EN]

    Código ISO 639-1 del idioma para mostrar la pasarela de pago al cliente.

    • Únicamente para integración por redirección.
    • Actualmente están disponibles los siguientes idiomas:
      • ES: Castellano
      • EN: Inglés
    statusURL Alfabético ISO 639-1required

    Altamente recomendado URL de tu plataforma de comercio electrónico donde AP enviará la notificación con el estado de la transacción.

    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Alfanumérico – Máx. 2048 caracteres.
    successURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si la transacción es autorizada.

    • Alfanumérico ? Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.
    errorURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si la transacción es denegada.

    • Alfanumérico Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración
    cancelURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si cancela la transacción.

    • Alfanumérico Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.
    awaitingURL Alfabético ISO 639-1required

    URL de retorno a la web del comercio a la que redirigir al cliente si la transacción está pendiente de procesar por la solución de pago.

    • Alfanumérico – Máx. 2048 caracteres.
    type string

    Possible values: [ECOM, MOTO]

    Canal a través del cual se debe gestionar la transacción.

    • Los valores posibles son:
      • ecom: comercio electrónico.
      • moto: pedido por teléfono o correo electrónico.
    paymentMethod string

    sub-método de la solución de pago.

    • Hay soluciones de pago que concentran a otras soluciones de pago.
      • TLas soluciones de pago que están contenidas dentro de otra superior se conocen como métodos.
      • Para gestionar una transacción por una solución de pago contenida dentro de otra, habrá que indicar el nombre de la solución de pago contenida en este parámetro, y el nombre de la solución de pago contenedora en “paymentSolution”.
      • Ejemplo: la solución de pago “Trustly” está contenida dentro de la solución de pago “Ppro”, por lo que para enviarle una transacción la petición debería incorporar los siguientes parámetros:
        • paymentSolution = ppro
        • paymentMethod = trustly
    • Alfanumérico – Máx. 45 caracteres.
    merchantParams Clave1:Valor1;Clave2:Valor2;ClaveN:ValorN Máx. 500 caracteres

    parámetros que envía tu plataforma de comercio electrónico para modificar la gestión de la transacción en AP

    • Alfanumérico – Máx. 500 caracteres.
    • Los parámetros se envían en el siguiente formato:
      • Clave1:Valor1;Clave2:Valor2;ClaveN:ValorN
    • Los parámetros que se envíen serán recibidos de vuelta en el campo “optionalTransactionParams” de la respuesta.
    description Alfanumérico Máx. 1000 caracteres

    Descripción de la transacción.

    • Máx. 1000 caracteres, página de códigos Latin-1 (ISO-8859-1)
    • Puede resultar útil para localizarla o identificarla posteriormente en el panel de gestión de AP.
    firstName Alfabético Máximo 100 caracteresrequired

    Nombre.

    • Alfabético – Máx. 100 caracteres.
    • Si tiene más de uno (1) se separan con espacios.
    lastName Alfabético Máximo 100 caracteresrequired

    Apellido(s).

    • Alfabético – Máx. 100 caracteres.
    • Si tiene más de uno (1) se separan con espacios.
    customerEmail Correo electrónico del cliente.required

    Dirección de correo electrónico.

    • Alfabético – Máx. 100 caracteres.
    telephone Número de teléfono. Debe incluir el prefijo internacional.

    Número de teléfono. No debe incluir el prefijo internacional.

    • Numérico - Máx. 45 caracteres.
    customerCountry stringrequired

    Possible values: [ES]

    Código ISO-3166.2 del país del cliente (ES, US, UK, etc.).

    customerNationalId Número del DNI (con letra) en caso de clientes españoles.required

    Identificador del documento nacional de identidad.

    • Alfanumérico – Máx. 100 caracteres.
    • Número de DNI (con letra) en el caso de clientes españoles.
    ipAddress Formato IPv4 o IPv6required

    Dirección IP del cliente.

    • Alfanumérico - Máx. 45 caracteres.
    • Formato: IPv4 o IPv6
    dob DD-MM-AAAArequired

    Fecha de nacimiento.

    • Alfanumérico – Máx. 10 caracteres.
    • Formato: DD-MM-AAAA
    paysolExtendedData objectrequired
    Datos extendidos para el procesamiento de Paysol específicos para un producto, detalles de facturación y artículos del carrito para servicios digitales.
    product stringrequired

    Tipo de producto, por ejemplo, 'plazos'.

    billing objectrequired
    Información de facturación.
    first_name string

    Primer nombre para la facturación.

    last_name string

    Apellido para la facturación.

    address object
    Dirección de facturación.
    street_address string

    Dirección de la calle para facturación.

    postal_code string

    Código postal para la facturación.

    city string

    Ciudad para la facturación.

    country string

    Código de país para la facturación, en formato ISO.

    cart objectrequired
    Detalles del carrito para servicios digitales.
    currency stringrequired

    Moneda del total del carrito.

    total_price_with_tax floatrequired

    Precio total del carrito incluyendo impuestos.

    items object[]required
    Lista de artículos en el carrito.
  • Array [
    • article objectrequired
    Detalles del artículo para servicio digital.
    name stringrequired

    Nombre del servicio digital.

    type stringrequired

    Tipo del artículo, por ejemplo, 'servicio'.

    category stringrequired

    Categoría del artículo, por ejemplo, 'digital'.

    reference stringrequired

    Identificador de referencia para el artículo.

    unit_price_with_tax floatrequired

    Precio unitario del artículo incluyendo impuestos.

    start_date date-timerequired

    Fecha de inicio de la disponibilidad del servicio.

    end_date date-timerequired

    Fecha de fin de la disponibilidad del servicio.

    units integerrequired

    Número de unidades del artículo.

    total_price_with_tax floatrequired

    Precio total del artículo incluyendo impuestos.

    auto_shipping booleanrequired

    Indica si el envío automático se aplica al artículo.

  • ]
    • disableFormEdition boolean

    permite bloquear los campos informados en la solicitud (del comerciante), para que el cliente no pueda editarlos en la UI

Respuestas
Enlace de redirección creado
Schema
    string
Cargando...