Core Concepts
This page describes the core concepts and entities that are available in the Lumanu Payments API
Workspaces
A workspace represents a dedicated payment environment for a Buyer within your platform. The "Buyer" can be either:
- Your end client (when your platform is not in the money flow)
- Your platform's business (when your platform is in the money flow)
Each workspace:
- Has a dedicated Lumanu Wallet with its own account & routing number
- Maintains separate funds, vendor lists, and payment workflows
- Has its own set of financial controls, approval workflows, and security settings
- Supports multiple projects and user roles
- Prevents commingling of funds between different buyers
| Method | Endpoint | Description |
|---|---|---|
| GET | /workspace | List Workspaces |
| GET | /workspace/{id} | Get Workspace |
| PATCH | /workspace/{id} | Update Workspace |
| GET | /workspace/search | Search for vendor workspaces |
| GET | /workspace/{id}/custom-field-policy | Get Custom Field Policies |
| POST | /workspace/{id}/webhook-subscription | Subscribe to Workspace Webhooks |
Partners/Vendors
Vendors are the payees (typically creators/influencers) who receive payments through the Lumanu network. Key aspects:
- Vendors can be invited via email or by creating a payout.
- Each vendor undergoes automated compliance checks including:
- Personal ID verification
- Phone verification
- Business information and TIN checks
- OFAC and watchlist screening
- Bank account validation
- Special verification flows exist for talent management entities
- Once a vendor is onboarded to Lumanu, they will have a unique Lumanu ID that you can use to identify them in the future
| Method | Endpoint | Description |
|---|---|---|
| GET | /workspace/{id}/partner | List Workspace Partners |
| GET | /workspace/{id}/partner/{partnerId} | Get Partner Details |
| GET | /workspace/{id}/partner/invite | List Partner Invites |
| POST | /workspace/{id}/partner/invite | Invite Partners to Workspace |
| GET | /workspace/{id}/partner/invite/{inviteId} | Get Partner Invite Details |
Payables
Payables represent individual payment obligations to vendors. They progress through the following statuses:
draft- Initial state when createdapproved- After approval, ready for fundingwill_pay- Funded and scheduled for payment; this is the terminal status for successful payablescanceled- Payment canceled
| Method | Endpoint | Description |
|---|---|---|
| GET | /payable | Get Payables |
| POST | /payable | Create Payable |
| GET | /payable/{id} | Get Single Payable |
| GET | /payable/{id}/invoice-pdf | Get an invoice PDF for a payable |
| POST | /payable/{id}/approve | Approve Payable |
| POST | /payable/{id}/unapprove | Un-approve Payable |
| POST | /payable/{id}/cancel | Cancel Payable |
Account/Wallet
Each workspace has an account associated with it called a wallet account. This is the account that can be used to send funds (in the case of a buyer) or receive funds (in the case of a vendor). The wallet has a balance that can be queried, and tracks debit and credit transactions.
| Method | Endpoint | Description |
|---|---|---|
| GET | /workspace/{id}/wallet | Get Workspace Wallet |
| GET | /workspace/{id}/wallet/transaction | List Wallet Transactions |
| GET | /workspace/{id}/wallet/deposit | List Unlinked Deposits |
| POST | /workspace/{id}/wallet/deposit | Create Test Deposit (Sandbox Only) |
Funding
Funding is the process of adding money to your Workspace balance to settle Payables. The API supports two funding methods: balance funding (using existing wallet balance) and invoice funding (creating an invoice for payment via bank transfer).
| Method | Endpoint | Description |
|---|---|---|
| GET | /funding | Get Fundings |
| POST | /funding | Create Funding |
| GET | /funding/{id} | Get Single Funding |
| POST | /funding/{id}/link-deposit | Link Funding Payment |
| POST | /funding/{id}/cancel | Cancel Funding |
| GET | /funding/{id}/pdf-url | Get Funding Invoice PDF URL |
For security compliance, two-factor authentication must be enabled before processing payments.
Projects
Projects are containers within workspaces that help organize payments, manage budgets, and track spend at a more granular level.
Advanced project features designed for enterprises are available with an enterprise contract with Lumanu. This includes Project Wallets, which enable strict segregation of funds between projects (e.g., for different POs or departments) to support enterprise financial control requirements.
NoteNote: Project actions are currently not available via the Lumanu Partner API. To learn more reach out directly to Lumanu.
User
Endpoints for retrieving information about the currently authenticated user.
| Method | Endpoint | Description |
|---|---|---|
| GET | /user/current | Get Current User |
| GET | /user/current/workspaces | Get Current User's Workspaces |
Updated about 1 month ago