Jump to Content
Home
Guides
API reference
Changelog
Log In
Guides
Log In
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
AU required parameters
AU required documents
AU request examples
EU onboarding
EU required parameters
EU required documents
EU request examples
SG onboarding
SG required parameters
SG required documents
SG Request Examples
SG PSA compliance for wallet-based programs
UK onboarding
UK required parameters
UK required documents
UK request examples
US onboarding
US required parameters
US required documents
US request examples
CA onboarding
CA required parameters
CA required documents
CA request examples
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
AU required parameters
AU required documents
AU position mapping
AU request examples
CA onboarding
CA required parameters
CA required documents
CA position mapping
CA request examples
EU onboarding
EU required parameters
EU required documents
EU position mapping
EU request examples
HK onboarding
HK required parameters
HK required documents
HK position mapping
HK request examples
JP onboarding
JP required parameters
JP required documents
JP position mapping
JP request examples
NZ onboarding
NZ Required Parameters
NZ Required Documents
NZ Required Mapping
NZ Request Examples
SG onboarding
SG required parameters
SG required documents
SG position mapping
SG request examples
UK onboarding
UK required parameters
UK required documents
UK position mapping
UK request examples
US onboarding
US required parameters
US required documents
US position mapping
US request examples
Wallets
Overview
Wallet-to-Wallet Transfers
Payins
Fund Wallet
Program, client, and client prefund account
Virtual Account Number
Direct Debit
Direct Debit AU
Direct Debit EU
Direct Debit UK
Direct Debit US
Direct Debit SG
Payouts
Overview
Transfer Money
Remittance lifecycle
Purpose Of Transfer codes
Routing codes
GPI tracking for wires
Paper Checks
Nium Verify
Get a card widget
Cards
Cards overview
Cards life cycle
Card management
Card security
PGP Prerequisites
Card Widget
Card transactions
Dynamic Authorization
Hosted Model
Prerequisites
Extended Model
Delegated Model
Digital Wallet Tokenization
Apple Pay Push Provisioning
Google Pay Push Provisioning
3DS Overview
OTP-based 3DS authentication flow
OTP + Knowledge-based authentication flow
OOB authentication flow
Check Authentication Method V2
OOB Authentication Callback
Initiate OOB Authentication V2
Passcode Validation V2
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
Payouts
Reports
Reports
Reports
Client Reports
Client Negative Wallet Balance
Client transactions
Client Settlement Report V1
Client Settlement Report V2
Daily Reports
Daily Client Account Fees
Daily Client Assigned Cards
Daily Client Card Activity Summary
Daily Client Card Issuance
Daily Client Card Transaction Authorization
Daily Client Customer Onboarding
Daily Client Ledger Summary
Daily Client Transaction Summary
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
Suggest
