Jump to Content
NIUM Platform
HomeGuidesAPI referenceChangelog
Log InNIUM Platform
Log In
HomeGuidesAPI referenceChangelog

Welcome

  • Getting started
  • Key concepts
  • Error response structure
  • Currency and country codes
  • Glossary of Nium terms
  • Deprecated APIs

Client Configuration

  • Parent-child hierarchy

Individual customer onboarding

  • Overview
  • Unified Add Customer API
  • RFI process for individual customers
  • Customer life cycle
  • FAQ — Individual customer onboarding
  • 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

Corporate customer onboarding

  • Overview
  • Using the sandbox
  • Onboarding error codes
  • Fetch Corporate Constants API
  • RFI process for corporate customers
    • RFI templates
    • RFI examples
  • AU onboarding
    • AU required parameters
    • AU required documents
    • AU position mapping
    • AU 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
  • 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
  • Direct Debit
    • Direct Debit AU
    • Direct Debit EU
    • Direct Debit UK
    • Direct Debit US

Payouts

  • Transfer Money
    • Remittance lifecycle
    • Purpose Of Transfer codes
    • Routing codes
    • Account Verification
    • GPI Tracking for Wires
  • Get a card widget

Cards

  • Card overview
  • Card life cycle
  • Card management
  • Card security
  • 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

Reports

  • Reports
  • Client Reports
    • Client Negative Wallet Balance
    • Client settlement
    • Client transactions
  • 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

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

Fees and limits

  • Fees
  • Limits

Client Reports

We have the following reports on Clients:

  • Client Negative Wallet Balance
  • Client Settlement
  • Client Transaction

Updated 4 months ago

Platform Network Insights About Us Contact Us
© 2023 Nium Pte. Ltd.
Terms of Use | Privacy Notice