Create Order
curl --request POST \
--url https://staging.crossmint.com/api/2022-06-09/orders \
--header 'Content-Type: application/json' \
--data '
{
"externalOrder": "<unknown>",
"payment": {
"method": "bank-transfer",
"receiptEmail": "jsmith@example.com"
},
"locale": "en-US",
"metadata": {},
"recipient": {
"email": "jsmith@example.com"
},
"state": "<string>"
}
'import requests
url = "https://staging.crossmint.com/api/2022-06-09/orders"
payload = {
"externalOrder": "<unknown>",
"payment": {
"method": "bank-transfer",
"receiptEmail": "jsmith@example.com"
},
"locale": "en-US",
"metadata": {},
"recipient": { "email": "jsmith@example.com" },
"state": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
externalOrder: '<unknown>',
payment: {method: 'bank-transfer', receiptEmail: 'jsmith@example.com'},
locale: 'en-US',
metadata: {},
recipient: {email: 'jsmith@example.com'},
state: '<string>'
})
};
fetch('https://staging.crossmint.com/api/2022-06-09/orders', 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/2022-06-09/orders",
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([
'externalOrder' => '<unknown>',
'payment' => [
'method' => 'bank-transfer',
'receiptEmail' => 'jsmith@example.com'
],
'locale' => 'en-US',
'metadata' => [
],
'recipient' => [
'email' => 'jsmith@example.com'
],
'state' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/2022-06-09/orders"
payload := strings.NewReader("{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/2022-06-09/orders")
.header("Content-Type", "application/json")
.body("{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"clientSecret": "<string>",
"order": {
"lineItems": [
{
"chain": "abstract",
"delivery": {
"status": "failed",
"completedAt": "2023-11-07T05:31:56Z",
"failureReason": {
"code": "insufficient-funds",
"message": "<string>"
},
"rail": "ach-co",
"recipient": {
"email": "jsmith@example.com",
"locator": "<string>",
"walletAddress": "<string>",
"physicalAddress": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"name": "<string>",
"postalCode": "<string>",
"line2": "",
"state": "<string>",
"stateOrRegion": "<string>"
}
}
},
"executionMode": "exact-in",
"maxSlippageBps": "<string>",
"metadata": {
"description": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"collection": {
"description": "<string>",
"imageUrl": "<string>",
"name": "<string>"
}
},
"quote": {
"quantityRange": {
"lowerBound": "<string>",
"upperBound": "<string>"
},
"status": "expired",
"charges": {
"unit": {
"amount": "<string>",
"currency": "$mfer"
},
"crossmintFees": {
"amount": "<string>",
"currency": "$mfer"
},
"fees": {
"amount": "<string>",
"currency": "$mfer",
"type": "exact"
},
"gas": {
"amount": "<string>",
"currency": "$mfer"
},
"networkFee": {
"amount": "<string>",
"currency": "$mfer"
},
"salesTax": {
"amount": "<string>",
"currency": "$mfer"
},
"shipping": {
"amount": "<string>",
"currency": "$mfer"
}
},
"totalPrice": {
"amount": "<string>",
"currency": "$mfer"
},
"unavailabilityReason": {
"code": "do",
"message": "<string>"
}
},
"callData": {},
"executionParams": {}
}
],
"locale": "Klingon",
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"currency": "$mfer",
"method": "abstract",
"status": "awaiting-deposit-instructions",
"failureReason": {
"code": "<string>",
"category": "authorization_decline",
"developerMessage": "<string>",
"message": "<string>",
"retryPolicy": "complete_authentication"
},
"payer": {
"deviceId": "<string>",
"paymentMethodId": "<string>"
},
"preparation": {
"chain": "abstract",
"payerAddress": "<string>",
"serializedTransaction": "<string>",
"transactionParameters": {
"amount": "<string>",
"memo": "<string>"
}
},
"receiptEmail": "jsmith@example.com",
"received": {
"amount": "<string>",
"chain": "abstract",
"currency": "$mfer",
"txId": "<string>"
},
"refunded": {
"amount": "<string>",
"chain": "abstract",
"currency": "$mfer",
"txId": "<string>"
}
},
"phase": "completed",
"quote": {
"status": "all-line-items-unavailable",
"expiresAt": "2023-11-07T05:31:56Z",
"quotedAt": "2023-11-07T05:31:56Z",
"totalPrice": {
"amount": "<string>",
"currency": "$mfer"
}
},
"legal": {
"requirements": [
{
"display": "show-checkbox",
"type": "crossmint-privacy-policy",
"url": "<string>"
}
],
"shownBy": "crossmint"
},
"metadata": {}
}
}{
"error": true,
"message": "<string>",
"code": "<string>"
}{
"error": true,
"message": "<string>",
"code": "<string>"
}{
"error": true,
"message": "<string>",
"code": "<string>"
}Orders
Create Order
Creates an offramp order to cash out stablecoins to fiat. The order returns on-chain deposit instructions that the payer wallet broadcasts to fund the fiat payout.
POST
/
2022-06-09
/
orders
Create Order
curl --request POST \
--url https://staging.crossmint.com/api/2022-06-09/orders \
--header 'Content-Type: application/json' \
--data '
{
"externalOrder": "<unknown>",
"payment": {
"method": "bank-transfer",
"receiptEmail": "jsmith@example.com"
},
"locale": "en-US",
"metadata": {},
"recipient": {
"email": "jsmith@example.com"
},
"state": "<string>"
}
'import requests
url = "https://staging.crossmint.com/api/2022-06-09/orders"
payload = {
"externalOrder": "<unknown>",
"payment": {
"method": "bank-transfer",
"receiptEmail": "jsmith@example.com"
},
"locale": "en-US",
"metadata": {},
"recipient": { "email": "jsmith@example.com" },
"state": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
externalOrder: '<unknown>',
payment: {method: 'bank-transfer', receiptEmail: 'jsmith@example.com'},
locale: 'en-US',
metadata: {},
recipient: {email: 'jsmith@example.com'},
state: '<string>'
})
};
fetch('https://staging.crossmint.com/api/2022-06-09/orders', 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/2022-06-09/orders",
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([
'externalOrder' => '<unknown>',
'payment' => [
'method' => 'bank-transfer',
'receiptEmail' => 'jsmith@example.com'
],
'locale' => 'en-US',
'metadata' => [
],
'recipient' => [
'email' => 'jsmith@example.com'
],
'state' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/2022-06-09/orders"
payload := strings.NewReader("{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/2022-06-09/orders")
.header("Content-Type", "application/json")
.body("{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalOrder\": \"<unknown>\",\n \"payment\": {\n \"method\": \"bank-transfer\",\n \"receiptEmail\": \"jsmith@example.com\"\n },\n \"locale\": \"en-US\",\n \"metadata\": {},\n \"recipient\": {\n \"email\": \"jsmith@example.com\"\n },\n \"state\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"clientSecret": "<string>",
"order": {
"lineItems": [
{
"chain": "abstract",
"delivery": {
"status": "failed",
"completedAt": "2023-11-07T05:31:56Z",
"failureReason": {
"code": "insufficient-funds",
"message": "<string>"
},
"rail": "ach-co",
"recipient": {
"email": "jsmith@example.com",
"locator": "<string>",
"walletAddress": "<string>",
"physicalAddress": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"name": "<string>",
"postalCode": "<string>",
"line2": "",
"state": "<string>",
"stateOrRegion": "<string>"
}
}
},
"executionMode": "exact-in",
"maxSlippageBps": "<string>",
"metadata": {
"description": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"collection": {
"description": "<string>",
"imageUrl": "<string>",
"name": "<string>"
}
},
"quote": {
"quantityRange": {
"lowerBound": "<string>",
"upperBound": "<string>"
},
"status": "expired",
"charges": {
"unit": {
"amount": "<string>",
"currency": "$mfer"
},
"crossmintFees": {
"amount": "<string>",
"currency": "$mfer"
},
"fees": {
"amount": "<string>",
"currency": "$mfer",
"type": "exact"
},
"gas": {
"amount": "<string>",
"currency": "$mfer"
},
"networkFee": {
"amount": "<string>",
"currency": "$mfer"
},
"salesTax": {
"amount": "<string>",
"currency": "$mfer"
},
"shipping": {
"amount": "<string>",
"currency": "$mfer"
}
},
"totalPrice": {
"amount": "<string>",
"currency": "$mfer"
},
"unavailabilityReason": {
"code": "do",
"message": "<string>"
}
},
"callData": {},
"executionParams": {}
}
],
"locale": "Klingon",
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"currency": "$mfer",
"method": "abstract",
"status": "awaiting-deposit-instructions",
"failureReason": {
"code": "<string>",
"category": "authorization_decline",
"developerMessage": "<string>",
"message": "<string>",
"retryPolicy": "complete_authentication"
},
"payer": {
"deviceId": "<string>",
"paymentMethodId": "<string>"
},
"preparation": {
"chain": "abstract",
"payerAddress": "<string>",
"serializedTransaction": "<string>",
"transactionParameters": {
"amount": "<string>",
"memo": "<string>"
}
},
"receiptEmail": "jsmith@example.com",
"received": {
"amount": "<string>",
"chain": "abstract",
"currency": "$mfer",
"txId": "<string>"
},
"refunded": {
"amount": "<string>",
"chain": "abstract",
"currency": "$mfer",
"txId": "<string>"
}
},
"phase": "completed",
"quote": {
"status": "all-line-items-unavailable",
"expiresAt": "2023-11-07T05:31:56Z",
"quotedAt": "2023-11-07T05:31:56Z",
"totalPrice": {
"amount": "<string>",
"currency": "$mfer"
}
},
"legal": {
"requirements": [
{
"display": "show-checkbox",
"type": "crossmint-privacy-policy",
"url": "<string>"
}
],
"shownBy": "crossmint"
},
"metadata": {}
}
}{
"error": true,
"message": "<string>",
"code": "<string>"
}{
"error": true,
"message": "<string>",
"code": "<string>"
}{
"error": true,
"message": "<string>",
"code": "<string>"
}Body
application/json
- Option 1
- Option 2
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
- Option 45
- Option 46
- Option 47
- Option 48
- Option 49
- Option 50
- Option 51
- Option 52
- Option 53
- Option 54
- Option 55
- Option 56
- Option 57
- Option 58
- Option 59
- Option 60
- Option 61
- Option 62
- Option 63
- Option 64
- Option 65
- Option 66
- Option 67
- Option 68
- Option 69
- Option 70
- Option 71
- Option 72
- Option 73
- Option 74
- Option 75
- Option 76
- Option 77
- Option 78
- Option 79
- Option 80
- Option 81
- Option 82
- Option 83
- Option 84
- Option 85
- Option 86
- Option 87
Show child attributes
Show child attributes
Locale for the checkout, in IETF BCP 47. It impacts the email receipt language. Ensure your UI is set to the same language as specified here. Throws an error if passed an invalid language.
Available options:
Klingon, de-DE, en-US, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-PT, ru-RU, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW Show child attributes
Show child attributes
Recipient of the items being purchased. You can specify a wallet address, email, or payment method id, either explicitly or using a 'locator'. If you pass an email, Crossmint will create a custodial wallet address for the user on the fly, that they can later log in to. If no recipient is passed, an order will be created with the status 'missing-recipient', until you pass one.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Was this page helpful?