Jump to Content
NIUM Platform
HomeGuidesAPI ReferenceChangelog
Get API KeysNIUM Platform
Get API Keys
HomeGuidesAPI ReferenceChangelog

Welcome

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

Individual customer onboarding

  • Overview
  • Customer flow diagrams
  • Unified Add Customer API example
  • Block/Unblock customer

Corporate customer onboarding

  • Overview
  • Using the sandbox
  • Onboarding error codes
  • Fetch Corporate Constants API
  • RFI templates
  • AU
    • AU required fields
    • AU required documents
    • AU position mapping
    • AU request examples
  • EU
    • EU required fields
    • EU required documents
    • EU position mapping
    • EU request examples
  • HK
    • HK required fields
    • HK required documents
    • HK position mapping
    • HK request examples
  • SG
    • SG required fields
    • SG required documents
    • SG position mapping
    • SG request examples
  • UK
    • UK required fields
    • UK required documents
    • UK position mapping
    • UK request examples
  • US
    • US required fields
    • US required documents
    • US position mapping
    • US request examples

Wallets

  • Wallet, currency, and VAN

Payins

  • Fund Wallet
  • Program, client, and client prefund account
  • Direct Debit
    • Direct Debit US
    • Direct Debit EU
    • Direct Debit UK

Payouts

  • Transfer Money
    • Purpose Of Transfer codes
    • Routing codes
  • Get a card widget

Cards

  • Cards overview
  • Cards 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 Factor Authentication Flow
    • OOB Authentication Flow
  • 2FA
    • Check Authentication Method
    • Initiate OOB Authentication
    • OOB Authentication Callback
    • Passcode Validation

Transactions

  • Transaction types
  • Glossary of Labels

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

  • Payroll
  • Spend and Payroll Management

Notifications and Webhooks

  • Notifications
  • Callbacks
    • Callback to receive transaction compliance status
    • Callback to receive customer compliance status
    • Callback to redirect a customer to their application
  • Webhooks overview
  • Platform events
    • Client Setup
    • Client KYB Status
    • Client Refund Approval
    • Customer Registration
    • Customer Update
    • Wallet Encashment
    • Balance Transfer Within Wallet
    • Cashback Credit
    • P2P Transfer Between Wallets
    • Prefund Approval
    • Virtual Account Assigned
    • Virtual Account Assignment Failure
  • Payout events
    • Remit Transaction Initiated
    • Remit Transaction Expired
    • Remit Transaction Rejected
    • Remit Transaction Returned
    • Remit Transaction Paid
    • Remit Transaction Sent to Bank
  • Payin events
    • Direct Debit Transaction Returned
    • Direct Debit Transaction Chargeback
    • Wallet Funding
  • Issuing and Cards events
    • Add Card
    • Assign Card
    • Add On Card
    • Activate Card
    • 3DS OTP
    • VTS Token
    • VTS Provisioning
    • Set Pin
    • Permanent Block
    • Temporary Block
    • Temporary Block Removal
    • POS Approved
    • ATM Approved
    • Transaction Reversal
    • Wrong PIN Decline
    • Inactive Decline
    • Block Decline
    • Card System Down
    • Expired Card
    • Miscellaneous
    • Pin Block Decline
    • Pin Retry Exceed Decline
    • Insufficient Funds Declined
    • Insufficient Funds Declined Client
    • Wrong CVV2
    • Transaction Limit Exceeds
    • Restricted Transactions
    • Wrong Expiry
    • Transaction Not Supported
    • Settlement Debit
    • Settlement Credit
    • Settlement Direct Debit
    • Settlement Reversal

Fees and limits

  • Fees
  • Limits

Open Banking

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

FAQs

  • Platform
  • Production / High-Availability
  • Support
  • Privacy / Encryption
  • Implementation / Wallet / Card

2FA

Two Factor Authentication

The following APIs are associated with 2-factor authentication:

  • Passcode Validation
  • Check Authentication Method
  • Initiate OOB Authentication
  • OOB Authentication Callback

Updated 14 days ago


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