Get an offramp order

curl --request GET \
  --url https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/orders/{id}

const options = {method: 'GET'};

fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/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/offramp/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/offramp/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))

}

require 'uri'
require 'net/http'

url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/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",
  "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>"
  },
  "providerStatus": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sender": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "payment": {
    "kind": "direct",
    "from": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "to": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "chain": "<string>",
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "amount": "100000000"
  },
  "expiresAt": "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"
}

{
  "error": "<string>",
  "code": "VERIFICATION_REQUIRED"
}

{
  "error": "<string>",
  "code": "VERIFICATION_REQUIRED"
}

GET

offramp

orders

{id}

Get an offramp order

curl --request GET \
  --url https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/orders/{id}

const options = {method: 'GET'};

fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/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/offramp/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/offramp/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))

}

require 'uri'
require 'net/http'

url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/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",
  "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>"
  },
  "providerStatus": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sender": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "payment": {
    "kind": "direct",
    "from": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "to": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "chain": "<string>",
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "amount": "100000000"
  },
  "expiresAt": "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"
}

{
  "error": "<string>",
  "code": "VERIFICATION_REQUIRED"
}

{
  "error": "<string>",
  "code": "VERIFICATION_REQUIRED"
}

Headers

x-api-key

string

Integrator API key: the project’s orders

authorization

string

Customer bearer from POST /compliance/sessions: that customer’s orders, and every order on its bound account

Example:

"Bearer eyJhbGciOi..."

Path Parameters

string<uuid>

required

Response

The order

string<uuid>

required

provider

enum<string>

required

Available options:

noah,

swapped

status

enum<string>

required

Available options:

pending,

processing,

completed,

failed,

refunded

terminal

boolean

required

No stage will change again

stages

object

required

Show child attributes

rail

object

required

provider_selected / unknown when the provider did not say

Option 1
Option 2

Show child attributes

fiat

object

required

What the bank receives, after fees; null until the provider states it

Show child attributes

crypto

object | null

required

Show child attributes

providerStatus

string

required

The provider’s own status of its latest leg, else ours (reserved, opened, refused, unknown); informational

createdAt

string<date-time>

required

When the provider says the order began

updatedAt

string<date-time>

required

sender

string

required

The address the crypto must come from

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"

payment

object | null

required

Null until the provider’s rule exists: while it is being created, or when the rule was refused or its outcome is unknown. Still served after expiresAt: the provider may still match the transfer.

Show child attributes

expiresAt

string<date-time>

required

Send the payment before this

Get started

Intents

Deposits

Get an offramp order

Headers

Path Parameters

Response