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
requests
object[]
required

Array of payment requests. Single item = single incoming payment. Multiple items preserve the legacy incoming-payment batch shape and are unrelated to multicall payout parents. A batch varies only the amounts: every item resolves to the caller's single configured destination, so one create call cannot collect into several different payee destinations.

Minimum array length: 1
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.

reference
string

Merchant reference for receipt tracking and identification

Required string length: 1 - 255
payerIdentifier
string

Payer identifier for tracking who is making the payment

Required string length: 1 - 255
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. If omitted, the payment inherits the destination access policy.

Response

Secure payment entry 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).