Skip to main content
POST
Create a flow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

mode
enum<string>
required

The flow mode — determines which lifecycle the flow follows. The lifecycle a flow follows — payment, deposit, or withdraw.

Available options:
payment,
deposit,
withdraw

Body

application/json

Create-time payload for a flow. amount, currency, settlementConfig and destinationConfig are written once here (by a trusted API-key caller) and are accepted by no later endpoint. mode is supplied in the URL path.

amount
string
required

Amount in the specified currency

currency
string
required
Maximum string length: 50
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

settlementConfig
object
required
destinationConfig
object
required
memo
object

Arbitrary metadata attached to the flow

feeConfig
object

Fee collection configuration specifying recipients and their shares.

expiresIn
integer

Seconds until the flow expires (default 3600, clamped server-side)

pegStablecoins
boolean

When true, known stablecoins (USDC, USDT, DAI, etc.) in the settlement config are pegged 1:1 to the flow currency at quote time, skipping market-price lookup. Defaults to false.

Response

Flow created

Response returned when a flow is created.

flow
object
required

A single payment, deposit, or withdraw flow. Collapses the former Checkout and CheckoutTransaction into one resource.

Last modified on July 29, 2026