Jump to Content

Home Guides API reference Changelog

Guides

Home Guides API reference Changelog

Welcome

Getting Started
Key Concepts
Error Response Structure
Postman Collection
Currency and Country Codes
Glossary of Nium Terms
Deprecated APIs
Nium Status Page
Testing Nium

Client Configuration

Parent-child hierarchy

Individual customer onboarding

Overview
Unified Add Customer API
RFI process for individual customers
Customer Lifecycle
FAQ — Individual customer onboarding
AU onboarding
EU onboarding
SG onboarding
UK onboarding
US onboarding
CA onboarding

Corporate customer onboarding

Overview
Onboarding Forms
Using the sandbox
Onboarding error codes
Fetch Corporate Constants API
Letter of Authorization (LOA)
RFI process for corporate customers
- RFI templates
- RFI examples
AU onboarding
CA onboarding
EU onboarding
HK onboarding
JP onboarding
NZ onboarding
SG onboarding
UK onboarding
US onboarding

Wallets

Overview
Wallet-to-Wallet Transfers

Payins

Fund Wallet
Program, client, and client prefund account
Virtual Account Number
Direct Debit

Payouts

Overview
Transfer Money
Nium Verify
Get a card widget

Cards

Cards overview
Cards life cycle
Card management
Card security
- PGP Prerequisites
Card Widget
Card transactions
Dynamic Authorization
Digital Wallet Tokenization
- Apple Pay Push Provisioning
- Google Pay Push Provisioning
3DS Overview

FX

Overview
FX conversion settled immediately using market rate
FX conversion settled immediately using locked rate
FX conversion scheduled for later settlement
Scheduled FX conversion cancelled before settlement

Transactions

Transaction types
Transaction status and settlement status
Transaction response labels
Prohibited Countries
Transaction RFIs
- Transaction RFI Types
- Transaction RFI Examples

Nium Portal

Overview
Roles and Permissions
Batch Payouts
Reports

Reports

Reports
Client Reports
Daily Reports
Customer account statement

Use Cases

Spend Management
Payroll
Financial Institutions

Open Banking

Nium client integration
- Account Details by Customer Consent ID
- Payment Details by System Reference Number
Third-Party Service Provider integration

FAQs

Implementation / Wallet / Card
Platform
Production / High-Availability
Privacy / Encryption
Support
Regex and Accepted Values

Fees and limits

Fees
Limits

Client Reports

The following reports are available at the client level:

Client Negative Wallet Balance
Client Transactions
Client Settlement Report V1
Client Settlement Report V2

Updated 11 months ago