curl --request GET \
--url https://platform.spritz.finance/v1/off-ramps/{offRampId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/off-ramps/{offRampId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.spritz.finance/v1/off-ramps/{offRampId}', 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://platform.spritz.finance/v1/off-ramps/{offRampId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform.spritz.finance/v1/off-ramps/{offRampId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/off-ramps/{offRampId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/off-ramps/{offRampId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "6a99b80613a0c37251651788",
"quoteId": "6a99b7bacc18094dfe644ba6",
"status": "awaiting_funding",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"input": {
"amount": "0.25",
"token": "USDC",
"chain": "ethereum"
},
"output": {
"amount": "100.00",
"currency": "USD",
"accountId": "6a9fee5c215e5530b3530e72",
"accountName": "Chase Checking ••4567",
"rail": "ach_standard"
},
"fiatDestination": "bank_account",
"fees": {
"amount": "1.25",
"currency": "USD"
},
"transaction": {
"hash": "0xabc123...",
"explorerUrl": "https://etherscan.io/tx/0xabc123..."
}
}{
"title": "Unauthorized",
"status": 401,
"type": "urn:problem-type:auth:unauthorized",
"detail": "Bearer token required",
"instance": "<string>",
"realm": "API",
"scope": "read:users"
}{
"title": "<string>",
"status": 404,
"resourceType": "user",
"resourceId": "<string>",
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}{
"title": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true,
"retryAfter": 5,
"suggestedAction": "auto_ramp",
"clearsAt": "2023-11-07T05:31:56Z",
"availableAt": "2023-11-07T05:31:56Z",
"permanent": true
}Get an off-ramp
Returns details for a specific off-ramp payment.
curl --request GET \
--url https://platform.spritz.finance/v1/off-ramps/{offRampId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/off-ramps/{offRampId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.spritz.finance/v1/off-ramps/{offRampId}', 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://platform.spritz.finance/v1/off-ramps/{offRampId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform.spritz.finance/v1/off-ramps/{offRampId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/off-ramps/{offRampId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/off-ramps/{offRampId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "6a99b80613a0c37251651788",
"quoteId": "6a99b7bacc18094dfe644ba6",
"status": "awaiting_funding",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"input": {
"amount": "0.25",
"token": "USDC",
"chain": "ethereum"
},
"output": {
"amount": "100.00",
"currency": "USD",
"accountId": "6a9fee5c215e5530b3530e72",
"accountName": "Chase Checking ••4567",
"rail": "ach_standard"
},
"fiatDestination": "bank_account",
"fees": {
"amount": "1.25",
"currency": "USD"
},
"transaction": {
"hash": "0xabc123...",
"explorerUrl": "https://etherscan.io/tx/0xabc123..."
}
}{
"title": "Unauthorized",
"status": 401,
"type": "urn:problem-type:auth:unauthorized",
"detail": "Bearer token required",
"instance": "<string>",
"realm": "API",
"scope": "read:users"
}{
"title": "<string>",
"status": 404,
"resourceType": "user",
"resourceId": "<string>",
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}{
"title": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true,
"retryAfter": 5,
"suggestedAction": "auto_ramp",
"clearsAt": "2023-11-07T05:31:56Z",
"availableAt": "2023-11-07T05:31:56Z",
"permanent": true
}Authorizations
User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.
Path Parameters
The off-ramp ID
"6a9fee5c215e5530b3530e7e"
Response
Response for status 200
Unique off-ramp identifier
"6a99b80613a0c37251651788"
The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote.
"6a99b7bacc18094dfe644ba6"
awaiting_funding, queued, in_flight, completed, canceled, failed, reversed, refunded When the off-ramp was completed. Null until status is completed.
What the user paid — crypto asset and chain.
Show child attributes
Show child attributes
What the destination receives — fiat delivery details.
Show child attributes
Show child attributes
Type of fiat destination.
bank_account: Bank account (includes debit card destinations).bill: Bill payment.crypto_card: Crypto card deposit.
bank_account, bill, crypto_card, null "bank_account"
Show child attributes
Show child attributes
Show child attributes
Show child attributes