Skip to main content
POST
Create Order Intent

Headers

X-API-KEY
string
required

API key required for authentication

Body

application/json
agentId
string
required
payment
object
required
mandates
object[]
required
expiresAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

201 - application/json

The order intent has been successfully created

orderIntentId
string
required
agentId
string
required
mandates
object[]
required
payment
object
required
phase
enum<string>
required
Available options:
requires-verification
verificationConfig
object
required