Skip to main content

What is a flow?

A flow is a productized widget experience registered in the platform catalog. Each flow has:
  • A slug used in POST /partner/links (flow field)
  • A host URL used to build the magic-link url (override per partner with a custom flow domain)
  • A config schema validated by that flow’s strategy
Your partner account can only mint flows listed in allowedFlows. Discover yours with:
  • GET /partner/flows — enabled for your account
  • GET /partner/flows/catalog — full catalog metadata

Catalog (conceptual)

M2M is one row in this table, not the name of the platform. Prefer smart for new send integrations unless you need m2m-style prefills.

Choosing a flow

Use smart (or send). Start with Quick Start.
Use m2m and pass config.userData. See M2M flow and User data.
Use request to originate, then the payer opens a fund-request link.
Use cash-deposit. See Cash deposit.
Use deferred-payout-origination (sender hub) and payout-claim (recipient). The sender commits first; the operation is created when the recipient binds. See Deferred payout.
Use lola. The chat closes corridor, amount, recipient and payout, then mints a magic link. The widget shows the certified summary, lets the sender pick any quotable funding method, and returns to WhatsApp. See Lola flow.

Guides by flow

Smart

Reference send

M2M

Prefill-heavy collect

Send

Send variant

Request

Originate requests

Fund request

Fulfill requests

Cash deposit

Cash deposit

Deferred payout

Origination + claim

Lola

WhatsApp handoff