Chapter 2 – Integration Guide

Section 2.1 - Implementation Notes link

Nuvei created the Cloud Connect Web Service with developers in mind. Knowing that integrated systems are built across all environments, Nuvei has considered the variables in order to make this an easy to use API. With that in mind, throughout the guide “Developer Notes” are available to provide coding logic. To start off, please read these basic Implementation Notes to provide fundamentals for getting started.

Nuvei has also provided a site with test forms which will create Requests to your payment device and return the Response for each of the methods.

Test forms are located at:

WSDL definitions for testing are located at:

Once integration is complete, Nuvei will provide Production service locations.

Section 2.1.1 - SOAP Implementation link

The SOAP interface is easily accessed through a .NET application. If developing in .NET, simply add the URL of the WSDL you are attempting to consume as a service reference. Once added to the service reference, Visual Studio will handle the bulk of the heavy lifting and will create a class for the web service which will build the SOAP object and return a response in the form of an object.

The endpoint URL included in the WSDL file generated by the web reference is secure. To ensure you have no issues, be sure to change ‘http://’ to ‘https://’ in whatever IDE you are working in and there should be no trouble communicating with the web service.

If developing in a language other than VB.NET or C#, it is recommended to integrate using HTTPS using the Name Value Pair implementation as it is far less complicated than building SOAP objects outside of an IDE. If familiar and comfortable using SOAP to consume .NET web services, navigate to the URL of the web service method to gather additional details regarding the XML SOAP schema.

Section 2.1.2 - Name-Value Pair Query String Implementation link

The Name-Value Pair query string data implementation relies on the .NET frameworks built in HTTPS to SOAP translation layer. As a result, there are a few idiosyncrasies that an integrator must be aware of when implementing using HTTPS.

  1. The .NET framework of the web service is taking the HTTPS request and building a SOAP object using the fields that it receives.

  2. As a result, regardless of whether a field’s VALUE is required, the field NAME must be sent along with the request. Although this may seem counter intuitive, the .NET web service will simply build the SOAP object using only the fields that are passed to it.

  3. If a field Name is not included in the request, the SOAP object will be built without that parameter, thus resulting in an improperly formed SOAP object that will be rejected by the web service.

  4. To avoid this, each field Name must be sent even if you are not passing an empty Value to the service.  The field must be sent EVEN if the API indicates that the field is not required. Send the field with a NULL value. E.g.; “TipAmt=”

  5. Remember, the request MUST include all field names, but when deciding whether to send a value in a specific field you can rely on the API to indicate whether a specific field requires a value in order to return a valid result.

  6. When calling a service using HTTPS, use the URL associated with each web service in the API under the heading “Service Location.” Please make sure that when implementing using Name-Value Pair query string over HTTPS that the request is sent to the URL labeled “For standard HTTPS connections.”

Section 2.1.3 - JSON Implemention link

  1. Both GET and POST methods are supported with JSON format over an HTTPS connection to the Nuvei webservice.

  2. To support JSON, set the Content-Type to ‘application/json; charset=utf-8’ in Request Headers.

  3. As with the Name-Value Pair string data implementation, JSON format requires all Fields be present in the construct of the Request even if the Value is optional.

Need Help?

How can we help you today?  Our team is standing by and just a click away.