Skip to main content

Creates payment redirect link

POST 
/tokenize - Hosted
Creates payment redirect link

Query Parameters

  • merchantId string required

    Identifier of your business in the Addon Payments platform.

    Example: 116659
  • encrypted string required
    • Encryption of the cleartext query parameters
    • Results will be sent will be in base64 form
    • For the object see the Request Body
    Example: 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
    • Hash256 of the cleartext query parameters in UTF_8 bytes
    • Sent in hex form in lower case
    Example: c4ca128afe39a4e2c5c3c529813f536d0265b5b90f30eeb3278236406d67db7c

Header Parameters

  • apiVersion string required

    Version of the AP API for which the request should be processed

    • Supported values are 3, 4, and 5 (recommended)
    Example: 5
  • encryptionMode string required

    AES-256 encryption type used (CBC)

    Example: CBC
  • iv string required

    Initial Vector used in the encryption process in Base64 Form

    Example: gH9j/x+Qu7M2r2SYPfa3UA==

Body

-- DON'T SEND THIS REQUEST BODY, IT'S JUST FOR DESCRIPTION -- This is the object used in "encrypted" field
    merchantId Integer numeric 4~7 digitsrequired

    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).
    merchantTransactionId Alphanumeric Max 45 charactersrequired

    Transaction identifier in your trading platform electronic. It is used for your platform to link the notifications received with the customer's order.

    • It cannot be repeated between transactions.
    • Max. 45 characters - Latin-1 code page (ISO-8859-1)
    amount Decimal numeric 0~1000000.00required

    Amount of the transaction.

    • If the amount contains decimals, the period (.) is used as the decimal separator.
    • You cannot include a thousands separator.
    • In transactions that do not generate monetary movement, such as the registration of a customer's card, zero (0) must be sent as the amount.
    • For example, €1,234.56 would be sent 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]

    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.).

    paymentSolution stringrequired

    Name of the payment solution through which the transaction must be processed (creditcards, bizum, paypal, quix, etc.).

    • Mandatory in the following cases:
      • If the cashier type “Only form” has been selected.
      • If you want to limit the customer to the payment solution sent.
    customerId Alphanumeric Max 80 charactersrequired

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

    • Alphanumeric – Max. 80 characters.
    operationType stringrequired

    Possible values: [DEBIT, CREDIT]

    Specifies the type of operation to perform.

    • If the parameter is not sent, "debit" will be used by default.
    • Possible values are:
      • debit: payment transaction, that is, cash travels from the customer's account to the merchant.
      • credit: deposit transaction in the client's account, that is, the cash travels from the merchant to the client'saccount, such as the payment of a prize. Not to be confused with returns, which have their own type of transaction.
    transactionId string

    id. of the initial transaction in AP on which a secondary transaction is going to be carried out (settlement, release, return). It is required only in secondary transactions that are made on top of an authorized initial transaction.

    productId Integer numeric 6~11 digitsrequired

    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.
    language string

    Possible values: [ES, EN]

    language in which the payment gateway must be displayed to the customer.

    • Only for hosted integration.
    • The following languages are currently available:
      • ES: Spanish
      • EN: English
    statusURL Alphabetical ISO 639-1required

    Highly Recommended URL of your e-commerce platform where AP will send the notification with the status of the transaction.

    • If it is sent in the request, it will have priority over the one configured in the Addon Payments administration panel.
    • Alphanumeric – Max. 2048 characters.
    successURL Alphabetical ISO 639-1required

    Highly Recommended Return URL to the merchant's website to which the customer will be redirected if the transaction is authorized.

    • Alphanumeric – Max. 2048 characters.
    • If it is sent in the request, it will have priority over the one configured in the Addon Payments administration panel.
    • If it is not sent in the request, the client will be redirected to the URL configured in the module administration.
    errorURL Alphabetical ISO 639-1required

    Highly Recommended Return URL to the merchant's website to which to redirect the customer if the transaction is denied.

    • Alphanumeric – Max. 2048 characters.
    • If it is sent in the request, it will have priority over the one configured in the Addon Payments administration panel.
    • If it is not sent in the request, the client will be redirected to the URL configured in the module administration.
    cancelURL Alphabetical ISO 639-1required

    Highly Recommended Return URL to the merchant's website to which the customer will be redirected if they cancel the transaction.

    • Alphanumeric – Max. 2048 characters.
    • If it is sent in the request, it will have priority over the one configured in the Addon Payments administration panel.
    • If it is not sent in the request, the client will be redirected to the URL configured in the module administration.
    awaitingURL Alphabetical ISO 639-1required

    URL of your platform to which the customer is redirected if the payment solution has to carry out internal procedures that may take time.

    type string

    Possible values: [MOTO, ECOM]

    Channel through which the transaction must be managed.

    • Possible values are:
      • ecom: electronic commerce.
      • moto: order by phone or email.
    merchantParams Clave1:Valor1;Clave2:Valor2;ClaveN:ValorN Max. 500 characters

    Parameters that your electronic commerce platform sends to modify the management of the transaction in AP.

    • The parameters that are sent will be received back in the response.
    description Alphanumeric Max. 1000 characters

    Description of the transaction.

    • It can be useful to locate or identify it later in the AP management panel.
    printReceipt boolean

    Possible values: [true, false]

    Show the end customer a receipt in the optional redirection process.

    forceTokenRequest boolean

    Possible values: [false, true]

    Indicates whether or not to save the customer's card token. If you don't want to save the card, use "false"

    referenceId Alfanumérico 12 caracteres

    Variable reference for businesses that need FB500 reconciliation files.

Responses
Redirect Link Created
Schema
    string
Loading...