Get Card Permission

Get a specific order intent by ID.

API scope required: order-intents.read

GET /unstable/order-intents/{orderIntentId}

Get Order Intent

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/unstable/order-intents/{orderIntentId} \
  --header 'X-API-KEY: <x-api-key>'

200

{
  "orderIntentId": "oi_8d6a4b1f-9c8a-4cba-b2c1-3a5b8c0d6f12",
  "agentId": "9b3a1c20-1f2c-4f78-9f4d-6c5b8a3a8a01",
  "phase": "requires-verification",
  "payment": {
    "paymentMethodId": "pm_8d6a4b1f-9c8a-4cba-b2c1-3a5b8c0d6f12"
  },
  "mandates": [
    {
      "type": "maxAmount",
      "value": "100.00",
      "details": {
        "currency": "usd",
        "period": "monthly"
      }
    },
    {
      "type": "description",
      "value": "Weekly grocery purchases"
    }
  ],
  "verificationConfig": {
    "environment": "production",
    "publicApiKey": "key_publicSomething",
    "agentId": "agt_btxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "instructionId": "ins_btxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Headers

X-API-KEY · string · required

API key required for authentication

Path Parameters

orderIntentId · string · required

Response

200 - application/json

Returns the order intent

Option 1

Option 2

orderIntentId · string · required

agentId · string · required

mandates · object[] · required

Option 1

Option 2

Option 3

Option 4

Show child attributes

payment · object · required

Show child attributes

phase · enum<string> · required

Available options: requires-verification

verificationConfig · object · required

Show child attributes