Oncade logo
Overview
Using Oncade Pay
Getting StartedInvoicingPaying an InvoiceFunding & BalancesPayouts & WithdrawalsRevenue & RoyaltiesTaxFAQ
Getting Started for Platforms
Embedded Finance
Integration Guides
Business OnboardingInvoicingPayouts & Distributions
Platform API Reference
Business Linking & Grants/v1/platform/meGET/v1/platform/me/scopesPOST/v1/platform/me/keysGET/v1/platform/me/keysPOST/v1/platform/me/keys/{keyId}GET/v1/platform/me/keys/{keyId}DELETE/v1/platform/me/keys/{keyId}/rotatePOST/v1/platform/link-sessionsGET/v1/platform/link-sessionsPOST/v1/platform/link-sessions/{sessionId}GET/v1/platform/link-sessions/{sessionId}DELETE/v1/platform/grantsGET/v1/platform/grants/{grantId}/revokePOST/v1/platform/invitesGET/v1/platform/invitesPOST/v1/platform/invites/{inviteId}/cancelPOST/v1/platform/campaignsGET/v1/platform/campaignsPOST/v1/platform/campaigns/{campaignId}GET/v1/platform/campaigns/{campaignId}PATCH/v1/platform/campaigns/{campaignId}DELETE/v1/platform/campaigns/{campaignId}/users/{userRef}/link/initiatePOST/v1/platform/campaigns/{campaignId}/users/link/detailsGET/v1/platform/campaigns/{campaignId}/users/{userRef}/link/removePOST/v1/platform/campaigns/{campaignId}/users/{userRef}/wallet/balanceGET/v1/platform/campaigns/{campaignId}/usersGET/v1/platform/campaigns/{campaignId}/link-sessionsPOST/v1/platform/campaigns/{campaignId}/link-invitesPOST/v1/platform/campaigns/{campaignId}/link-invitesGET/v1/platform/campaigns/{campaignId}/link-invites/{code}PATCH/v1/platform/campaigns/{campaignId}/link-invites/{code}DELETE/v1/platform/campaigns/{campaignId}/eventsPOST/v1/platform/campaigns/{campaignId}/startPUT/v1/platform/campaigns/{campaignId}/stopPUT/v1/platform/campaigns/{campaignId}/fund-sessionsPOST/v1/platform/campaigns/{campaignId}/fund-sessions/{handle}GET/v1/platform/campaigns/{campaignId}/payout-wallet/balanceGET/v1/platform/invoicesGET/v1/platform/invoicesPOST/v1/platform/invoices/{invoiceId}GET/v1/platform/invoices/{invoiceId}PUT/v1/platform/invoices/{invoiceId}/sendPOST/v1/platform/invoices/{invoiceId}/cancelPOST/v1/platform/invoices/exportGET/v1/platform/invoice-templatesGET/v1/platform/invoice-templatesPOST/v1/platform/invoice-templates/{templateId}GET/v1/platform/invoice-templates/{templateId}PUT/v1/platform/invoice-templates/{templateId}DELETE/v1/platform/business/users/link/initiatePOST/v1/platform/business/users/link/detailsGET/v1/platform/business/usersGET/v1/platform/business/users/{userRef}/wallet/balanceGET/v1/platform/business/users/{userRef}/campaigns/{campaignId}/assignPOST/v1/platform/business/users/{userRef}/link/removePOST/v1/platform/businessPOST/v1/platform/businessGET/v1/platform/businessPATCH/v1/platform/business/readinessGET/v1/platform/distributionsGET/v1/platform/distributionsPOST/v1/platform/distributions/{distributionId}/cancelPOST/v1/platform/distributions/{distributionId}/fund-sessionsPOST/v1/platform/distributions/{distributionId}/fund-sessions/{sessionHandle}GET/v1/platform/distributions/{distributionId}/fund-sessions/{sessionHandle}DELETE/v1/platform/split-templatesGET/v1/platform/split-templatesPOST/v1/platform/split-templates/{templateId}GET/v1/platform/split-templates/{templateId}PATCH/v1/platform/split-templates/{templateId}DELETE/v1/platform/gifts/bulkPOST/v1/platform/gifts/mark-fundedPOST/v1/platform/lookup-emailsPOSTWebhooks

Embedded Finance Overview

The Platform API lets your product offer invoicing, payouts, and business accounts. You do not have to build money movement, verification, or compliance yourself. You call the API from your backend. Oncade provides hosted pages for the steps that need a person: account sign-in, business verification, invoice payment, and funding approvals.

Building blocks

PieceWhat it is
Platform account & API keysYour platform identity. Each key has scopes (for example invoice:create, distribution:create) and belongs to one environment. The test environment auto-approves requested scopes.
BusinessesThe accounts you operate for. Create them directly with POST /v1/platform/business, or connect existing Oncade businesses through link sessions, invites, or grants.
Grants & scopesA grant records what a business allows your platform to do. Pass grantScopes at business creation to skip the manual approval flow.
Hosted pagesReady-made pages on the Pay app for sign-in, business verification, invoice payment, and funding approvals. API responses include the URLs. Do not construct them by hand.
WebhooksEvent notifications for invoice and payout status changes. Your system stays in sync without polling. See the webhooks section of the API reference.

The integration path

Loading diagram…
  1. Get a platform account and API key. Create a platform in the developer portal and generate your first key there. Oncade issues keys per environment, and each key carries the scopes you request. Step by step: Getting Started for Platforms.
  2. Create or connect businesses. For programmatic onboarding, create the business with members and grantScopes in one call. For businesses that already use Oncade, start a link session or invite. Full walkthrough: Business Onboarding guide.
  3. Send owners through hosted onboarding. The create/get business responses include links.signIn, links.kyb, and links.home. Put those links in your own UI or emails. The business owner signs in and completes verification on the hosted pages.
  4. Check readiness before moving money. GET /v1/platform/business/readiness reports whether verification, payout setup, and address are complete. It returns the onboarding links for anything still missing.
  5. Operate. Create and send invoices (each response includes a hosted links.invoice payment page for the recipient), or run payouts and distributions with split templates and funding sessions.
  6. Listen for webhooks. Subscribe to status events instead of polling. Reconcile your records against GET endpoints when needed.

Hosted pages

Hosted pages live under /platform/{platformId}/{businessId}/ on the Pay app. Always use the URLs that the API responses return. Do not construct them.

PageWho uses itPurpose
/sign-inBusiness membersSign in or create an Oncade account, branded with your platform context
/kybBusiness ownerBusiness verification. The business must complete it before it can move money
/invoice/{invoiceId}Invoice recipientView and pay an invoice
/fund-distributionBusiness memberReview and fund a pending distribution through a funding session
/fund-campaignBusiness memberReview and fund a campaign through a funding session

Environments

Oncade issues API keys for a test or live environment. Test keys auto-approve scope requests and operate on test data. You can build the full flow, from onboarding to invoicing to payouts, before you request live scopes. See test and live environments for how the two differ and how to go live.

Next steps

  • Business Onboarding guide
  • Invoicing guide
  • Payouts & Distributions guide
  • Platform API Reference
© 2026 Oncade. All rights reserved.
Terms of Service