Overview

Nuvei provides workflows that you can run in Postman to get first-hand experience of how our REST APIs work. Before developing and testing your own workflows using our REST APIs, we recommend running these sample Postman workflows in our test environment to understand their business principles.

We have created the following Postman collections covering a range of workflow scenarios for you to import into Postman and try for yourself.
See the lists of Nuvei Postman Collections and their related topics below.

Getting Started

Get started by following the steps described below:

1. Import the Nuvei Environment
2. Import Workflow Collections
3. Setting Your Credentials
4. Run the Collection Requests

1. Import the Nuvei Environment

Import the Nuvei Postman Environment settings as follows:

1. Open Postman.
2. Press Import.
3. Press Link.
4. Enter the following URL:
   https://docs.nuvei.com/wp-content/uploads/2020/06/SafeCharge-sandbox-environment-1.json
5. Press Import.
   This imports the Nuvei environment variable that you must select in the next step.
6. In the top right corner, make sure you have selected https://ppp-test.safecharge.com in the list of environments:
   
7. Initialize the Nuvei environment functions required by the Nuvei scripts as follows:
   1. In the left pane, press Collections.
   2. In the list of collections, press Init.
   3. Press Init Postman and then press Send.

2. Import Workflow Collections

Import relevant Nuvei Postman collections as follows:

1. Press Import.
2. Press Link.
3. Paste the URL of the relevant …collection.json file.
   (See the lists of Nuvei Postman Collections and their related topics below.)
   • For example, to import a set of general Nuvei workflow collections, use the following URL: Nuvei postman collection.
   • If you have a different URL that installs other collections, then use that URL.
4. Press Import.

3. Setting Your Credentials

Before you begin to work with the Nuvei collections, you must provide your own credentials.

The Collections are provided with a number of environment variables. One example is: merchantId. Variables allow you to store and reuse values in your requests and scripts. By storing a value in a variable, it is referenced throughout the phases of a collection, environment, and requests, without having to change it in more than one place.

1. Press the Environment quick look (eye button) in the top right corner of the Postman window:
   
2. Press Edit in the https://ppp-test.safecharge.com area.

The Manage Environments page opens:

3. Find the variables and provide your own initial values for them:
   • merchantSiteId
   • merchantId
   • merchantKey
4. Press Update to save the settings.

Once your credentials are set, you can run the requests in the Postman collections.

4. Run the Collection Requests

1. Open Postman.
2. Select a “Postman Collection”, and run the requests in the sequence that they appear in the collection.
   
   Variables in the Nuvei Collections
   Nuvei workflows use variables to store and pass values between requests in the workflow. For example, they are included in the Pre-request Scripts for Request (see the Pre-req tab), as well as in the Test Scripts (see the Tests tab). Variable placeholders are marked in requests with double curly brackets: “{{<variable_name>}}”:

   Example of Variables used in Postman Requests

   
   You can view the previous and current values of any variable by pressing the Environment quick look button (eye icon) at the top right corner of the Postman window.

   All Nuvei REST API methods that transfer data from client to server use the POST HTTP method.

Appendices

Nuvei Postman Collections

This topic lists the Nuvei “Postman Collections Import Files” that you can import into Postman to simulate Nuvei financial workflows using REST API calls.
A “Postman Collections Import File” contains one or more “Postman Collections”, which contains one or more REST API calls.

For each “Postman Collections Import File”, the topics below list the “Postman Collections” contained in that file, and provides a link to the Nuvei Developer Portal topic that references that “Postman Collection”.

Postman Collections Import Files Provided by Nuvei

1. “All Nuvei Collections”
2. “Server-to-Server with Web SDK”
3. “Web-SDK-API-calls”
4. “P2P REST API collection file”

A. The “All Nuvei Collections” Postman Collection File

Name of the Postman Collections Import File:
All-Nuvei-Collections.postman_collection.json

This file contains the following Postman collections, which demonstrate workflows for the following referencing topics:

Collections contained in the “All Nuvei Collections” File, and their Referencing Topics

Postman Collection	Referencing Topic
3D-Secure Challenge	Server-to-Server
	3DS MPI-Only REST
3D-Secure Frictionless	Server-to-Server
	3DS MPI-Only REST
External MPI	3DS External MPI
MPI Only (using /authorize3d and /verify3d)	3DS MPI-Only REST
Recurring (with 3D-Secure)	Merchant Initiation Transaction (MIT) / Recurring
	Recurring Payments via REST
Simple Auth-Settle scenario with Void	Void
Simple Sale Payment and Partial Refund	Refund
Payout	Using cardData to Card

B. The “Server-to-Server with Web SDK” Postman Collection File

Name of the Postman Collections Import File:
Server-to-Server-with-Web-SDK.postman_collection.json

This file contains one Postman collection.

The requests in this collection demonstrate the Web SDK workflow, where you call the /openOrder before the /payment (WITH liability shift and WITHOUT liability shift).

This postman collection relates to the following topics:

• 3DS MPI-Only Web SDK > Initiating a Session topic.
• Dynamic Apple Pay Button > Initiate a Session topic.
• Android Mobile SDK (Beta Release) > Initiate a Session topic.
• iOS Mobile SDK (Beta Release) > Initiate a Session topic.

C. The “Web-SDK-API-Calls” Postman Collection File

Name of the Postman Collections Import File:   
Web-SDK-API-calls.postman_collection.json

This file contains one Postman collection.

The requests in this collection demonstrate the Web SDK workflow, where you call the /openOrder before the createPayment() request, and the /getPaymentStatus after createPayment().

This postman collection relates to the following topics:

• Web SDK Scenarios topic.
• Simply Connect > Quick Start > Initiate a Session topic.
• Simply Connect Examples topic.

D. P2P REST API Postman Collection File

Name of the Postman Collections Import File:
REST 1.0 P2P Collection.postman_collection.json

This file contains one Postman collection.

This collection contains REST workflows associated with various person-to-person (P2P) scenarios. It relates to the topic P2P payments.

Documentation

Documentation has been provided for collections as well as for some individual requests. The easiest way to view the documentation is to view a collection in a web browser.

1. Select a Collection.
2. Press the arrow that appears to the right of the collection name, then press View in web:

The collection opens in a three-pane format that enables easy navigation and testing: