List on-ramps
curl --request GET \
--url https://platform.spritz.finance/v1/on-ramps/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/on-ramps/"
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/on-ramps/', 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/on-ramps/",
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/on-ramps/"
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/on-ramps/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/on-ramps/")
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{
"data": [
{
"id": "onramp_xyz789",
"status": "awaiting_payment",
"createdAt": "2023-11-07T05:31:56Z",
"input": {
"amount": "5187.50",
"currency": "USD",
"rail": "ach_credit"
},
"fees": {
"amount": "59.60",
"currency": "USD, EUR",
"breakdown": {
"platform": "57.07",
"exchange": "2.53",
"network": "0.00"
}
},
"source": {
"depositId": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
"fundingSourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"
},
"output": {
"amount": "5130.43",
"token": "USDC",
"network": "ethereum",
"address": "0x742d35Cc...",
"txHash": "0xabc..."
},
"deliverySummary": {
"deliveredAmount": "40.00",
"confirmedAmount": "25.00",
"remainingAmount": "60.00"
},
"deliveries": [
{
"id": "release_abc123",
"status": "queued",
"amount": "25.00",
"amountUsd": "25.00",
"createdAt": "2023-11-07T05:31:56Z",
"txHash": "0xabc...",
"submittedAt": "2023-11-07T05:31:56Z",
"confirmedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
}
],
"completedAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "eyJpZCI6Im9ucmFtcF94eXo3ODkifQ=="
}{
"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
}On-Ramps
List on-ramps
Returns a paginated list of on-ramps for the authenticated user.
On-ramps represent fiat-to-crypto conversion transactions where fiat was sent and crypto was or will be received at a destination address.
Filtering:
network: Filter by blockchain network (ethereum, polygon, etc.)token: Filter by output token (case-insensitive, e.g., “usdc”)address: Filter by payout address
Sorting:
sort=desc(default): Newest firstsort=asc: Oldest first
Pagination:
Use cursor-based pagination with the cursor parameter.
GET
/
v1
/
on-ramps
/
List on-ramps
curl --request GET \
--url https://platform.spritz.finance/v1/on-ramps/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/on-ramps/"
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/on-ramps/', 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/on-ramps/",
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/on-ramps/"
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/on-ramps/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/on-ramps/")
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{
"data": [
{
"id": "onramp_xyz789",
"status": "awaiting_payment",
"createdAt": "2023-11-07T05:31:56Z",
"input": {
"amount": "5187.50",
"currency": "USD",
"rail": "ach_credit"
},
"fees": {
"amount": "59.60",
"currency": "USD, EUR",
"breakdown": {
"platform": "57.07",
"exchange": "2.53",
"network": "0.00"
}
},
"source": {
"depositId": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
"fundingSourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"
},
"output": {
"amount": "5130.43",
"token": "USDC",
"network": "ethereum",
"address": "0x742d35Cc...",
"txHash": "0xabc..."
},
"deliverySummary": {
"deliveredAmount": "40.00",
"confirmedAmount": "25.00",
"remainingAmount": "60.00"
},
"deliveries": [
{
"id": "release_abc123",
"status": "queued",
"amount": "25.00",
"amountUsd": "25.00",
"createdAt": "2023-11-07T05:31:56Z",
"txHash": "0xabc...",
"submittedAt": "2023-11-07T05:31:56Z",
"confirmedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
}
],
"completedAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "eyJpZCI6Im9ucmFtcF94eXo3ODkifQ=="
}{
"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
bearerAuthintegratorJwtbearerAuth & hmacAuth & integratorKey & timestamp
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.
Query Parameters
Maximum number of results to return
Required range:
1 <= x <= 100Opaque cursor for pagination. Use the nextCursor value from the previous response.
Available options:
ethereum, polygon, base, arbitrum, avalanche, optimism, solana, tron, bitcoin Filter by output token. Case-insensitive (transformed to uppercase).
Maximum string length:
10Example:
"USDC"
Filter by payout address
Maximum string length:
256Example:
"0x742d35Cc6634C0532925a3b844Bc9e7595f..."
Available options:
desc, asc