API Reference

Getting Started

To get started, you must contact our Client Delivery team. We will set up your Nium company account and one or more funding accounts. You can manage your company and funding accounts through the Nium Business portal.

Before you start, remember you will need assistance from a knowledgeable resource to integrate the Nium methods into your existing payment processing system.

To see how to complete these and more tasks in the Nium portal, see the Nium User Guide:

  • Log in to your company account
  • Create, view and add money to funding accounts
  • Create, view and load virtual cards
  • Create and manage other user accounts
  • Track funding account balances and do reconciliations

Nium has a rich set of APIs that allow you to create virtual cards, load them with money, monitor virtual card transactions and receive notifications of card activity.

API Client

Most APIs reside on the Nium system, where your application code can call methods to perform essential Nium tasks. To take advantage of these Nium APIs, you must set up an API client on your local system.

API Server

Nium also uses notification APIs to send alert messages to your system. For these APIs to work correctly, you must set up an API server within your system to listen to the notifications.
These notifications are entirely optional. If you choose not to install an API server at your location, all the other Nium features will continue functioning correctly.

Running the APIs

When ready to run the APIs, you must use an HTTPS request to contact the Nium system.
Nium offers a live server as well as a test server. The only difference between our test and live servers is that no actual transactions are performed on our test server. Nium’s Client Delivery team will give you URLs for these two servers near your deployment date.
It would be best if you modified your API calls so they use the correct API key for the target server. Our Client Delivery team will give you the key after they create your Nium company account.
If you have questions, please contact our Client Delivery Team.

API Categories

Nium Travel supports the Prepaid model through Payment Partner APIs.