Skip to main content
POST
Create Order Intent Credential

Headers

X-API-KEY
string
required

API key required for authentication

Idempotency-Key
string

Makes a retry of this request safe: a second call with the same key never consumes the amount again. Credential payloads are returned once, so a replay after a successful mint answers 409 ORDER_INTENT_CREDENTIAL_ALREADY_ISSUED. Without it every call is a new mint. 1 to 255 characters.

Path Parameters

orderIntentId
string
required

Body

application/json
amount
object
required
credential
object
required
provider
enum<string>
required
Available options:
agentpay,
vic
rail
enum<string>
required
Available options:
agentic-token
merchant
object

Response

Returns the payment credential

amount
object
required
credential
object
required
expiresAt
string<date-time>
required

ISO 8601. A UTC offset is accepted. Fractional seconds are optional.

Example:

"2024-01-15T10:30:00.000Z"

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
rail
enum<string>
required
Available options:
encrypted-card