Cancel Quote Session
curl --request PUT \
--url https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel', 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://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel"
req, _ := http.NewRequest("PUT", 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.put("https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending",
"source": "NGN",
"destination": "USDT",
"chain": "BASE",
"amount": 50000,
"totalSourceAmount": 50000,
"totalDestinationAmount": 31.65,
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "live",
"ttl": 300,
"allocationResult": {
"totalSourceAmount": 50000,
"weightedAverageRate": 1580.5,
"totalDestinationAmount": 31.65,
"allocations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"poolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"poolAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allocatedAmount": 31.65,
"sourceAmount": 50000,
"rate": 1580.5,
"reference": "REF-001",
"metadata": {}
}
]
},
"metadata": {
"bankPayIn": {
"accountName": "Spotflow Ltd",
"accountNumber": "0123456789",
"bankName": "Access Bank",
"reference": "PAY-REF-001"
},
"cryptoPayIn": {
"addressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
"chain": "BASE",
"token": "USDT",
"addressType": "deposit",
"expectedAmount": 50000,
"externalReference": "<string>",
"status": "active",
"createdAt": "2026-04-01T10:55:46.254Z",
"expiresAt": "2026-04-01T10:55:46.256Z",
"virtualAccountId": "<string>",
"derivationIndex": 0,
"warningMessage": "<string>"
}
},
"chatMetadata": {
"conversationId": "<string>",
"chatQuoteId": "<string>",
"listingId": "<string>",
"initialListingRate": "<string>",
"negotiationStartedAt": "2023-11-07T05:31:56Z",
"quoteSentAt": "2023-11-07T05:31:56Z",
"acceptedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "INVALID_CURRENCY",
"message": "Invalid source currency. Supported: NGN, GHS",
"details": {}
}Exchange
Cancel Quote
Cancels an active or pending quote session. Once cancelled, the quote can no longer be accepted or completed.
PUT
/
partners
/
marketplace
/
quote
/
{id}
/
cancel
Cancel Quote Session
curl --request PUT \
--url https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel', 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://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel"
req, _ := http.NewRequest("PUT", 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.put("https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperrails.io/api/v1/partners/marketplace/quote/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending",
"source": "NGN",
"destination": "USDT",
"chain": "BASE",
"amount": 50000,
"totalSourceAmount": 50000,
"totalDestinationAmount": 31.65,
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "live",
"ttl": 300,
"allocationResult": {
"totalSourceAmount": 50000,
"weightedAverageRate": 1580.5,
"totalDestinationAmount": 31.65,
"allocations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"poolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"poolAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allocatedAmount": 31.65,
"sourceAmount": 50000,
"rate": 1580.5,
"reference": "REF-001",
"metadata": {}
}
]
},
"metadata": {
"bankPayIn": {
"accountName": "Spotflow Ltd",
"accountNumber": "0123456789",
"bankName": "Access Bank",
"reference": "PAY-REF-001"
},
"cryptoPayIn": {
"addressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
"chain": "BASE",
"token": "USDT",
"addressType": "deposit",
"expectedAmount": 50000,
"externalReference": "<string>",
"status": "active",
"createdAt": "2026-04-01T10:55:46.254Z",
"expiresAt": "2026-04-01T10:55:46.256Z",
"virtualAccountId": "<string>",
"derivationIndex": 0,
"warningMessage": "<string>"
}
},
"chatMetadata": {
"conversationId": "<string>",
"chatQuoteId": "<string>",
"listingId": "<string>",
"initialListingRate": "<string>",
"negotiationStartedAt": "2023-11-07T05:31:56Z",
"quoteSentAt": "2023-11-07T05:31:56Z",
"acceptedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "INVALID_CURRENCY",
"message": "Invalid source currency. Supported: NGN, GHS",
"details": {}
}Authorizations
API key authentication using Bearer token
Path Parameters
The unique identifier (UUID) of the quote to be cancelled.
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Response
Quote successfully cancelled
Unique quote identifier
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Quote status
Available options:
pending, awaiting_payment, completed, expired, cancelled Example:
"pending"
Source currency
Example:
"NGN"
Destination currency
Example:
"USDT"
Blockchain network
Example:
"BASE"
Requested amount
Example:
50000
Total amount in source currency
Example:
50000
Total amount in destination currency
Example:
31.65
Client identifier
Operating mode
Available options:
live, sandbox Example:
"live"
Time to live in seconds
Example:
300
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Metadata for chat-based quote negotiation
Show child attributes
Show child attributes
Was this page helpful?
⌘I