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
MethodEndpointDescription
GET/workspaceList Workspaces
GET/workspace/{id}Get Workspace
PATCH/workspace/{id}Update Workspace
GET/workspace/searchSearch for vendor workspaces
GET/workspace/{id}/custom-field-policyGet Custom Field Policies
POST/workspace/{id}/webhook-subscriptionSubscribe 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
MethodEndpointDescription
GET/workspace/{id}/partnerList Workspace Partners
GET/workspace/{id}/partner/{partnerId}Get Partner Details
GET/workspace/{id}/partner/inviteList Partner Invites
POST/workspace/{id}/partner/inviteInvite 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 created
  • approved - After approval, ready for funding
  • will_pay - Funded and scheduled for payment; this is the terminal status for successful payables
  • canceled - Payment canceled
MethodEndpointDescription
GET/payableGet Payables
POST/payableCreate Payable
GET/payable/{id}Get Single Payable
GET/payable/{id}/invoice-pdfGet an invoice PDF for a payable
POST/payable/{id}/approveApprove Payable
POST/payable/{id}/unapproveUn-approve Payable
POST/payable/{id}/cancelCancel 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.

MethodEndpointDescription
GET/workspace/{id}/walletGet Workspace Wallet
GET/workspace/{id}/wallet/transactionList Wallet Transactions
GET/workspace/{id}/wallet/depositList Unlinked Deposits
POST/workspace/{id}/wallet/depositCreate 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).

MethodEndpointDescription
GET/fundingGet Fundings
POST/fundingCreate Funding
GET/funding/{id}Get Single Funding
POST/funding/{id}/link-depositLink Funding Payment
POST/funding/{id}/cancelCancel Funding
GET/funding/{id}/pdf-urlGet 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.


📘

Note

Note: 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.

MethodEndpointDescription
GET/user/currentGet Current User
GET/user/current/workspacesGet Current User's Workspaces