Welcome to the API Specification. Here you will find all necessary information to help you understand your integration to our Payment gateway.
This section helps you to understand the elements for your solution's integration such as which integration method to use, how to configure your account to perform each integration, how to use the custom fields, how to calculate the hash parameters of requests and responses, etc.
HASH Calculation, Card Types, Custom Fields, Dynamic Descriptors, Multi-currency Terminal ID, Signature Field
Specific response codes and messages which may be returned in different features...
A longer and more detailed explanation of how this important mechanism works...
The Hosted Page (HP) is an integration method where the entry of some sensitive data is handled by the Payment Gateway so the merchant’s servers are not exposed to this data. This is advisable so as to reduce the security overhead of the integrated solution. For this scenario, Nuvei becomes the responsible party for maintaining the security and integrity of the sensitive data sent to these pages.
These Hosted Pages are also highly stylized so that they look more appealing to the customers and improves their overall experience. For more details on that consult Pay Pages.
Cardholders are redirected to a page at the Payment Gateway. Upon the customer clicking the ‘submit’ button on that page, all data are collected, processed and the Payment Gateway sends the processing result back to the Merchant's site, also redirecting the Account Holder to the Merchant's result page, in a transparent way.
The following features are available for this integration method:
Payment and pre-authorization
Checks the transaction
Payment using Apple Pay technology
Payment using Google Pay technology
Secure token registration and update
Subscription and stored subscription registration
Large payment file submission and result request
The XML integration method allows a Merchant's solution to integrate directly with the Payment Gateway, perform specific “feature modeled” calls whereby the Payment Gateway processes a request and sends back a response showing the result of the transaction requested or the errors related to it.
The following features are available for this integration method:
Payment, pre-auth, pre-auth completion, refund, unreferenced refund, transaction status update, and more...
Payment using Apple Pay technology
Payment using Google Pay technology
Management of eInvoices. Create, cancel, retreive links and send them to customers.
Verification of card accounts' validity
Secure token registration, update, delete, consult and search
Stored subscription registration, update and delete
Subscription registration, update, delete and pay
Subscription notification
3D Secure transaction check
Consult terminals' configurations