Nium Walkthrough
  • 1 Minute to read
  • Dark
  • PDF

Nium Walkthrough

  • Dark
  • PDF

Article Summary

Nium API version 2 is currently supported

This provides a general description of Nium and its capabilities.


Nium combines the world's payment infrastructure in a single API integration. Embed global payment services for Pay Out, Pay In, and Card Issuance with NIUM.

Screenshot 2022-01-09 120305.png


To begin, a Nium API key has to be obtained.
This is how to obtain your API key.
Ensure that the Nium team provides you with a base URL and clientHashId during setup.


In Nium, there are two types of reports available:

Predefined Reports

Click here to view Predefined Reports.

Custom Reports

Create custom reports, and select a specific report to pull from the Nium API after you've established a connection.
The following image provides an overview of the various custom reports:

Screenshot 2022-01-09 115950.png

After selecting a Report type, press on Click To Select and wait for the necessary data to be fetched, in a drop-down box. Choose all of the IDs for which you require data from:
Screenshot 2022-01-09 121504.png
Leaving this field blank has the same effect as selecting everything.

API limitations

As part of our Sandbox API usage policy, we've imposed the following restrictions:

  • There is a limit of 50 requests per second.
  • There is a limit of 50 burst requests per second.
  • There is a daily limit of 25000 requests.

Was this article helpful?