Quix

Introduction

Quix is the “Buy Now Pay Later” financing service from Caixabank Payments & Consumer (CPC) that connects businesses, financing companies and customers. It allows your customers to spread out their purchases over 3 to 12 months, for orders from €50 to €1200.

Note: Currently, Quix is only available for transactions in Euros and for customers with Spanish nationality who reside in Spain.

Quix offers the following integration services:

Checkout widget: A visual element compatible with Addon Payments Hosted and JavaScript Integrations that allows customers to complete the financing process.
Payment simulator: Allows customers to simulate the financing periods and payment options available.

So your customers will recognize the financing solution and get the best financing conditions, we recommend the following set up:

Load the Quix logo on your ecommerce (download attached resources)
Add “Pay in instalments” or equivalent so it is easily recognizable.

Payment type	Financing
Countries available	Spain
Currencies available	Euro
Minimum total	€50
Maximum total	€1200
Payment over	3 to 12 months
Redirect required?	Yes
Two-step payment allowed?	No
Refunds allowed?	Yes

Your ecommerce platform must recognize consent or notify the customer in the purchase conditions that their personal data will be disclosed to Quix to process the financing. This is a sample legal disclaimer:

By ticking this box, you are consenting to [YOUR BUSINESS] disclosing your personal data and contact information (name and surname, date of birth and email address) to SEQURA WORLDWIDE S.A., which will process your data as the data controller for the purpose of processing your financing. For more information on how your data is processed, go to https://legal.sequra.com/politica-privacidad.

To use this payment solution, you have to contract the service with CPC. For commercial information or if you haven’t contracted the service, you can contact your usual CPC account manager or go to the CPC website for more information: https://www.caixabankpc.com/es/comercios. You can also contact them by email at digital@caixabankpc.com.

This guide provides the information you need to integrate the Quix financing payment solution on the Addon Payments gateway for Hosted and JavaScript integrations.

Note: The Quix payment solution is not currently compatible with Host2Host integration.

This guide is in addition to the basic integration guide you chose to integrate with AP:

You also have a glossary of terms and a Postman collection with Quix operations:

Credentials for integration testing

You can use the following data to test the integration of the payment solution on your ecommerce platform:

DNI: 99999999R (can use any).
Phone number: 600000000 (can use any).
Validation code: Last 5 digits of the phone number entered.
Card:
- PAN: 4716773077339777
- Expiry: 12/30
- CVV: 123

These credentials will work as long as the payment gateway is configured to operate in the AP Staging environment. To test the integration in Production environment you will need to use real and active credentials.

Environments: Staging and Production

Addon Payments has two (2) separate operating environments:

Staging environment:

This is the first environment you will use.
There is a list of cards to use for testing the system, creating transaction simulations of various operations, authentication types (frictionless, challenge) and results (authorized, declined).
This will allow you to make sure that the different situations are handled properly by your integration.
Real cards and accounts don’t work.

Production Environment:

In this environment, transactions are real.
You can only use real, operational cards and accounts.

Below you have some tables with the endpoints to send the request, depending on the type of integration:

Environment	URL
Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/tokenize
Production	https://checkout.addonpayments.com/EPGCheckout/rest/online/tokenize

Request	Environment	URL
Request /auth	Staging	https://epgjs-mep-stg.addonpayments.com/auth
Request /charge	Staging	https://epgjs-mep-stg.addonpayments.com/charge/v2
Request /auth	Production	https://epgjs-mep.addonpayments.com/auth
Request /charge	Production	https://epgjs-mep.addonpayments.com/charge/v2

Below is a table with the AP library for JavaScript that you need to import and the call to set up the base URL for the payment gateway.

You have to add a <script> HTML element with the route to the AP JS library to your ecommerce platform payment page. This route must include the version of the library to load. We currently recommend using version 4.0.0.

Function	Environment	URL
Import the Addon Payments JS library	Staging	https://epgjs-rendercashier-stg.addonpayments.com/js/public/epgjs-[versión]-min.js
Set the base URL for the payment gateway	Staging	https://epgjs-web-stg.addonpayments.com/
Import the Addon Payments JS library	Production	https://epgjs-rendercashier.addonpayments.com/js/public/epgjs-[versión]-min.js
Set the base URL for the payment gateway	Production	https://epgjs-web.addonpayments.com/

Hosted Integration

Below we explain how to do the Quix integration via Hosted.

Request

This is a sample request for a merchant that sells goods. The parameters in the request depend on the service the business provides. In the section Parameters by service you have a table with the parameters for all the different services.

Plus, we recommend you visit our 3DSecure section to add additional fields to the payment process. These optional data fields enrich the payment request and can facilitate the authentication process.

Remember that requests sent to Addon Payments must be encrypted. Visit our Encryption, signature and sending the request for more information.

This is a sample string and cURL request for a product on Quix via Hosted. Remember, the string must go through the process of encryption, signature and sending the request.

				
					currency=EUR&amount=99&country=ES&customerId=903&merchantId
=116659&merchantTransactionId=79037935&paymentSolution=quix&statusURL
=https://webhook.site/359a42a8-4759-45cb-81cd-6d34e546617f&successURL
=https://test.com/success&errorURL=https://test
.com/error&cancelURL=https://test.com/cancel&awaitingURL
=https://test.com/awaiting&firstName=Name&lastName=Last Name&productId
=1166590003&customerEmail=email@micomercio.com&customerNationalId
=99999999R&customerCountry=ES&dob=1999-12-01&ipAdress=192.168.1
.1&paysolExtendedData
={"product":"instalments","billing":{"first_name":"Nombre","last_name":"Apellido","address":{"street_address":"Nombre de la vía y nº","postal_code":"08003","city":"Barcelona","country":"ESP"}},"cart":{"currency":"EUR","total_price_with_tax":99,"items":[{"article":{"name":"Nombre del servicio 2","type":"product","category":"physical","description":"Descripción artículo 2","reference":"4912345678903","unit_price_with_tax":99,"autoshipping":false},"units":2,"total_price_with_tax":99,"auto_shipping":true}]}}

				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/tokenize' \
--header 'apiVersion: 5' \
--header 'encryptionMode: CBC' \
--header 'iv: bdlDqWWCnw+aAra4vLujFA==' \
--form 'merchantId="12345"' \
--form 'encrypted="jULXEtDfSVYIgfV29GBTcibe+ED+IvnfI2ssayrpqoJRzmI+SVst1SV3LRjt7DHlU5+0FoBPZy8KfoajNYn6DwRU0ltMtgd2TsR2ccm+Aeg5NAPbMlVZZnDmWA2WUmh3sXFWDMFGcHnwigMv0dWW+0QOieFJN+NLPMo/HMhLOLNNfS9240qdT++PTx7IdtSM3hfbD31ZDgKSkxwCDQYSrcIS0LyPtRuRkMQjHNMjOzo/FNSe0dqTdRw0dI5QpoqAgFk8MEkByIiZPIK6GYzkRv9NsBrVpRw3271VPG7gDlK4+ZEkjRXJ+JQgV0QxybU4XNE1pPlB3BxzBtsr56gPEVCNrVjNQtfTwNqphT39+7GShtEUrAsKU7r+nxivGxhd/8b2ECkk/7Dk7WPLnCJPnXJrIAWzKd1wiPaTPYrMvCuxRAMYF+sk6ZPENAipntbetAbXHDVs6KKbjyCjDLRwGX7rrIlPi0TTIH9nGfPTq4DL1CDxivnjd1eOGOnHzQRr”' \
--form 'integrityCheck="0bc22b4408a6a2bf135fd2eb3832775f44b02f96d7e10d940b81c5069763685f"'

Once the POST is sent to Addon Payments, you will receive a redirect URL for the customer:

				
					https://checkout.stg-eu-west3.epgint.com/EPGCheckout/rest/online/detokenize
?token=4b374d64-a263-43dc-bb74-c8e88257d4c2&apiVersion=5

