Saltar al contenido principal

Solicitud de autorización

POST 
/auth - Javascript de autorización
Solicitar token de autorización para la biblioteca de Javascript

Parámetros del encabezado

  • Content-Type string required

    Tipo de contenido

    Ejemplo: application/json

Cuerpo

Codifique toda la información en UTF-8 y, formatéela en JSON y envíela por POST al endpoint AP habilitado para su recepción.
    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).
    merchantKey Alfanumérico Formato UUIDrequired

    Contraseña de Javascript.

    • Se utiliza para verificar que la petición es legítima (enviada desde el comercio).
    • Debe coincidir con la almacenada en AP.
    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.).
    operationType stringrequired

    Possible values: [ACCOUNT_REGISTRATION, DEBIT, REFUND, REBATE, CREDIT, CANCEL_WITHDRAWAL]

    Tipo de operación.

    country stringrequired

    País desde la cual se envía la transacción.

    • Código ISO 3166-1 alfa-2 (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.
    • Se debe enviar vacío para clientes no registrados (invitados).
    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.
    anonymousCustomer boolean

    Possible values: [false, true]

    OPTIONAL DATA booleano que indica si el cliente está registrado o no en tu plataforma de comercio electrónico.

    • Afecta a la visualización de la casilla “Recuérdame” que permite guardar una tarjeta o cuenta asociada al identificador del cliente.
    • Los posibles valores son:
      • false (por defecto): cliente registrado en tu plataforma de comercio electrónico, por lo que se mostrará la casilla “Recuérdame” para que pueda guardar la tarjeta o cuenta asociada a su id. de cliente.
      • true: cliente no registrado, por lo que no se le mostrará la casilla “Recuérdame” y no podrá guardar la tarjeta o cuenta.
Respuestas
Authorization Token Generated
Schema
    authToken string

    El token de autorización que se utilizará para vincular con la pasarela de pago.

Cargando...