Skip to main content
POST
Produce a multi-step payment plan (no execution)
This endpoint returns a multi-step payment plan (no execution). For step types and Digital Collect behaviour, see Payments.

Authorizations

Authorization
string
header
required

Basic Auth (assumed at gateway for MVP)

Body

application/json
clientReference
string
required
Maximum string length: 128
Example:

"erp-payment-001"

corridorId
string
required
Example:

"usdc-eth->aud-bank"

amountIn
string
required

Input amount (smallest units) as string

Example:

"1000000"

recipient
object
required

Recipient details (bank recipient, or digital collect recipient, etc.)

options
object

Response

Payment plan

planId
string
required
Example:

"plan_123"

steps
object[]
required