To learn more about when to redirect the client, visit the Redirecting customer section.

Request parameters via Hosted

The type indicates whether the parameter is required (R) or optional (O):

Field	Format	Type	Description	Example
prepayToken	Alphanumeric UUID Format	R (only in JS integration)	It is sent in the request header. AP returns this reference after the customer enters their details in the JS payment form. It is the reference that links to the customer’s card or account details for JavaScript integration.	97fe3726-adb1-4e24-9fb8-92593a75ae74
merchantId	Whole number 4~7 digits	R	Your merchant’s ID on the AP platform. Provided by Support in the welcome email. It is the same for both environments	14983
productId	Whole number 6~11 digits	R	Product ID created on your AP merchant. You’ll find it in the welcome email.	149830
paymentSolution	Alphanumeric Accepted value: – quix	R	Name of the payment solution to process the transaction. In this case “quix”	quix
merchantTransactionId	Alphanumeric Max 45 characters	R	This is the unique identifier of the merchant’s transaction. It is used by your platform to link the notifications received with the customer’s order.	pedido_91684
amount	Numerical with decimals 0~1000000.00	R	Amount of the transaction. If the amount has decimals, the separator is a dot (.). The separator cannot be included in the thousands.	127.5
currency	Alphabetical 3 characters ISO-4217.3	R	Currency of the transaction	EUR
country	Alphabetical 2 characters ISO 3166-1 alfa-2	R	Country from which the transaction is sent	ES
customerId	Alphanumeric Max 80 characters	R	Customer ID in your e-commerce platform.	A34623
statusURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	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 take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/status
successURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is authorized. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/success
errorURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is declined. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/error
cancelURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is cancelled during the payment process. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/cancel
awaitingURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is pending processing. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/awaiting
firstName	Alphabetical Max 100 characters	R	Customer’s name. If more than one, use spaces between them.	Pablo
lastName	Alphabetical Max 100 characters	R	Customer’s surname(s) Both surnames must be sent, with a space between them. If both aren’t sent, the Quix widget will request them	Ferrer Calas
customerEmail	Alphabetical Max 100 characters	R	Customer’s email address.	correo@mail.com
customerCountry	Code ISO 3166-1 Alfa-2 “ES”	R	Customer’s country. Currently only available for Spain.	ES
customerNationalId	Alphanumeric Max 100 characters	R	DNI (with letter) for Spanish customers.	40404040A
dob	Alphanumeric Max 10 characters. YYYY-MM-DD	R	Customer date of birth. If not sent, the widget will request it. Quix is only available to customers of legal age.	1990-01-01
ipAddress	Alphanumeric Max 45 characters. Format IPv4 or IPv6	R	Customer’s IP address.	192.158.1.38
operationType	Alphanumeric Max 45 characters	O	Specifies type of operation to carry out. Values accepted: – debit (default): Payment transaction. Meaning, the funds go from the customer’s account to the merchant. – credit: Payment into customer’s account. EMeaning the funds go from the merchant to the customer’s account. For example, prize money. Don’t confuse with refunds. These have their own type of transaction.	debit
paymentMethod	Value accepted: – “instalments”	O	Sub method of the payment solution.	instalments
telephone	Alphanumeric Max 45 characters	O	Phone number. With country code.	+34600600600
language	ISO 639-1 -ES -EN	O	Language to show customer the payment gateway. It is only available in Spanish and English.	ES
paysolExtendedData	The parameters it contains are on the following tables.	R	JSON object with extra information about the customer, billing and cart.	N/A

Parameters by service

Below you have tables with the parameters required depending on the service your business provides. The type shows whether they are required (R) or optional (O). All these parameters go in “paysolExtendedData”.

Note: These tables have parameters that are JSON objects that contain other parameters inside. You can distinguish them by their darker color, and some of the fields they contain are also indicated. You can see the structure more clearly in the JSON section.

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Artículo 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− description	Alphanumeric	O	Description of the item.	Computer
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the item.	23.50
−−− brand	Alphanumeric	O	brand or manufacturer of the item.	Brand
−−− mpn	Alphanumeric	O	item manufacturer code.	8234F
shipping	Object. Can contain: – name – first_name – last_name – company – email – phone_number – address	O	JSON object with extra information	N/A
− name	Alphanumeric	O	Name of the shipping company.	Company S.L.
− first_name	Alphanumeric	O	Recipient’s name.	Pablo
− last_name	Alphanumeric	O	Recipient’s surname(s).	Ferrer
− company	Alphanumeric	O	Recipient’s company name.	Company S.A.
− email	Alphanumeric	O	Recipient’s email address.	email@correo.es
− phone_number	Alphanumeric +34XXXXXXXXX	O	Recipient’s phone number. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	+34600600600 Encoded: %2B34600600600
− method	Alphanumeric home: Send to home digital: digital shipment postal: pick up at post office pick_up_point: pick-up point pick_up_store: pick up in shop pick_up_warehouse: collect from warehouse own: own method click_collect: collect in shop	O	Product or service shipping method.	home
− address	Object. Must contain these fields: – street_address – street_address_2 – postal_code – city – country	O	JSON object with extra information for shipping address.	N/A
−− street_address	Alphanumeric	O	Type of street, street name and number for shipping address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for shipping address.	3 F
−− postal_code	Alphanumeric	O	Postcode for shipping address.	08003
−− city	Alphanumeric	O	City for shipping address	Barcelona
−− country	Alphanumeric	O	Country for shipping address	ESP

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Item 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− end_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	R	Service end date. The end date must be after the request date and the service start date IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-12-31T23:59:59+01:00 Encoded: 2023-12-31T23:59:59%2B01:00%2B
−−− start_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	O	Service start date IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-01-01T00:00:00+01:00 Encoded: 2023-01-01T00:00:00%2B01:00
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− description	Alphanumeric	O	Description of the service.	Computer
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the service.	23.50

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Item 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− departure_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	R	Departure date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-01-01T00:00:00+01:00 Encode: 2023-01-01T00:00:00%2B01:00
−−− passengers	Object. Must contain a JSON with these obligatory fields for each passenger: – first_name – last_name	R	JSON object with passenger information	N/A
−−−− first_name	Alphanumeric	R	Passenger name	Pablo
−−−− last_name	Alphanumeric	R	Passenger surname	Ferrer
−−− segments	Object. Must contain a JSON with these obligatory fields for each passenger: – iata_departure_code – iata_destination_code	R	JSON object with departure and arrival points	N/A
−−−− iata_departure_code	Alphanumeric	R	IATA code for departure airport	MAD
−−−− iata_destination_code	Alphanumeric	R	IATA code for arrival airport	BCN

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Items 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	accommodation
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− checkin_date	YYYY-MM-DDTHH:mm:ss+HH:mm	R	Check-in date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2024-01-01T16:00:00+00:00 Codificado: 2024-01-01T16:00:00%2B00:00
−−− checkout_date	YYYY-MM-DDTHH:mm:ss+HH:mm	R	Check-out date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2024-01-06T12:00:00+00:00 Codificado: 2024-01-06T12:00:00%2B00:00
−−− establishment_name	Alphanumeric	R	Establishment name	Hotel 2
−−− guests	Whole number	R	Number of guests	2
−−− description	Alphanumeric	O	Description of the item.	Ordenador
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Codificado: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the item.	23.50
−−− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information of the accommodation address.	N/A
−−−− street_address	Alphanumeric	R	Type of street, street name and number of the accommodation address.	Calle canales 2
−−−− street_address_2	Alphanumeric	O	Unit number of the accommodation address	3 F
−−−− postal_code	Alphanumeric	R	Postcode of the accommodation address	08003
−−−− city	Alphanumeric	R	City of the accommodation address	Barcelona
−−−− country	Alphanumeric	R	Country of the accommodation address	ESP

JSON by service

Below you have sample JSON with the basic parameters (not encrypted) by service:

Remember that requests sent to Addon Payments must be encrypted. Visit our Encryption, signature and sending the request for more information.

				
					[merchantId] => 12345
