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
recipient
string
required

Recipient wallet address (EVM 0x... or TRON T...)

creatorWalletAddress
string
required

Wallet address that created the payout link. This is not necessarily the wallet that will execute the payment.

network
string
required

Blockchain network the payout targets (e.g., 'mainnet', 'sepolia', 'tron')

Minimum string length: 1
currency
string
required

Currency ID in the '-' format (e.g., 'USDC-mainnet', 'FAU-sepolia')

Minimum string length: 1
amount
string
required

The payout amount, in human readable format

reference
string

Merchant reference for receipt tracking and identification

Required string length: 1 - 255
recipientIdentifier
string

Recipient identifier for tracking outgoing payout recipients

Required string length: 1 - 255
feePercentage
string

DEPRECATED. Legacy fee percentage; ignored. Fees are now resolved server-side from the fee plan snapshot.

feeAddress
string

DEPRECATED. Legacy fee recipient; ignored. Fees are now resolved server-side from the fee plan snapshot.

redirectUrl
string

URL the payer is redirected to after a successful payment

redirectLabel
string

Optional label describing the redirect destination

Required string length: 1 - 255
Pattern: ^[^<>&"'`]*$
accessPolicy
object

Optional per-payment access policy override.

Response

Payout secure payment created successfully

requestIds
string[]
required

Array of request IDs created for this secure payment

securePaymentUrl
string<uri>
required

URL to the secure payment page

token
string
required

Secure payment token

feePlan
object | null
required

Resolved fee plan snapshot. Null when fees don't apply — e.g. non-stablecoin currency, or a batch that spans multiple currencies (not yet supported).