NorthPole Usage Guide

How Businesses and Individuals Use NorthPole

NorthPole supports both individual users and business customers with a unified platform for payments, wallets, virtual accounts, currency conversion, and secure API integration.

Need API details?

Visit the dedicated business API documentation page for endpoint examples, authentication rules, and integration guidance.

Explore API docs

Individual Users

Individuals use NorthPole for personal money movement, wallet management, virtual account access, and fast transfers. The app delivers a simple self-service experience for everyday financial needs.

Primary actions:
  • Create a personal account and sign in from the web portal.
  • View wallet balances and transaction history.
  • Request and fund virtual accounts for incoming transfers.
  • Initiate withdrawals to a bank account.
  • Preview foreign exchange rates and perform currency conversions.
Authentication:

Individuals authenticate through the standard login flow and maintain session tokens transparently while using the app.

Business Users

Businesses get a richer experience with advanced payment orchestration, managed wallets, virtual account issuance, internal transfers, foreign exchange, and API-first integration.

What businesses can do

  • Register as a business customer and complete onboarding.
  • Maintain separate wallets for collections, payouts, and FX.
  • Issue virtual accounts to receive payments from multiple channels.
  • Move funds internally with secure transfer endpoints.
  • Convert currencies with live rate quotes and settled conversions.
  • Monitor transaction flows through webhooks and audit-ready logs.

Why API-first matters

Businesses can automate payments, reconcile faster, and integrate NorthPole into existing platforms using REST endpoints and token-based authentication.

This makes it easy to connect back-office workflows, e-commerce checkouts, ERP systems, and treasury operations.

Authentication and onboarding

Both individuals and businesses start with registration and authentication. Business accounts include richer profile data and business-specific onboarding information.

Common auth endpoints:
  • /users/register - create individual or business accounts.
  • /auth/login - obtain access tokens and begin a session.
  • /auth/refresh - refresh access tokens using secure cookies.
  • /auth/logout - end the authenticated session.
  • /auth/me - fetch the current authenticated user.
Business registration fields include:

user_type=business, company metadata, contact details, and optional address fields.

Business API reference

Use these key endpoints to build business workflows and integrate NorthPole into your platform.

Wallet and account management

  • GET /wallets - list business and individual wallets.
  • GET /wallets/:walletId - retrieve wallet details.
  • POST /wallets - create a new wallet.
  • GET /wallets/:walletId/virtual-account - get virtual account details.
  • POST /wallets/:walletId/virtual-account - issue a new virtual account.

Transfers, FX, and transactions

  • POST /transfers/internal - move funds between wallets.
  • GET /transactions - search and paginate transaction history.
  • POST /fx-rate/quote - request a foreign exchange quote.
  • POST /fx-rate/convert - execute an FX conversion.
  • POST /wallets/:walletId/withdraw - withdraw funds to a bank account.

Business integration best practices

For business integrations, keep these rules in mind: authenticate every request, use secure bearer tokens, and keep webhooks monitored for payment and conversion events.

  • Use a dedicated business wallet for collections and a separate payout wallet for withdrawals.
  • Fetch transaction history regularly and reconcile against your own ledgers.
  • Use FX preview quotes before conversion to lock in rates and avoid surprises.
  • Issue virtual accounts for customer-specific payments and track inbound payments by wallet.
  • Keep your API base URL configured via NEXT_PUBLIC_API_URL for local and production environments.

Getting started quickly

For individuals

  1. Register and choose individual as the user type.
  2. Log in and create your first wallet.
  3. Use the wallet dashboard to track balances and withdrawals.
  4. Request a virtual account to receive funds directly.

For businesses

  1. Register as a business and complete identity details.
  2. Create wallets for operating funds, collections, FX, and payouts.
  3. Issue virtual accounts for payments and reconcile incoming transfers.
  4. Automate treasury operations with the API reference above.

Note: The API examples above are based on NorthPole frontend service patterns and should be adapted to your backend route configuration and authentication setup.