[productId] => 14983
[merchantTransactionId] => 13035363
[amount] => 99
[currency] => EUR
[country] => ES
[customerId] => 1
[paymentSolution] => quix
[statusURL] => https://test.com/status
[successURL] => https://test.com/success
[errorURL] => https://test.com/error
[cancelURL] => https://test.com/cancel
[awaitingURL] => https://test.com/awaiting
[firstName] => Nombre
[lastName] => Apellido
[customerEmail] => nombre.apellido@correo.com
[customerNationalId] => 99999999R
[customerCountry] => ES
[dob] => 1981-10-01
[ipAddress] => 192.168.1.1
[paysolExtendedData] => {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Apellido",
        "address": {
            "street_address": "Nombre de la vía y nº",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.00,
        "items": [{
                "article": {
                    "name": "Producto físico",
                    "type": "product",
                    "category": "physical",
                    "reference": "4912345678903",
                    "unit_price_with_tax": 49.50
                },
                "units": 2,
                "total_price_with_tax": 99.00,
                "auto_shipping": true
            },
        ]
    }
};

				
					[merchantId] => 12345
[productId] => 14983
[merchantTransactionId] => 13035363
[amount] => 99.99
[currency] => EUR
[country] => ES
[customerId] => 1
[paymentSolution] => quix
[statusURL] => https://test.com/status
[successURL] => https://test.com/success
[errorURL] => https://test.com/error
[cancelURL] => https://test.com/cancel
[awaitingURL] => https://test.com/awaiting
[firstName] => Nombre
[lastName] => Apellido
[customerEmail] => nombre.apellido@correo.com
[customerNationalId] => 99999999R
[customerCountry] => ES
[dob] => 1981-10-01
[ipAddress] => 192.168.1.1
[paysolExtendedData] => {
   "product":"instalments",
   "billing":{
      "first_name":"Nombre",
      "last_name":"Apellido",
      "address":{
         "street_address":"Nombre de la vía y nº",
         "postal_code":"08003",
         "city":"Barcelona",
         "country":"ESP"
      }
   },
   "cart":{
      "currency":"EUR",
      "total_price_with_tax":99.99,
      "items":[
         {
            "article":{
               "name":"Nombre del servicio",
               "type":"service",
               "category":"digital",
               "reference":"4912345678904",
               "unit_price_with_tax":99.99,
               "end_date":"2023-12-31T23:59:59+01:00" // El símbolo "+" de este parámetro debe someterse a URL Encode
            },
            "units":1,
            "total_price_with_tax":99.99,
            "auto_shipping": true
         }
      ]
   }
};

				
					[merchantId] => 12345
[productId] => 14983
[merchantTransactionId] => 13035363
[amount] => 99.99
[currency] => EUR
[country] => ES
[customerId] => 1
[paymentSolution] => quix
[statusURL] => https://test.com/status
[successURL] => https://test.com/success
[errorURL] => https://test.com/error
[cancelURL] => https://test.com/cancel
[awaitingURL] => https://test.com/awaiting
[firstName] => Nombre
[lastName] => Apellido
[customerEmail] => nombre.apellido@correo.com
[customerNationalId] => 99999999R
[customerCountry] => ES
[dob] => 1981-10-01
[ipAddress] => 192.168.1.1
[paysolExtendedData] => {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Last Name",
        "address": {
            "street_address": "Nombre de la vía y n 13",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.99,
        "items": [{
            "article": {
                "name": "Vuelo MAD - BCN",
                "type": "flight",
                "category": "digital",
                "reference": "4912345678904",
                "unit_price_with_tax": 99.99,
                "departure_date": "2024-01-01T00:00:00+01:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "passengers": [{
                    "first_name": "Nombre1",
                    "last_name": "Apellido1",
                }, ],
                "segments": [{
                    "iata_departure_code": "MAD",
                    "iata_destination_code": "BCN",
                }],

            },
            "units": 1,
            "total_price_with_tax": 99.99,
            "auto_shipping": true
        }]
    }
};

				
					[merchantId] => 12345
[productId] => 14983
[merchantTransactionId] => 13035363
[amount] => 99.99
[currency] => EUR
[country] => ES
[customerId] => 1
[paymentSolution] => quix
[statusURL] => https://test.com/status
[successURL] => https://test.com/success
[errorURL] => https://test.com/error
[cancelURL] => https://test.com/cancel
[awaitingURL] => https://test.com/awaiting
[firstName] => Nombre
[lastName] => Apellido
[customerEmail] => nombre.apellido@correo.com
[customerNationalId] => 99999999R
[customerCountry] => ES
[dob] => 1981-10-01
[ipAddress] => 192.168.1.1
[paysolExtendedData] => {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Apellido",
        "address": {
            "street_address": "Nombre de la vía y nº",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.99,
        "items": [{
            "article": {
                "name": "Alojamiento",
                "type": "accommodation",
                "category": "physical",
                "reference": "4912345678904",
                "unit_price_with_tax": 99.99,
                "checkin_date": "2024-01-01T16:00:00+00:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "checkout_date": "2024-01-06T12:00:00+00:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "establishment_name": "Hotel Ejemplo",
                "address": {
                    "street_address": "Tipo, nombre y n.º de la vía",
                    "postal_code": "00000",
                    "city": "Madrid",
                    "country": "ESP"
                },
                "guests": 3
            },
            "units": 1,
            "total_price_with_tax": 99.99,
            "auto_shipping": true
        }]
    }
};

Response

Visit our section on Managing notifications to learn more about its structure.

This is a sample response for final payment of a product:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response operation-size="1">
	<message>Quix callback response has finished successfully, for the transaction Id: 7737819</message>
	<operations>
		<operation sorted-order="1">
			<amount>99.0</amount>
			<currency>EUR</currency>
			<details>{"order_id":"13214d8b-6380-414c-b018-339f9e426048","event":"order_capture_created","triggered_at":"2023-11-23T13:54:13+00:00","order_reference_1":"59376738","order_reference_2":"7737819","description":"Capture auto-generated by auto shipping","captured_amount":99,"captured_items":[{"id":"ac11140a-4cfd-40f9-a93e-2f3973266af7","total_discount":{"currency":"EUR","amount":0},"total_price_with_tax":{"currency":"EUR","amount":99},"units":2,"article":{"id":"b03fc588-4f76-484c-9fe4-5ce789b5da6a","type":"online_product","name":"Nombre del servicio 2","category":"physical","price":{"currency":"EUR","amount":99},"reference":"4912345678903","description":"Descripcin articulo 2"}}]}</details>
			<merchantTransactionId>59376738</merchantTransactionId>
			<message>Transaction change to SUCCESS.</message>
			<operationType>DEBIT</operationType>
			<paymentSolution>quix</paymentSolution>
			<status>SUCCESS</status>
			<transactionId>7737819</transactionId>
			<respCode>
				<code>0000</code>
				<message>Successful</message>
				<uuid>22da7b17_3644_4cdf_8645_2ae23c2e13bc</uuid>
			</respCode>
		</operation>
	</operations>
	<optionalTransactionParams/>
	<status>SUCCESS</status>
	<workFlowResponse>
		<id>389281</id>
		<name>BNPL</name>
		<version>0</version>
	</workFlowResponse>
</response>

JavaScript Integration

In this section, you will see how to integrate Quix with JavaScript.

Getting the authToken

The first step to get the authToken so we can render the cashier. A request must be sent with at least the info shown below:

				
					{   
    "merchantId": "12345",
    "merchantKey": "dd0bc115-6f8f-4e65-9447-e06862eb62ec",
    "productId": "123450001",
    "currency": "EUR",
    "country": "ES",
    "customerId": "customer25879",
    "operationType": "debit"
}

				
					curl --location 'https://epgjs-mep-stg.addonpayments.com/auth' \
--header 'Content-Type: application/json' \
--data '{
    "merchantId": "12345",
    "merchantKey": "dd0bc115-6f8f-4e65-9447-e06862eb62ec",
    "productId": "123450001",
    "currency": "EUR",
    "country": "ES",
    "customerId": "customer25879",
    "operationType": "DEBIT"
}'

If the request is valid, Addon Payments will return an “authToken” for you to render the cashier on the frontend of your page. If the request isn’t valid, you will get a message like you see on the second tab:

				
					{
    "authToken": "50fe7cab-63c4-4197-9484-50f9a0792f8b"
}

				
					{
    "error": true,
    "errorMessage": "Invalid merchant id or merchant key",
    "errorCode": 400
}

Your platform must store this code to continue to the next step. The authorization tokens received have the following characteristics:

Valid for 30 minutes.
It can be used several times to link to the payment gateway.

Rendering the Quix cashier with JavaScript

Before calling the function to link to the payment gateway (window[‘EPGJS’].renderIntegratedCashier), you have to do these steps so the payment solution will work correctly:

1. Set up “setMerchantPrePayCallback”, a function that will receive the call at the charge endpoint of the EPGJS mep service.

window['EPGJS_COMM'].setMerchantPrePayCallback(prepayCallback);

2. You have to render the cashier on the frontend. This is a sample code:

				
					<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>JS render cashier</title>
    <style>
        #render-cashier {
            width: 350px;
            margin-top: 100px;
            border: 1px solid #ccc;
            padding: 20px;
            text-align: center;
        }
    </style>
</head>

<body>
    <div id="epgjs-cashier-div"></div>
    <script src="https://epgjs-rendercashier-stg.easypaymentgateway.com/js/public/epgjs-4.0.0-min.js"></script>
    <script>
        var authtoken = "5bb1dfd6-7692-47c3-beaf-2326fd74ee89"; // Add here your authToken
        function prePayCallback(prepayData) {
            // Show prepayToken This is just for example purposes only and should not be shown to your customer
            alert(JSON.stringify(prepayData, null, 2));
        }
        function displayingMessageOnButtonClick() {
            EPGJS_COMM.setEpgBaseUrl('https://epgjs-web-stg.easypaymentgateway.com/');
            EPGJS.renderIntegratedCashier(authtoken, 'epgjs-cashier-div', 'quix');
            EPGJS_COMM.setMerchantPrePayCallback(prePayCallback);
            window['EPGJS'].setInitPaysolParam({ "product": "instalments", "amount": 7000, "currency": "EUR", "locale": "es-ES", "decimalSeparator": ".", "thousandSeparator": ",", "style": "width: 100%", "styleBranding": "lending_hub", "styleVariant": "select", "styleColor": "#34aeeb" });
        }
        window.onload = displayingMessageOnButtonClick;
    </script>
</body>
</html>

3. The “setInitPaysolParam” initialization function is a JSON with the parameters from the table. The function call shows how to form them.

Field	Format and values accepted	Type	Description
product	instalments	R	Financing product to apply in the financing widget.
amount	Whole number. Example, 123,45 would be: 12345	R	amount of financing to calculate (product/cart) in cents.
currency	EUR	R	ISO-4217 code for the currency. Currently, only accepts Euro.
locale	Alphanumeric Format RFC 1766 es-ES en-UK	R	Customer language. Currently only available in Spanish or English.
decimalSeparator	. ,	R	Symbol to separate decimals in the amounts. In Spain the decimal symbol is the comma (,).
thousandSeparator	. ,	R	Symbol to separate thousands in the amounts. In Spain the thousands separator is the point (.)
styleBranding	lending_hub	R	Version of the widget to load, which changes the appearance and legal texts shown. Provided by Quix.
style	width: 100%	R	Styles to apply for financing widget. Format column value must be sent.
styleVariant	text select text_banner select_banner	R	Type of widget to load.
styleColor	Hexadecimal #RRGGBB #34aeeb	R	Colour of some elements.
language	es en	O	Language to show widget to customer. Currently only available in Spanish or English.

				
					window['EPGJS'].setInitPaysolParam({ "product": "instalments", "amount": 7000, 
"currency": "EUR", "locale": "es-ES", "decimalSeparator": ".", 
"thousandSeparator": ",", "style": "width: 100%", "styleBranding": 
"lending_hub", "styleVariant": "select", "styleColor": "#34aeeb" });

Charge

With the cashier rendered and the “prepayCallback” function established, you can make a charge. These are the parameters to use. The type shows whether they are required or optional.

Field	Format	Type	Description	Example
prepayToken	Alphanumeric UUID Format	R (only in JS integration)	It is sent in the request header. AP returns this reference after the customer enters their details in the JS payment form. It is the reference that links to the customer’s card or account details for JavaScript integration.	97fe3726-adb1-4e24-9fb8-92593a75ae74
merchantId	Whole number 4~7 digits	R	Your merchant’s ID on the AP platform. Provided by Support in the welcome email. It is the same for both environments	14983
productId	Whole number 6~11 digits	R	Product ID created on your AP merchant. You’ll find it in the welcome email.	149830
paymentSolution	Alphanumeric Accepted value: – quix	R	Name of the payment solution to process the transaction. In this case “quix”	quix
merchantTransactionId	Alphanumeric Max 45 characters	R	This is the unique identifier of the merchant’s transaction. It is used by your platform to link the notifications received with the customer’s order.	pedido_91684
amount	Numerical with decimals 0~1000000.00	R	Amount of the transaction. If the amount has decimals, the separator is a dot (.). The separator cannot be included in the thousands.	127.5
currency	Alphabetical 3 characters ISO-4217.3	R	Currency of the transaction	EUR
country	Alphabetical 2 characters ISO 3166-1 alfa-2	R	Country from which the transaction is sent	ES
customerId	Alphanumeric Max 80 characters	R	Customer ID in your e-commerce platform.	A34623
statusURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	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 take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/status
successURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is authorized. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/success
errorURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is declined. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/error
cancelURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is cancelled during the payment process. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/cancel
awaitingURL	Alphanumeric (characters allowed in URL) Max. 2048 characters	R	URL of your platform to which the customer is redirected if the transaction is pending processing. If it is sent in the request, it will take priority over the one configured in the Addon Payments BackOffice Portal. If it is not sent in the request, the customer will be redirected to the URL configured in the administration module.	https://www.example.com/awaiting
firstName	Alphabetical Max 100 characters	R	Customer’s name. If more than one, use spaces between them.	Pablo
lastName	Alphabetical Max 100 characters	R	Customer’s surname(s) Both surnames must be sent, with a space between them. If both aren’t sent, the Quix widget will request them	Ferrer Calas
customerEmail	Alphabetical Max 100 characters	R	Customer’s email address.	correo@mail.com
customerCountry	Code ISO 3166-1 Alfa-2 “ES”	R	Customer’s country. Currently only available for Spain.	ES
customerNationalId	Alphanumeric Max 100 characters	R	DNI (with letter) for Spanish customers.	40404040A
dob	Alphanumeric Max 10 characters. YYYY-MM-DD	R	Customer date of birth. If not sent, the widget will request it. Quix is only available to customers of legal age.	1990-01-01
ipAddress	Alphanumeric Max 45 characters. Format IPv4 or IPv6	R	Customer’s IP address.	192.158.1.38
operationType	Alphanumeric Max 45 characters	O	Specifies type of operation to carry out. Values accepted: – debit (default): Payment transaction. Meaning, the funds go from the customer’s account to the merchant. – credit: Payment into customer’s account. EMeaning the funds go from the merchant to the customer’s account. For example, prize money. Don’t confuse with refunds. These have their own type of transaction.	debit
paymentMethod	Value accepted: – “instalments”	O	Sub method of the payment solution.	instalments
telephone	Alphanumeric Max 45 characters	O	Phone number. With country code.	+34600600600
language	ISO 639-1 -ES -EN	O	Language to show customer the payment gateway. It is only available in Spanish and English.	ES
paysolExtendedData	The parameters it contains are on the following tables.	R	JSON object with extra information about the customer, billing and cart.	N/A

