Concepts
This section outlines the resources you'll interact with as you use the API.
Wallets
A Multi-Currency Wallet is the foundation for managing money in Paisr. Multi-Currency Wallets or MCWs are linked to your profile and act as the parent for other financial tools such as: Virtual Balances, Connected Accounts, Payment Links etc.
Balances
A virtual cash account or commanly referred to as virtual balance is an instrument used to store the monetary value for a specific currency under a Wallet. It behaves like a simplified bank account but doesn’t offer access to IBANs or loans.
Currently we support two type of balances:
- Primary: Used to move money in and out of your Paisr Wallet (e.g. receiving payouts, sending money to someone or paying at a store).
- Saving: Used to set money aside for special occasions.
Acccounts
A connected account is a owned bank account that's linked to your Paisr Wallet. This enables you to withdraw money from your Paisr wallet directly to your local bank account.
Contacts
Contacts are individuals or businesses you know or frequently send money to.
Payment Links
Payment links are short-lived urls that you can share with anyone in your community to receive real-time payments into your Paisr Wallet.
Statements
Statements are monthly reports on the transactions performed by your wallet.
Transactions
Transactions are the historical records of all monetary movements associated with a wallet. Each transaction contains detailed metadata like amount, currency, destination or source, method, and timestamps.
Customers
Customers in Paisr refer to the individuals and businesses you bill through Paisr. Each customer is unique to your business, and shares no relation with the other.
Plans
Plans are the foundation for launching recurring business models with Paisr. Plans serve as reusable templates that can be referenced when creating subscriptions. Plans contain general details about the offering, and delegate the configuration logic to their associated Price Options.
Vouchers
Vouchers allow you to offer personalized discounts to your customers. Vouchers support fixed or percentage-based reduction, can be scoped to specific timeframes and applied to invoices before or during checkout.
Invoices
Invoices are structured billing documents containing line items, taxes, customer details, and due dates.
Subscriptions
Subscriptions manage billing cycles, generate invoices and manage payment retries, and cancellations for recurring services.
Payments
Payments refer to the act of receiving funds through any Paisr-supported method — wallets, cards, QR etc. Each payment generates a record tied to an invoice.
Providers
Payment Providers are third-party integrations (banks, mobile money, etc.) that you can connect to Paisr. They allow you to access local rails and support unified acceptance through a single API layer.
Access Tokens
Access tokens are security credentials that are used to perform actions on our API on behalf of the profile they're associated with.
Webhooks
Webhooks are pre-configured urls that receive real-time notifications about events that happen in your profile.