Saltar al contenido principal

Preautorización Petición

POST 
/EPGCheckout/rest/online/pay - Preautorización Petición
Preautorización Petición

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 Numérico entero 4~7 dígitosrequired

    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 Currencyrequired

    Possible values: [EUR, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL]

    Moneda de la transacción.

    • Código ISO-4217.3 de la divisa de la transacción (EUR, USD, GBP, etc.).
    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.).

    customerId Alfanumérico Máx. 80 caracteresrequired

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

    • Alfanumérico – Max. 80 caracteres.
    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.
    cardData object required
    Este campo debe agregarse al objeto principal. * Está en forma de objeto solo para mostrarse en el documento.
    oneOf
    cardType string

    Possible values: [visa, mastercard, amex]

    Marca de la tarjeta.

    • Los valores admitidos son:
      • VISA
      • MASTERCARD
      • AMEX
    cardNumber Numérico Máximo 19 dígitos.

    PAN de la tarjeta.

    • Numérico – Max. 19 dígitos.
    • Debe superar la validación del algoritmo Luhn Check.
    expDate Formato MMAA, los meses son MM y AA el año.

    Fecha de caducidad de la tarjeta.

    • Numérico – 4 dígitos.
    • Formato: MMAA - MM los dos dígitos del mes y AA los dos últimos dígitos del año.
    • Por ejemplo: Junio 2023 → 0623
    cvnNumber Numérico – 3 ~ 4 dígitos.

    CVC de la tarjeta.

    • Numérico – 3 ~ 4 dígitos.
    autoCapture booleanrequired

    Possible values: [false, true]

    Para que las operaciones se capturen automáticamente (o no), debes enviar este valor en la petición

    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 Numérico entero 6~11 dígitosrequired

    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 Hosted.
    • 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.
    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.
    chName Alfanumérico Máx. 100 caracteresrequired

    Nombre completo (nombre y apellidos).

    • Alfabético – Máx. 100 caracteres.
    • Los nombres y apellidos se separan con espacios.
    printReceipt boolean

    Possible values: [true, false]

    Muestra al cliente final un recibo en el proceso de redirección tipo opcional.

    referenceId Alfanumérico 12 caracteres

    Referencia variable para comercios que necesiten de archivos de conciliación FB500.

    forceTokenRequest boolean

    Possible values: [false, true]

    Indica si guardar o no el token de la tarjeta del cliente. Si no quieres guardar la tarjeta, usa «false»

Respuestas
Enlace de redirección creado con la pantalla de carga
Schema
    string
Cargando...