Parameters by service

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Artículo 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− description	Alphanumeric	O	Description of the item.	Computer
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the item.	23.50
−−− brand	Alphanumeric	O	brand or manufacturer of the item.	Brand
−−− mpn	Alphanumeric	O	item manufacturer code.	8234F
shipping	Object. Can contain: – name – first_name – last_name – company – email – phone_number – address	O	JSON object with extra information	N/A
− name	Alphanumeric	O	Name of the shipping company.	Company S.L.
− first_name	Alphanumeric	O	Recipient’s name.	Pablo
− last_name	Alphanumeric	O	Recipient’s surname(s).	Ferrer
− company	Alphanumeric	O	Recipient’s company name.	Company S.A.
− email	Alphanumeric	O	Recipient’s email address.	email@correo.es
− phone_number	Alphanumeric +34XXXXXXXXX	O	Recipient’s phone number. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	+34600600600 Encoded: %2B34600600600
− method	Alphanumeric home: Send to home digital: digital shipment postal: pick up at post office pick_up_point: pick-up point pick_up_store: pick up in shop pick_up_warehouse: collect from warehouse own: own method click_collect: collect in shop	O	Product or service shipping method.	home
− address	Object. Must contain these fields: – street_address – street_address_2 – postal_code – city – country	O	JSON object with extra information for shipping address.	N/A
−− street_address	Alphanumeric	O	Type of street, street name and number for shipping address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for shipping address.	3 F
−− postal_code	Alphanumeric	O	Postcode for shipping address.	08003
−− city	Alphanumeric	O	City for shipping address	Barcelona
−− country	Alphanumeric	O	Country for shipping address	ESP

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Item 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− end_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	R	Service end date. The end date must be after the request date and the service start date IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-12-31T23:59:59+01:00 Encoded: 2023-12-31T23:59:59%2B01:00%2B
−−− start_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	O	Service start date IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-01-01T00:00:00+01:00 Encoded: 2023-01-01T00:00:00%2B01:00
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− description	Alphanumeric	O	Description of the service.	Computer
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the service.	23.50

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Item 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	product
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− departure_date	Alphanumeric YYYY-MM-DDTHH:mm:ss+HH:mm	R	Departure date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2023-01-01T00:00:00+01:00 Encode: 2023-01-01T00:00:00%2B01:00
−−− passengers	Object. Must contain a JSON with these obligatory fields for each passenger: – first_name – last_name	R	JSON object with passenger information	N/A
−−−− first_name	Alphanumeric	R	Passenger name	Pablo
−−−− last_name	Alphanumeric	R	Passenger surname	Ferrer
−−− segments	Object. Must contain a JSON with these obligatory fields for each passenger: – iata_departure_code – iata_destination_code	R	JSON object with departure and arrival points	N/A
−−−− iata_departure_code	Alphanumeric	R	IATA code for departure airport	MAD
−−−− iata_destination_code	Alphanumeric	R	IATA code for arrival airport	BCN

Field	Format	Type	Description	Example
product	Alphanumeric	R	Type of financing. Currently, the financing available is “instalments “, which allows customers to spread payments out over 10 to 12 months. The value of the “paymentMethod” parameter has priority over the one sent in this key.	instalments
period	Integer Maximum 2 digits	O	Indicates the months that are selected by default in the payment cashier for payments. Although it is sent, the customer will be able to select the frequency of months.	3
disableFormEdition	Boolean: – true (blocks fields) – false (doesn’t block fields)	O	Blocks the fields reported in the request (name, surname, etc.) so that they cannot be modified in the financing form by the customer.	true
confirmation_cart_data	Object. May contain these fields: – url	O	JSON object with extra cart information.	N/A
− url	Alphanumeric	O	URL on your ecommerce platform where Nemuru can check for any changes in the cart information. IMPORTANT: The URLs must be encoded with URL Encode.	https://micomercio.com/url_verificacion_carrito.php Encoded: https%3A%2F%2Fmicomercio.com%2Furl_verificacion_carrito.php
customer	Object. May contain these fields – locale – userAgent	O	JSON object with extra customer information.	N/A
− locale	RFC-1766 – es – en	O	Customer’s language on the merchant’s platform in RFC-1766 format.	es
− userAgent	Alphanumeric Max 256 characters	O	User agent for the customer’s browser Get it from “navigator.userAgent”.	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0
− title	Alphanumeric	O	Customer title (Mr, Ms, etc).	Mr.
− document_expiration_date	Alphanumeric YYYY-MM-ddTHH:mm:ss	O	ID card expiry date.	2030-12-31T00:00:00
− logged_in	Boolean – true – false	O	Shows whether the customer is registered on the platform. “true” if registered, “false” if not.	true
billing	Object. Must contain these fields: – first_name – last_name – address	R	JSON object that contains extra billing information.	N/A
− first_name	Alphanumeric	R	Customer’s name for billing.	Pablo
− last_name	Alphanumeric	R	Customer’s surname for billing.	Ferrer
− corporate_id_number	Alphanumeric	O	Tax ID number of the company ro issue the invoice. In Spain it is a CIF. A valid CIF must be sent.	U73536757
− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information for the billing address.	N/A
−− street_address	Alphanumeric	R	Type of street, street name and number for billing address.	Calle canales 2
−− street_address_2	Alphanumeric	O	Unit number for billing address	3 F
−− postal_code	Alphanumeric	R	Postcode for billing address	08003
−− city	Alphanumeric	R	City for billing address	Barcelona
−− country	Alphanumeric	R	Country for billing address	ESP
cart	Object. Must contain these fields: – total_price_with_tax – currency – items	R	JSON object with extra cart information	N/A
− total_price_with_tax	Numerical with decimal (use point to separate decimal places). NNN.nn	R	Cart total. Must match the “amount”.	123.45
− currency	ISO-4217	R	Currency in ISO-4217	EUR
− reference	Alphanumeric	O	Cart ID on your ecommerce platform. Useful for Quix to identify attempts to pay with different customer data for the same cart.	76t7y7sau8y398y
− items	Object. Must contain these fields: – article – units – total_price_with_tax – auto_shipping	R	JSON object with attributes inside. Merchants registered as “Services” can only include 1 item per request.	N/A
−− units	Whole number	R	Number of units of the item	2
−− total_price_with_tax	Numerical with decimals NNN.nn	R	Total price of the units of the item. Must match the number of units times their value.	246.90
−− auto_shipping	Boolean – false – true	R	Shows whether the product will be shipped automatically after receiving authorization.	true
−− article	Object. Must contain these fields: – name – type – category – reference – unit_price_with_tax	R	JSON object with extra information on a product or service in the cart.	N/A
−−− name	Alphanumeric	R	Name of item or service.	Items 2
−−− type	Values accepted: – “product”: product – “service”: service – “accommodation”: accommodation -“flight”: flight	R	Type of item or service	accommodation
−−− category	Values accepted: -“physical”: physical item -“digital”: digital item -“gift_card”: gift card -“discount”: discount -“shipping_fee”: shipping fees -“sales_tax”: taxes -“store_credit_surcharge”: store credit surcharge	R	Category of item or service	physical
−−− reference	Alphanumeric	R	Item reference on your ecommerce platform	1234A
−−− unit_price_with_tax	Numerical with decimals NNN.nn	R	Unit price for the item	123.45
−−− checkin_date	YYYY-MM-DDTHH:mm:ss+HH:mm	R	Check-in date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2024-01-01T16:00:00+00:00 Codificado: 2024-01-01T16:00:00%2B00:00
−−− checkout_date	YYYY-MM-DDTHH:mm:ss+HH:mm	R	Check-out date and time. IMPORTANT: The dates and phone numbers must have the “+” symbol with URL encode.	2024-01-06T12:00:00+00:00 Codificado: 2024-01-06T12:00:00%2B00:00
−−− establishment_name	Alphanumeric	R	Establishment name	Hotel 2
−−− guests	Whole number	R	Number of guests	2
−−− description	Alphanumeric	O	Description of the item.	Ordenador
−−− url	Alphanumeric	O	URL of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2 Codificado: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− image_url	Alphanumeric	O	URL for a picture of the product or service on your platform. IMPORTANT: The URLs must be encoded with URL Encode.	https://www.micomercio.com/articulo2/imagen.jpg Encoded: https%3A%2F%2Fwww.micomercio.com%2Farticulo2
−−− total_discount	Numerical with decimals NNN.nn	O	Total discounts applied to all the units of the item.	23.50
−−− address	Object. Must contain these fields: – street_address – postal_code – city – country	R	JSON object with extra information of the accommodation address.	N/A
−−−− street_address	Alphanumeric	R	Type of street, street name and number of the accommodation address.	Calle canales 2
−−−− street_address_2	Alphanumeric	O	Unit number of the accommodation address	3 F
−−−− postal_code	Alphanumeric	R	Postcode of the accommodation address	08003
−−−− city	Alphanumeric	R	City of the accommodation address	Barcelona
−−−− country	Alphanumeric	R	Country of the accommodation address	ESP

