Skip to main content
POST

Headers

x-api-key
string

API key for authentication (optional if using Client ID, session, or orchestrator key)

x-client-id
string

Client ID for frontend authentication (required when paired with orchestrator key)

x-orchestrator-key
string

Orchestrator key for authentication (must be paired with Client ID)

Authorization
string

Bearer token for session authentication (or use the session_token cookie). Only consulted when no x-orchestrator-key, x-api-key, or x-client-id header is present.

Origin
string

Origin header (required for Client ID / orchestrator auth, automatically set by browser)

Body

application/json
amount
string
required

Base/displayed amount in human-readable units, as a decimal string (e.g. "12.5").

currency
string
required

Currency symbol or currency ID (e.g. 'USDC' or 'USDC-mainnet'). Must resolve to a supported stablecoin.

Minimum string length: 1
flow
enum<string>
required

get_paid for incoming payments (recipient creates link), pay for outgoing payments (payer initiates).

Available options:
get_paid,
pay
defaultFeeBearer
enum<string>

Payment-level override of the flow default. Per-fee config bearer still wins.

Available options:
payer,
payee

Response

Fee plan preview

version
enum<number>
required
Available options:
1
flow
enum<string>
required
Available options:
get_paid,
pay
defaultFeeBearer
enum<string>
required
Available options:
payer,
payee
grossAmountUsd
string
required
netRecipientAmountUsd
string
required
payerTotalAmountUsd
string
required
totalFeesUsd
string
required
payeeBorneFeesUsd
string
required
payerBorneFeesUsd
string
required
fees
object[]
required