Skip to main content

Authorization Request

POST 
/auth - Quix JavaScript Authorization
Request authorization token for the JavaScript library

Header Parameters

  • Content-Type string required

    Content Type

    Example: application/json

Body

Encode all the information in UTF-8, format it in JSON, and send it by POST to the enabled AP endpoint for its reception.
    merchantId stringrequired

    Identifier of your business on the AP platform.

    • It is a numeric code provided by Support in the welcome email
    • It has 4 to 7 digits and is common for both environments (test/production).
    merchantKey stringrequired

    Javascript password.

    • It is used to verify that the request is legitimate (sent from the merchant).
    • It must match the one stored in 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]

    Currency of the transaction.

    • ISO-4217.3 code (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]

    Country from which the transaction is sent. * ISO 3166-1 alpha-2 code (ES, US, UK, etc.).

    customerId stringrequired

    ID. of the customer in your e-commerce platform.

    • Alphanumeric – Max. 80 characters.
    • Should it be sent empty for non-registered customers (guest).
    productId stringrequired

    Highly Recommended identifier of the product created in your business in AP for which it must be processed the transaction.

    • It is provided in the welcome email.
    • Has 6 to 11 numerical digits.
    • The product is the one that limits which payment solutions of those activated for commerce are offer to the customer.
    • AP allows businesses to have various products configured to their needs.
    • If it is not sent, AP will use the first product from the business that is marked in the DB as "default"
    • If the merchant does not have any product marked "default" and the parameter is not sent, the request will fail.
      • It can be different depending on the environment (test and production).
    • For example:
      • A business has the card, Bizum and Quix payment solutions activated.
      • The business has two products, one for national customers with all payment solutions activated, and another for international customers with only card payment.
      • The merchant indicates the identifier of one or another product in the request depending on the nationality of your client
      • With this, it avoids offering payment solutions such as Bizum or Quix, which can only operate with national clients, to international clients.
    anonymousCustomer boolean

    OPTIONAL DATA Boolean that indicates whether or not the customer is registered in your e-commerce platform.

    • Affects the display of the "Remember me" box that allows you to save a card or account associated with the client identifier.
    • The possible values are:
      • false (default): customer registered in your e-commerce platform, so the "Remember me" box will be displayed so that you can save the card or account associated with your id. of client.
      • true: non-registered customer, so the "Remember me" box will not be shown and you will not be able to save the card or account.
Responses
Authorization Token Generated
Schema
    authToken string

    The authoriztion token that will be used to link with the payment gateway.

Loading...