Execute an offramp
curl --request POST \
--url https://api.globalstack.io/v1/offramps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quote_id": "<string>",
"reference": "<string>",
"source_currency": "<string>",
"destination_currency": "<string>",
"metadata": {}
}
'import requests
url = "https://api.globalstack.io/v1/offramps"
payload = {
"quote_id": "<string>",
"reference": "<string>",
"source_currency": "<string>",
"destination_currency": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quote_id: '<string>',
reference: '<string>',
source_currency: '<string>',
destination_currency: '<string>',
metadata: {}
})
};
fetch('https://api.globalstack.io/v1/offramps', 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.globalstack.io/v1/offramps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quote_id' => '<string>',
'reference' => '<string>',
'source_currency' => '<string>',
'destination_currency' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.globalstack.io/v1/offramps"
payload := strings.NewReader("{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.globalstack.io/v1/offramps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.globalstack.io/v1/offramps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Offramp executed successfully",
"code": "ok",
"data": {
"id": "ofr_01KPBH887CCT3A53EW3F8R0VQG",
"reference": "INV-2026-001",
"status": "created",
"retry_on_failure": false,
"quote_id": "quo_01KPBK123456789ABCDEFG",
"rate_source": "quoted",
"customer": {
"id": "cust_seed_alice",
"type": "individual",
"name": "Alice Johnson",
"email": "alice.seed@globalstack.mock",
"tier": "tier_2",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z"
},
"wallet": {
"id": "wal_seed_alice_usdc",
"currency": "USDC",
"label": "USDC Wallet"
},
"beneficiary": {
"id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
"customer_id": "cust_01HXYZABC1234567890ABCDEFG",
"name": "Alice Bank Beneficiary",
"type": "fiat",
"currency": "NGN",
"details": {
"country_code": "NG",
"network": "bank",
"account_number": "0039415616",
"provider": {
"id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
"name": "Access Bank",
"code": "000014"
},
"account_name": "ALICE JOHNSON"
},
"metadata": {},
"status": "pending",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z",
"label": "Alice's salary account",
"merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
},
"payment_instrument": {
"id": "pay_01KPBH895W6PH3WY1D9KZH3M5D",
"beneficiary_id": "ben_seed_alice_bank",
"type": "bank_account",
"country_code": "NG",
"provider": {
"id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
"name": "Access Bank",
"code": "000014"
},
"account_name": "SEED BANK BENEFICIARY",
"account_number": "0039415616"
},
"source_amount": "1.000000",
"source_currency": "USDC",
"destination_currency": "NGN",
"rate": "0.000000",
"rate_locked_until": "2026-04-16T16:46:07.000Z",
"metadata": {},
"created_at": "2026-04-16T16:16:12.000Z",
"updated_at": "2026-04-16T16:16:13.000Z",
"narration": "Payment for Invoice INV-2026-001",
"destination_amount": "0.00",
"failure_reason": null,
"failure_reason_message": null
},
"meta": {
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}Offramps
Execute an offramp
Execute a previously created offramp quote: pays out the quote’s source crypto to the quote’s fiat beneficiary.
Submit the quote_id returned by POST /v1/offramps/quotes. source_currency and
destination_currency are optional; when supplied they must match the quote’s
currencies exactly, otherwise the request is rejected with 400 invalid_input.
reference is your idempotency reference and must be unique within your integration.
An expired quote returns 409 invalid_status. A given quote can be
executed only once; a second execute returns 409 duplicate_resource.
The offramp is created in the created state and advances asynchronously
(created → processing → success/failed). Send an Idempotency-Key header
to make retries safe.
POST
/
v1
/
offramps
Execute an offramp
curl --request POST \
--url https://api.globalstack.io/v1/offramps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quote_id": "<string>",
"reference": "<string>",
"source_currency": "<string>",
"destination_currency": "<string>",
"metadata": {}
}
'import requests
url = "https://api.globalstack.io/v1/offramps"
payload = {
"quote_id": "<string>",
"reference": "<string>",
"source_currency": "<string>",
"destination_currency": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quote_id: '<string>',
reference: '<string>',
source_currency: '<string>',
destination_currency: '<string>',
metadata: {}
})
};
fetch('https://api.globalstack.io/v1/offramps', 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.globalstack.io/v1/offramps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quote_id' => '<string>',
'reference' => '<string>',
'source_currency' => '<string>',
'destination_currency' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.globalstack.io/v1/offramps"
payload := strings.NewReader("{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.globalstack.io/v1/offramps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.globalstack.io/v1/offramps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quote_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"source_currency\": \"<string>\",\n \"destination_currency\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Offramp executed successfully",
"code": "ok",
"data": {
"id": "ofr_01KPBH887CCT3A53EW3F8R0VQG",
"reference": "INV-2026-001",
"status": "created",
"retry_on_failure": false,
"quote_id": "quo_01KPBK123456789ABCDEFG",
"rate_source": "quoted",
"customer": {
"id": "cust_seed_alice",
"type": "individual",
"name": "Alice Johnson",
"email": "alice.seed@globalstack.mock",
"tier": "tier_2",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z"
},
"wallet": {
"id": "wal_seed_alice_usdc",
"currency": "USDC",
"label": "USDC Wallet"
},
"beneficiary": {
"id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
"customer_id": "cust_01HXYZABC1234567890ABCDEFG",
"name": "Alice Bank Beneficiary",
"type": "fiat",
"currency": "NGN",
"details": {
"country_code": "NG",
"network": "bank",
"account_number": "0039415616",
"provider": {
"id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
"name": "Access Bank",
"code": "000014"
},
"account_name": "ALICE JOHNSON"
},
"metadata": {},
"status": "pending",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z",
"label": "Alice's salary account",
"merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
},
"payment_instrument": {
"id": "pay_01KPBH895W6PH3WY1D9KZH3M5D",
"beneficiary_id": "ben_seed_alice_bank",
"type": "bank_account",
"country_code": "NG",
"provider": {
"id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
"name": "Access Bank",
"code": "000014"
},
"account_name": "SEED BANK BENEFICIARY",
"account_number": "0039415616"
},
"source_amount": "1.000000",
"source_currency": "USDC",
"destination_currency": "NGN",
"rate": "0.000000",
"rate_locked_until": "2026-04-16T16:46:07.000Z",
"metadata": {},
"created_at": "2026-04-16T16:16:12.000Z",
"updated_at": "2026-04-16T16:16:13.000Z",
"narration": "Payment for Invoice INV-2026-001",
"destination_amount": "0.00",
"failure_reason": null,
"failure_reason_message": null
},
"meta": {
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}Authorizations
API key issued during merchant onboarding.
Headers
Optional client-supplied key. Identical key + identical body within 24h replays the original response. Identical key + different body returns 409 idempotency_conflict. The hash is over raw bytes — clients retrying must send the byte-identical body; a re-serialised JSON payload will produce a different hash and a 409. Strongly recommended for retry-safe clients.
Pattern:
^[A-Za-z0-9_\-]{8,255}$Body
application/json
ExecuteOfframpDto
Response
Offramp executed successfully
⌘I