Create Order Intent
curl --request POST \
--url https://staging.crossmint.com/api/unstable/order-intents \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '
{
"amount": {
"currency": "<string>",
"value": "<string>"
},
"description": "<string>",
"expiresAt": "2024-01-15T10:30:00.000Z",
"paymentMethodId": "<string>"
}
'import requests
url = "https://staging.crossmint.com/api/unstable/order-intents"
payload = {
"amount": {
"currency": "<string>",
"value": "<string>"
},
"description": "<string>",
"expiresAt": "2024-01-15T10:30:00.000Z",
"paymentMethodId": "<string>"
}
headers = {
"X-API-KEY": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: {currency: '<string>', value: '<string>'},
description: '<string>',
expiresAt: '2024-01-15T10:30:00.000Z',
paymentMethodId: '<string>'
})
};
fetch('https://staging.crossmint.com/api/unstable/order-intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.crossmint.com/api/unstable/order-intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => [
'currency' => '<string>',
'value' => '<string>'
],
'description' => '<string>',
'expiresAt' => '2024-01-15T10:30:00.000Z',
'paymentMethodId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/unstable/order-intents"
payload := strings.NewReader("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/unstable/order-intents")
.header("X-API-KEY", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/unstable/order-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
},
"provider": "agentpay",
"rail": "agentic-token",
"status": "error"
}
],
"status": "active",
"merchant": {
"countryCode": "<string>",
"name": "<string>",
"url": "<string>",
"acquirerBin": "<string>",
"categoryCode": "<string>"
},
"verificationConfig": {
"allowanceId": "<string>",
"environment": "production",
"publicApiKey": "<string>"
}
}Agent Cards
Create Agent Card
Create a new order intent.
API scope required: order-intents.create
POST
/
unstable
/
order-intents
Create Order Intent
curl --request POST \
--url https://staging.crossmint.com/api/unstable/order-intents \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '
{
"amount": {
"currency": "<string>",
"value": "<string>"
},
"description": "<string>",
"expiresAt": "2024-01-15T10:30:00.000Z",
"paymentMethodId": "<string>"
}
'import requests
url = "https://staging.crossmint.com/api/unstable/order-intents"
payload = {
"amount": {
"currency": "<string>",
"value": "<string>"
},
"description": "<string>",
"expiresAt": "2024-01-15T10:30:00.000Z",
"paymentMethodId": "<string>"
}
headers = {
"X-API-KEY": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: {currency: '<string>', value: '<string>'},
description: '<string>',
expiresAt: '2024-01-15T10:30:00.000Z',
paymentMethodId: '<string>'
})
};
fetch('https://staging.crossmint.com/api/unstable/order-intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.crossmint.com/api/unstable/order-intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => [
'currency' => '<string>',
'value' => '<string>'
],
'description' => '<string>',
'expiresAt' => '2024-01-15T10:30:00.000Z',
'paymentMethodId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/unstable/order-intents"
payload := strings.NewReader("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/unstable/order-intents")
.header("X-API-KEY", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/unstable/order-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expiresAt\": \"2024-01-15T10:30:00.000Z\",\n \"paymentMethodId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
},
"provider": "agentpay",
"rail": "agentic-token",
"status": "error"
}
],
"status": "active",
"merchant": {
"countryCode": "<string>",
"name": "<string>",
"url": "<string>",
"acquirerBin": "<string>",
"categoryCode": "<string>"
},
"verificationConfig": {
"allowanceId": "<string>",
"environment": "production",
"publicApiKey": "<string>"
}
}Headers
API key required for authentication
Body
application/json
Show child attributes
Show child attributes
Required string length:
1 - 10000ISO 8601. A UTC offset is accepted. Fractional seconds are optional.
Example:
"2024-01-15T10:30:00.000Z"
Minimum string length:
1Show child attributes
Show child attributes
Response
201 - application/json
The order intent has been successfully created
Show child attributes
Show child attributes
ISO 8601. A UTC offset is accepted. Fractional seconds are optional.
Example:
"2024-01-15T10:30:00.000Z"
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)$Minimum string length:
1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Available options:
active, cancelled, expired Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?