Skip to content

Create execution (canonical, idempotent)

POST
/v2/onramp/executions

Canonical way to create an execution (idempotent). Accepts quoteId (preferred) OR full request (atomic price→lock→execute). Makes executions a first-class resource; useful for partners & ops tooling. Always enforce Idempotency-Key. Accept either body.quoteId (preferred), or full execution request that server atomically prices → locks ephemeral quote → executes.

X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
customerId
required

Customer ID

string
quoteId

Quote ID (for POST /executions)

string

ExecutionId, intentId, initial status and instructions.

object
onrampId
string
status
required
string
depositInstructions
object
accountNumber
required
string
accountName
required
string
bankName
required
string
bankCode
required
string
expectedAmount
required
string
reference
required
string
expiresAt
required
string

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error