Skip to main content
GET
/
unstable
/
order-intents
List Order Intents
curl --request GET \
  --url https://staging.crossmint.com/api/unstable/order-intents \
  --header 'X-API-KEY: <x-api-key>'
{
  "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

Response

200 - application/json

Returns the list of order intents

​
orderIntentId
string
required
​
agentId
string
required
​
mandates
object[]
required
​
payment
object
required
​
phase
enum<string>
required
Available options:
requires-verification
​
verificationConfig
object
required
Example:
{
  "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"
  }
}