Get an onramp order
curl --request GET \
--url https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}import requests
url = "https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}', 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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}",
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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}"
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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "noah",
"kind": "fiat",
"status": "pending",
"terminal": true,
"stages": {
"receipt": {
"status": "not_started"
},
"conversion": {
"status": "not_started"
},
"delivery": {
"status": "not_started"
},
"return": {
"status": "none"
}
},
"rail": {
"kind": "fiat",
"method": "<string>"
},
"fiat": {
"charged": {
"total": "<string>",
"net": "<string>",
"currency": "<string>"
},
"eur": {
"total": "<string>",
"net": "<string>"
},
"usd": {
"total": "<string>",
"net": "<string>"
}
},
"crypto": {
"asset": "<string>",
"network": "<string>",
"amount": "<string>"
},
"account": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
"deliveryAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
"deliveryChain": "<string>",
"providerStatus": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}Onramp
Get an onramp order
Accepts any id the caller holds: the order id, the provider’s order id (e.g. the orderId of the legacy onramp-order webhook), the orderId returned when the checkout was started (when retries share it, the newest order), or the externalCustomerId signed into the checkout (<account>:<reference>). 404 until the provider first reports the order. A customer bearer reads that customer’s orders and every order on its bound account.
GET
/
onramp
/
orders
/
{id}
Get an onramp order
curl --request GET \
--url https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}import requests
url = "https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}', 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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}",
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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}"
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://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/onramp/orders/{id}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "noah",
"kind": "fiat",
"status": "pending",
"terminal": true,
"stages": {
"receipt": {
"status": "not_started"
},
"conversion": {
"status": "not_started"
},
"delivery": {
"status": "not_started"
},
"return": {
"status": "none"
}
},
"rail": {
"kind": "fiat",
"method": "<string>"
},
"fiat": {
"charged": {
"total": "<string>",
"net": "<string>",
"currency": "<string>"
},
"eur": {
"total": "<string>",
"net": "<string>"
},
"usd": {
"total": "<string>",
"net": "<string>"
}
},
"crypto": {
"asset": "<string>",
"network": "<string>",
"amount": "<string>"
},
"account": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
"deliveryAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
"deliveryChain": "<string>",
"providerStatus": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}{
"error": "<string>",
"code": "VERIFICATION_REQUIRED"
}Headers
Integrator API key: the project’s orders
Customer bearer from POST /compliance/sessions: that customer’s orders, and every order on its bound account
Example:
"Bearer eyJhbGciOi..."
Path Parameters
Order id, provider order id, checkout reference, or legacy <account>:<reference>
Pattern:
^[A-Za-z0-9._:-]{1,128}$Response
The order
Available options:
noah, swapped Available options:
fiat, exchange Available options:
pending, processing, completed, failed, refunded No stage will change again
Show child attributes
Show child attributes
provider_selected / unknown when the provider did not say
- Option 1
- Option 2
Show child attributes
Show child attributes
Each figure in a fixed currency; null when the provider did not state it
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Ethereum address (0x followed by 40 hex characters)
Pattern:
^0x[a-fA-F0-9]{40}$Example:
"0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
Ethereum address (0x followed by 40 hex characters)
Pattern:
^0x[a-fA-F0-9]{40}$Example:
"0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
CAIP-2 chain of the delivery, e.g. eip155:8453
The provider’s own status; informational
When the provider says the order began
Was this page helpful?