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(flowfield) - A host URL used to build the magic-link
url - A config schema validated by that flow’s strategy
allowedFlows. Discover yours with:
GET /partner/flows— enabled for your accountGET /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
I want users to send money with minimal partner data
I want users to send money with minimal partner data
Use smart (or send). Start with Quick Start.
I already have KYC / bank data and want less widget friction
I already have KYC / bank data and want less widget friction
I want users to ask someone else to pay them
I want users to ask someone else to pay them
Use request to originate, then the payer opens a fund-request link.
Cash deposit
Cash deposit
Use cash-deposit. See Cash deposit.
Deferred remittance
Deferred remittance
Use deferred-payout-origination (and claim via payout-claim when applicable).
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