Create Order Intent

Create a new order intent.

API scope required: order-intents.create

POST /unstable/order-intents

cURL

Merchant-Scoped

curl --request POST \
  --url https://staging.crossmint.com/api/unstable/order-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": {
    "currency": "USD",
    "value": "150.00"
  },
  "description": "Weekly grocery purchases",
  "expiresAt": "2030-12-31T23:59:59Z",
  "merchant": {
    "countryCode": "US",
    "name": "Acme Store",
    "url": "https://acme.example.com"
  },
  "paymentMethodId": "9f1a6b2c-3d4e-4f50-9a61-2b3c4d5e6f70"
}
'

201

{
  "amount": {
    "available": "<string>",
    "currency": "<string>",
    "reserved": "<string>",
    "spent": "<string>",
    "total": "<string>"
  },
  "description": "<string>",
  "expiresAt": "2024-01-15T10:30:00.000Z",
  "orderIntentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentMethodId": "<string>",
  "rails": [
    {
      "credentialFormats": [
        "card"
      ],
      "error": {
        "code": "<string>"
      },
      "rail": "encrypted-card",
      "status": "error"
    }
  ],
  "status": "active",
  "merchant": {
    "countryCode": "<string>",
    "name": "<string>",
    "url": "<string>",
    "acquirerBin": "<string>",
    "categoryCode": "<string>"
  },
  "verificationConfig": {
    "allowanceId": "<string>",
    "environment": "production",
    "publicApiKey": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

API key required for authentication

Authorization · string · header · required

The end user's JWT, sent as Authorization: Bearer <JWT> together with a client-side API key. Validated against the project's external JWT configuration.

Body

application/json

amount · object · required

Show child attributes

description · string · required

Required string length: 1 - 10000

expiresAt · string<date-time> · required

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

Example:

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

paymentMethodId · string · required

Minimum string length: 1

merchant · object

Show child attributes

Response

201 - application/json

The order intent has been successfully created

amount · object · required

Show child attributes

description · string · required

expiresAt · string<date-time> · required

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

Example:

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

orderIntentId · 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)$

paymentMethodId · string · required

Minimum string length: 1

rails · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

status · enum<string> · required

Available options: active, cancelled, expired

merchant · object

Show child attributes

verificationConfig · object

Show child attributes