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

Welcome

  • Getting Started
  • Key Concepts
  • Error Response Structure
  • Currency and Country Codes

Individual Customer Onboarding

  • Quickstart (Individual)
  • Flow Diagrams
  • Unified Add Customer API Example
  • Block/Unblock Customer

Corporate Customer Onboarding

  • Quickstart (Corporate)
  • Enum Values
  • EU
    • EU Position Mapping
    • EU Stakeholder-Applicants Required Documents
  • US
    • US Position Mapping
    • US Required Documents
    • US Public Companies Required Fields
    • US Trust Required Fields
    • Other US Entities Required Fields
  • Open Banking (Onboarding)
    • Account Details by Customer Consent ID
    • Payment Details by System Reference Number

Wallets

  • Wallet, Multi-Currency, Virtual Account Numbers

Payins

  • Client, Program, Client Prefund Accounts

Payouts

  • Send Money (Transfer)
    • Purpose Of Transfer codes

Cards

  • Overview of Cards
  • Card Transactions
  • Collaborative Card Authorization Model
    • Prerequisites
    • Authorization
    • Settlement
  • Get a card widget user guide
  • Offline PIN for EU/UK
  • 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

  • Overview and Types
  • Glossary of Labels

Digital Wallet Tokenization

  • Overview of Digital Wallet
  • Apple Pay Push Provisioning
  • Google Pay Push Provisioning

Reports

  • Client Reports
    • Client Negative Wallet Balance
    • Client Settlement
    • Client Transaction
  • 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

Use Cases

  • Payroll

Webhooks

  • Overview of Webhooks
    • Card 3DS OTP
  • Event Types
    • Card Activation Card
    • Card Add Card
    • Card Add On Card
    • Card Assign Card
    • Card ATM Approved
    • Card Balance Transfer Within Wallet
    • Card Block Card Decline
    • Card Cashback Credit
    • Card Client KYB Status
    • Card Client Setup
    • Card Customer Registration
    • Card Customer Update
    • Card Expired Card
    • Card Inactive Card Decline
    • Card Insufficient Funds Declined Client
    • Card Insufficient Funds Declined
    • Card Miscellaneous
    • Card P2P Transfer Between Wallets
    • Card Permanent Block
    • Card Pin Block Decline
    • Card Pin Retry Exceed Decline
    • Card POS Approved
    • Card Prefund Approval
    • Card Restricted Transactions
    • Card Set Pin
    • Card Settlement Credit
    • Card Settlement Debit
    • Card Settlement Direct Debit
    • Card Settlement Reversal
    • Card System Down
    • Card Temporary Block Removal
    • Card Temporary Block
    • Card Transaction Limit Exceeds
    • Card Transaction Not Supported
    • Card Transaction Reversal
    • Card VTS Provisioning
    • Card VTS Token
    • Card Wallet Encashment
    • Card Wallet Funding
    • Card Wrong CVV2
    • Card Wrong Expiry
    • Card Wrong PIN Decline
    • Remit Transaction Cancelled
    • Remit Transaction Expired
    • Remit Transaction Initiated
    • Remit Transaction Paid
    • Remit Transaction Rejected
    • Remit Transaction Returned
    • Virtual Account Assignment Failure
    • Virtual Account Assigned

Fees

  • Fees

Open Banking

  • PSD2 Open Banking API

FAQs

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

Client Reports

We have the following reports on Clients:

  • Client Negative Wallet Balance
  • Client Settlement
  • Client Transaction

Updated 6 days ago


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