Get Order
curl --request GET \
--url https://staging.crossmint.com/api/2022-06-09/orders/{orderId}import requests
url = "https://staging.crossmint.com/api/2022-06-09/orders/{orderId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://staging.crossmint.com/api/2022-06-09/orders/{orderId}', 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/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/2022-06-09/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"disabled": false,
"id": "155",
"terms": {
"commercialAttribution": true,
"commercialRevCeiling": 0,
"commercialRevShare": 10000000,
"commercialUse": true,
"commercializerChecker": "0x0000000000000000000000000000000000000000",
"commercializerCheckerData": "0x0000000000000000000000000000000000000000",
"currency": "0x1234567890123456789012345678901234567890",
"defaultMintingFee": 100,
"derivativeRevCeiling": 0,
"derivativesAllowed": true,
"derivativesApproval": false,
"derivativesAttribution": true,
"derivativesReciprocal": true,
"expiration": 0,
"royaltyPolicy": "0x1234567890123456789012345678901234567890",
"transferable": true,
"uri": "Will contain a reference to the license terms metadata"
}
}Orders
Get Order
Retrieves an onramp order by its ID. Use this endpoint to poll the order and track its progress through the onramp flow: KYC, recipient verification (for external wallets), payment, and delivery. Read payment.status to determine the next action for the buyer.
Authentication: Use either a server-side API key with the orders.read scope, or the clientSecret returned when the order was created, passed as an Authorization header.
GET
/
2022-06-09
/
orders
/
{orderId}
Get Order
curl --request GET \
--url https://staging.crossmint.com/api/2022-06-09/orders/{orderId}import requests
url = "https://staging.crossmint.com/api/2022-06-09/orders/{orderId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://staging.crossmint.com/api/2022-06-09/orders/{orderId}', 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/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/2022-06-09/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"disabled": false,
"id": "155",
"terms": {
"commercialAttribution": true,
"commercialRevCeiling": 0,
"commercialRevShare": 10000000,
"commercialUse": true,
"commercializerChecker": "0x0000000000000000000000000000000000000000",
"commercializerCheckerData": "0x0000000000000000000000000000000000000000",
"currency": "0x1234567890123456789012345678901234567890",
"defaultMintingFee": 100,
"derivativeRevCeiling": 0,
"derivativesAllowed": true,
"derivativesApproval": false,
"derivativesAttribution": true,
"derivativesReciprocal": true,
"expiration": 0,
"royaltyPolicy": "0x1234567890123456789012345678901234567890",
"transferable": true,
"uri": "Will contain a reference to the license terms metadata"
}
}Path Parameters
Response
200 - application/json
Order found successfully
The License Terms ID
Example:
"1"
The PIL terms details as per retrieved from story
Show child attributes
Show child attributes
Example:
{
"commercialAttribution": true,
"commercialRevCeiling": 0,
"commercialRevShare": 10000000,
"commercialUse": true,
"commercializerChecker": "0x0000000000000000000000000000000000000000",
"commercializerCheckerData": "0x0000000000000000000000000000000000000000",
"currency": "0x1234567890123456789012345678901234567890",
"defaultMintingFee": 100,
"derivativeRevCeiling": 0,
"derivativesAllowed": true,
"derivativesApproval": false,
"derivativesAttribution": true,
"derivativesReciprocal": true,
"expiration": 0,
"royaltyPolicy": "0x1234567890123456789012345678901234567890",
"transferable": true,
"uri": "Will contain a reference to the license terms metadata"
}
If true, the license terms will be disabled. Effectively preventing future mints with this license.
Example:
false
Example:
{
"disabled": false,
"id": "155",
"terms": {
"commercialAttribution": true,
"commercialRevCeiling": 0,
"commercialRevShare": 10000000,
"commercialUse": true,
"commercializerChecker": "0x0000000000000000000000000000000000000000",
"commercializerCheckerData": "0x0000000000000000000000000000000000000000",
"currency": "0x1234567890123456789012345678901234567890",
"defaultMintingFee": 100,
"derivativeRevCeiling": 0,
"derivativesAllowed": true,
"derivativesApproval": false,
"derivativesAttribution": true,
"derivativesReciprocal": true,
"expiration": 0,
"royaltyPolicy": "0x1234567890123456789012345678901234567890",
"transferable": true,
"uri": "Will contain a reference to the license terms metadata"
}
}
Was this page helpful?