JSON by service

Below you have sample JSON with the basic parameters (not encrypted) by service:

				
					{
  "currency": "EUR",
  "amount": 99.00,
  "country": "ES",
  "customerId": "1",
  "merchantId": "12345",
  "merchantTransactionId": "13035363",
  "paymentSolution": "quix",
  "statusURL": "https://test.com/status",
  "successURL": "https://test.com/success",
  "errorURL": "https://test.com/error",
  "cancelURL": "https://test.com/cancel",
  "awaitingURL": "https://test.com/awaiting",
  "firstName": "Nombre",
  "lastName": "Apellido",
  "productId": "14893",
  "customerEmail": "nombre.apellido@correo.com",
  "customerNationalId": "99999999R",
  "customerCountry": "ES",
  "dob": "1981-10-01",
  "ipAdress": "192.168.1.1",
  "paysolExtendedData": {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Apellido",
        "address": {
            "street_address": "Nombre de la vía y nº",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.00,
        "items": [{
                "article": {
                    "name": "Producto físico",
                    "type": "product",
                    "category": "physical",
                    "reference": "4912345678903",
                    "unit_price_with_tax": 49.50
                },
                "units": 2,
                "total_price_with_tax": 99.00,
                "auto_shipping": true
            },
        ]
    }
};

				
					{
  "currency": "EUR",
  "amount": 99.99,
  "country": "ES",
  "customerId": "1",
  "merchantId": "12345",
  "merchantTransactionId": "13035363",
  "paymentSolution": "quix",
  "statusURL": "https://test.com/status",
  "successURL": "https://test.com/success",
  "errorURL": "https://test.com/error",
  "cancelURL": "https://test.com/cancel",
  "awaitingURL": "https://test.com/awaiting",
  "firstName": "Nombre",
  "lastName": "Apellido",
  "productId": "14893",
  "customerEmail": "nombre.apellido@correo.com",
  "customerNationalId": "99999999R",
  "customerCountry": "ES",
  "dob": "1981-10-01",
  "ipAdress": "192.168.1.1",
  "paysolExtendedData": {
   "product":"instalments",
   "billing":{
      "first_name":"Nombre",
      "last_name":"Apellido",
      "address":{
         "street_address":"Nombre de la vía y nº",
         "postal_code":"08003",
         "city":"Barcelona",
         "country":"ESP"
      }
   },
   "cart":{
      "currency":"EUR",
      "total_price_with_tax":99.99,
      "items":[
         {
            "article":{
               "name":"Nombre del servicio",
               "type":"service",
               "category":"digital",
               "reference":"4912345678904",
               "unit_price_with_tax":99.99,
               "end_date":"2023-12-31T23:59:59+01:00" // El símbolo "+" de este parámetro debe someterse a URL Encode
            },
            "units":1,
            "total_price_with_tax":99.99,
            "auto_shipping": true
         }
      ]
   }
};

				
					{
  "currency": "EUR",
  "amount": 99.99,
  "country": "ES",
  "customerId": "1",
  "merchantId": "12345",
  "merchantTransactionId": "13035363",
  "paymentSolution": "quix",
  "statusURL": "https://test.com/status",
  "successURL": "https://test.com/success",
  "errorURL": "https://test.com/error",
  "cancelURL": "https://test.com/cancel",
  "awaitingURL": "https://test.com/awaiting",
  "firstName": "Nombre",
  "lastName": "Apellido",
  "productId": "14893",
  "customerEmail": "nombre.apellido@correo.com",
  "customerNationalId": "99999999R",
  "customerCountry": "ES",
  "dob": "1981-10-01",
  "ipAdress": "192.168.1.1",
  "paysolExtendedData": {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Last Name",
        "address": {
            "street_address": "Nombre de la vía y n 13",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.99,
        "items": [{
            "article": {
                "name": "Vuelo MAD - BCN",
                "type": "flight",
                "category": "digital",
                "reference": "4912345678904",
                "unit_price_with_tax": 99.99,
                "departure_date": "2024-01-01T00:00:00+01:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "passengers": [{
                    "first_name": "Nombre1",
                    "last_name": "Apellido1",
                }, ],
                "segments": [{
                    "iata_departure_code": "MAD",
                    "iata_destination_code": "BCN",
                }],

            },
            "units": 1,
            "total_price_with_tax": 99.99,
            "auto_shipping": true
        }]
    }
};

				
					{
  "currency": "EUR",
  "amount": 99.99,
  "country": "ES",
  "customerId": "1",
  "merchantId": "12345",
  "merchantTransactionId": "13035363",
  "paymentSolution": "quix",
  "statusURL": "https://test.com/status",
  "successURL": "https://test.com/success",
  "errorURL": "https://test.com/error",
  "cancelURL": "https://test.com/cancel",
  "awaitingURL": "https://test.com/awaiting",
  "firstName": "Nombre",
  "lastName": "Apellido",
  "productId": "14893",
  "customerEmail": "nombre.apellido@correo.com",
  "customerNationalId": "99999999R",
  "customerCountry": "ES",
  "dob": "1981-10-01",
  "ipAdress": "192.168.1.1",
  "paysolExtendedData": {
    "product": "instalments",
    "billing": {
        "first_name": "Nombre",
        "last_name": "Apellido",
        "address": {
            "street_address": "Nombre de la vía y nº",
            "postal_code": "08003",
            "city": "Barcelona",
            "country": "ESP"
        }
    },
    "cart": {
        "currency": "EUR",
        "total_price_with_tax": 99.99,
        "items": [{
            "article": {
                "name": "Alojamiento",
                "type": "accommodation",
                "category": "physical",
                "reference": "4912345678904",
                "unit_price_with_tax": 99.99,
                "checkin_date": "2024-01-01T16:00:00+00:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "checkout_date": "2024-01-06T12:00:00+00:00", // El símbolo "+" de este parámetro debe someterse a URL Encode
                "establishment_name": "Hotel Ejemplo",
                "address": {
                    "street_address": "Tipo, nombre y n.º de la vía",
                    "postal_code": "00000",
                    "city": "Madrid",
                    "country": "ESP"
                },
                "guests": 3
            },
            "units": 1,
            "total_price_with_tax": 99.99,
            "auto_shipping": true
        }]
    }
};

First response

The charge response includes, among others, these parameters: “nemuruCartHash” and “nemuruAuthToken”. The response “status” is “AWAITING_PAYSOL”, which shows the transaction isn’t finished yet.

				
					<payfrex-response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 463689</message>
    <operations>
      <operation sorted-order="1">
        <amount>10.0</amount>
        <currency>EUR</currency>
        <details>{"orderId":"250fefd6-024b-4efb-bb20-c64315ced79e","authToken":"l2PH2noUxxrf702ZMpet8fJbGwtz2vJV"}</details>
        <merchantTransactionId>687259596</merchantTransactionId>
        <message>Transaction was awaiting paysol.</message>
        <operationType>DEBIT</operationType>
        <optionalTransactionParams/>
        <payFrexTransactionId>463689</payFrexTransactionId>
        <paymentDetails>
          <extraDetails>
            <entry>
              <key>nemuruAuthToken</key>
              <value>l2PH2noUxxrf702ZMpet8fJbGwtz2vJV</value>
            </entry>
            <entry>
              <key>nemuruCartHash</key>
              <value>250fefd6-024b-4efb-bb20-c64315ced79e</value>
            </entry>
          </extraDetails>
        </paymentDetails>
        <paymentSolution>nemuru</paymentSolution>
        <status>AWAITING_PAYSOL</status>
      </operation>
    </operations>
    <status>SUCCESS</status>
    <workFlowResponse>
      <id>4975</id>
      <name>NEMURU PAY</name>
      <version>1</version>
    </workFlowResponse>
</payfrex-response>

To display the Quix widget, and with the previous data, you call the following function. (1)

Optional: If you have sent the “disableFormEdition” parameter, you must call the following function. Also, its value will come in the extraDetails of the previous answer. (2)

1: window['NEMURU'].checkoutNemuru(nemuruAuthToken, nemuruCartHash);

2 (optional): window['NEMURU'].checkoutNemuru(nemuruAuthToken, nemuruCartHash, disableFormEdition);

When the widget process finishes, this commerce function will be called:

window['NEMURU'].setStatusCallback(merchantFunction);

Second response

With the Quix widget loaded, the customer must fill in all their details to complete the transaction. If successfully completed, you will receive a notification indicating the status of the operation:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
	<message>Quix callback response has finished successfully, for the transaction Id: 7737903</message>
	<operations>
		<operation sorted-order="1">
			<amount>200.0</amount>
			<currency>EUR</currency>
			<details>{"order_id": "f18a5ea7-afa2-47ad-b4cc-e1b326c9a67a", "event": "order_capture_created", "triggered_at": "2023-11-23T14:32:02+00:00", "order_reference_1": "26031079", "order_reference_2":"7737903", "description": "Capture auto-generated by auto shipping", "captured_amount":200, "captured_items":[{"id":"6c92 ef42-5f5d-45f7-a075-38cd126d682c", "total_discount":{"currency":"EUR", "amount":0},"total_price_with _tax":{"currency":"EUR", "amount":200},"units": 1, "article":{"id": "bfd6dc77-8153-49dc-ac67-fffabd18f f69", "type": "online_product", "name":"Nombre del servicio", "category":"physical", "price":{"currency ":"EUR", "amount":200}, "reference":"4912345678904"}}]}</details>
			<merchantTransactionId>26031079</merchantTransactionId>
			<message>Transaction change to SUCCESS.</message>
			<operationType>DEBIT</operationType>
			<transactionId>7737903</transactionId>
			<paymentSolution>quix</paymentSolution>
			<status>SUCCESS</status>
			<respCode>
				<code>0000</code>
				<message>Successful</message>
				<uuid>22da7b17_3644_4cdf_8645_2ae23c2e13bc</uuid>
			</respCode>
		</operation>
	</operations>
	<optionalTransactionParams/>
	<status>SUCCESS</status>
	<workFlowResponse>
		<id>389281</id>
		<name>BNPL</name>
		<version>0</version>
	</workFlowResponse>
</payfrex-response>

Refunds with Quix

You can make refunds with Quix in 2 ways:

1. Through the AP BackOffice Portal:

You can find more information on how to manage transactions through the Addon Payments Portal in the BackOffice Portal Search operations guide.
Important: When you click on refund in the BackOffice for a Quix transaction, a Quix pop-up will appear showing the amount of the order and the items in the order. To refund, you must select the items and click on ‘Return products‘ or ‘Devolver productos‘.
Upon completion of a secondary transaction via the BackOffice panel, AP will send a notification to your platform with the type of transaction and its amount to the notification URL indicated in “statusURL” in the original transaction request. You can enable your e-commerce platform to handle these notifications and update the status of transactions.

2. By sending a request to an endpoint. These are the connection URLs established for this purpose:

Environment	URL
Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/rebate
Production	https://checkout.addonpayments.com/EPGCheckout/rest/online/rebate

Addon Payments allows refunds of the amount of a transaction. For a refund to be possible, the transaction must meet the following conditions:

The date of the original transaction must be less than one (1) year old.
The sum of the amounts of all returns made on the original transaction may not exceed the amount of the original transaction.
It must be in authorized and settled status (SUCCESS).
It is not possible to make refunds on transactions:
- Not captured (PENDING).
- Voided (VOIDED).
- Declined (FAIL).
- Wrong (ERROR).

Refunds can’t be reversed, so you have to be sure both the transaction and the amount to refund are correct.

Request

Remember that requests sent to Addon Payments must be encrypted. Visit our Encryption, signature and sending the request for more information.

Your e-commerce platform sends the generated refund request to the URL set up for refunds (string and cURL).

				
					amount=600&operationType=debit&paymentSolution=quix&transactionId=289868

				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/rebate' \
--header 'apiVersion: 5' \
--header 'encryptionMode: CBC' \
--header 'iv: Z7VA6TpG9B84X9x9qqXoWQ==' \
--form 'merchantId="12345"' \
--form 'encrypted="4xUYxJxLc/ABCyqJfwttTalkds3YeijsJe6MlTnC6mgmbm0aXKwhI7thwa70o6lLyjrUtW8fFNUWf/l3jIojR4H5nW54Pl+GxerG1/AjMFpHlacchB3+kfkZzko42dQKk7MopAALi6SAFbl1Uq//qsESz8fV07ED7IvRQwlXREZDFtxQn2m9eyPr5zrJczILhRx27p3lqFQ61Sqlq0nCN+3sgJmuPUMKRqlXhYqf+vErv+fBaZMPV/8iKgERJLpIjPn+HZSLpc+q5VBcD4b+rGAgEKNi56Ni/MPCpKVWBUv8HFb06PngrLfiXcnFTfNeegg0XPkkmuGwR1l1y/k1tv9dPrdBkSIwE2OuHYvrkrn+NAOTHBxjGR4Ap93aZEwcPX9afkHkFOMi/5e3JdoxtFvSwOCe1ScEw2vRDhonE+5lV7jwOrqSMr+tfWVGPqzrYj/DZiQwCIUQJM6g5x+ocLTAURzz4IiJ26kBlQpYVnedKEVhevNJNZ88z6m50W2THtDR70pQq6qjF37NCfOeq/UDCg0RB/MPfYUJRUIsfPk=' \
--form 'integrityCheck="1c256f5b834e5db6d5f453043a8a3830859b308f297cc2cf423064510c5c9b72"'

Parameters of the refund request

These are the parameters to send for a refund request in Quix. The type column indicates whether the field is required/mandatory (R) or optional (O).

Field	Format	Type	Description	Example
transactionId	Whole number max 100 digits	R	ID for the original transaction the secondary operation applies to, such as capture, release or refund.	76543210
paymentSolution	Alphanumeric max 45 characters	R	Name of the payment solution that processed the original transaction. Given in the response for the original transaction.	quix
merchantTransactionId	Max 45 characters Page of Latin-1 codes (ISO-8859-1)	R	This is the transaction ID on your ecommerce platform. Allows your platform to link notifications received to the customer’s order. Each transaction must have a unique ID.	order_91684
amount	Numerical with decimals 0~1000000.00	R	Amount of the transaction. If the amount has decimals, the separator is a dot (.). The separator cannot be included in the thousands.	600
operationType	Alphanumeric max 45 characters	O	Specifies type of operation to carry out. Values accepted: – debit (default): Payment transaction. Meaning, the funds go from the customer’s account to the merchant – credit: Payment into customer’s account. Meaning the funds go from the merchant to the customer’s account. For example, prize money. Don’t confuse with refunds. These have their own type of transaction	debit
description	Max 1000 characters Page of Latin-1 codes (ISO-8859-1)	O	Description of the transaction. Saved in the transaction details and returned in the notification. Doesn’t affect the transaction. Helps you identify it more easily.	Capture after delivering product

Response

Visit our section on Managing notifications to learn more about its structure.

This is an example of a response to a refund request in Quix:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <operations>
        <operation sorted-order="1">
            <amount>600</amount>
            <currency>EUR</currency>
            <details>
                {
                  "authToken": "R1e0HcNHQ9DVwBOWmwasjHSgnevemRXd"
                }
            </details>
            <merchantTransactionId>202310021130</merchantTransactionId>
            <message>Transaction amount refunded succesfully</message>
            <operationType>REFUND</operationType>
            <optionalTransactionParams/>
            <originalAmount>600.0</originalAmount>
            <originalCurrency>EUR</originalCurrency>
            <originalPayFrexTransactionId>289867</originalPayFrexTransactionId>
            <transactionId>289868</transactionId>
            <paymentSolution>quix</paymentSolution>
            <remainingAmount>0.0</remainingAmount>
            <status>SUCCESS</status>
            <respCode>
                <code>0000</code>
                <message>Successful</message>
                <uuid>650fca40_9512_42a1_b9c8_e4e512187b88</uuid>
            </respCode>
        </operation>
    </operations>
    <status>SUCCESS</status>
</payfrex-response>

Rendering the financing calculator (optional)

Quix gives you the option to load a simulation widget using JavaScript anywhere on your ecommerce platform (on the product page, on the cart summary, etc.). This simulator or financing calculator will show the customer how much they will pay and in how many payments:

Required data

To show the simulation to your customers, you have to create a JSON with the following keys and values:

Value	Description	Size and formats accepted
product	Financing product to use to calculate the financing. Only one value is currently enabled.	instalments
amount	Amount of financing to calculate (product/cart) in cents.	Whole number. For example, 123,45 would be: 12345
currency	ISO-4217 code for the currency. The only currency currently enabled is Euro	Alphabetical. EUR
clientId	Your merchant ID on the Quix platform. You will get it from CPC when you sign up for the service.	Alphanumeric. UUID format
locale	Language to show the customer the widget. It is currently only available in English and Spanish	RCF 1766 Format es-ES en-UK
decimalSeparator	Symbol to separate decimals in the amounts. In Spain the decimal symbol is the comma (,).	, .
thousandSeparator	Symbol to separate thousands in the amounts. In Spain the thousands separator is the point (.)	, .
styleColor	Customize the colour used on the widget to highlight certain elements.	Alphanumeric HTML hexadecimal code #RRGGBB
styleVariant	Type of widget to load.	Alphanumeric – text – select – text_banner – select_banner
styleBranding	Version of the widget to load, which changes the appearance and legal texts shown. The value to send is provided by Quix.	Alphanumeric Default: “lending_hub”

Rendering with JavaScript

To correctly load the simulation banner, your ecommerce platform must carry out the following steps:

Import the AP library for the Quix payment solution available on the following URL:

- https://epgjs-rendercashier.easypaymentgateway.com/js/paysol-js/nemuru/nemuru-widget-module.js
- You can use this code to import the AP library for Quix:

<script src="https://epgjs-rendercashier.easypaymentgateway.com/js/paysol-js/nemuru/nemuru-widget-module.js"></script>

2. Generate a JSON with the parameters indicated in the point above:

				
					{
"product": "instalments",
"amount": 66000,
"currency": "EUR",
"clientId": "2af35701-d4d0-4475-80f8-1e82ab45a1a3",
"locale" : "es-ES",
"decimalSeparator" : ",",
"thousandSeparator" : ".",
"styleColor": "#34aeeb",
"styleVariant" : "select",
"styleBranding" : "lending_hub"
}

3. Call the function NEMURUWIDGET.renderSimulationWidget() in the imported library, with the following parameters:

- The “authToken” authentication token from AP.
  - See how to get this authorization token in the section “Sending authentication requests” of the JavaScript integration guide.
- The JSON generated previously.
- The ID for the <div> HTML element where you want the simulation banner.
- Here is a sample function call:

window['NEMURUWIDGET'].renderSimulationWidget(authToken, jsonData, 'identificador_div', "Quix");

Payment process

This is what the customer will experience with the Quix payment solution on AP:

Loading cashier

If the request sent by your platform didn’t indicate that the cashier should only show the Quix payment solution, when the customer’s web browser loads the AP cashier, the customer will see all the payment solutions you have available for the product on your AP merchant. The customer will have to choose “Quix” as the payment solution from the list to start the financing request:

If the request sent by your platform indicated that the cashier should only show the Quix payment solution, when the customer’s web browser loads the AP cashier, they will only see that payment solution:

Below you have the Quix payment process, with a photo gallery at the end illustrating each point:

When they click “OK”, AP loads the Quix simulation widget, regardless of the type of integration, where the customer can:
- Choose one of the financing periods available (3, 10 or 12 months).
- See their monthly payments, with the dates and amounts to be charged.
- See a breakdown of the total cost of the financing to the customer.
- See the TIN and TAE applied.
If the customer accepts the proposed financing, they click “OK” and move on to the next phase of the application. Here they will have to enter, if not already filled in, the following data:
- Name.
- Surnames (must enter 2 surnames).
- Date of birth
- DNI (with letter).
- Phone number (must be Spanish).
After clicking “OK”, the financing company will send the customer an SMS with a five-digit verification code, which they have to enter on the next screen.
The customer enters the code received by SMS:
- If the customer doesn’t receive the message, they can click “Resend” to try again.
- When the gateway is set up for the staging environment, it won’t send an SMS with the code. Instead, the validation code is the last 5 digits of the phone number entered.
After clicking “OK”, the customer sees:
- The breakdown of the total cost of the financing.
- The TIN and TAE applied.
- A dropdown with the monthly payments, with the dates and amounts to be charged.
The customer has to tick the box “I understand and consent to the privacy policy” to continue the process.
When they click “OK”, they go to a screen where the financing company requests their credit card details. The initial payment and successive instalments will be charged to this card.
- When the integration on your ecommerce platform is set up for the staging environment, this screen will show a card you can use for authorized operations in this environment to test integration on your platform.
  - This card will no longer work once you switch your platform settings to operate in the production environment.
When they click “Pay”, AP charges the first instalment to the card.
If this payment is processed correctly, a window will open reminding the customer of their payment amounts and dates, according to the financing granted.
The successive payments will be charged to the customer’s card for that amount on those dates.

5 y 6

Quix

Introduction

Credentials for integration testing

Environments: Staging and Production

Hosted Integration

Request

Request parameters via Hosted

Parameters by service

JSON by service

Response

JavaScript Integration

Getting the authToken

Rendering the Quix cashier with JavaScript

Charge

Parameters by service

JSON by service

First response

Second response

Refunds with Quix

Request

Parameters of the refund request

Response

Rendering the financing calculator (optional)

Required data

Rendering with JavaScript

Payment process

Products

Sales

Technical Support

Partners

SmartWiki, Powered by AI

Quix

Introduction

Credentials for integration testing

Environments: Staging and Production

Hosted Integration

Request

Request parameters via Hosted

Parameters by service

JSON by service

Response

JavaScript Integration

Getting the authToken

Rendering the Quix cashier with JavaScript

Charge

Parameters by service

JSON by service

First response

Second response

Refunds with Quix

Request

Parameters of the refund request

Response

Rendering the financing calculator (optional)

Required data

Rendering with JavaScript

Payment process

Products

Sales

Technical Support

Partners

SmartWiki, Powered by AI

Consulta la documentación de las distintas secciones de integraciones:

Addon Payments

Cyberpac

POS integrated Payments

Addon Payments

Consult the documentation of the different integrations sections:​

Consult the documentation of the different integrations sections: