Create payment
curl --request POST \
--url https://api.onstacks.io/v1/ramp/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_asset": "USDC",
"source_amount": "1000000",
"destination_asset": "NGN",
"country_code": "NG",
"destination": {},
"source_network": "base",
"destination_network": "<string>",
"metadata": {},
"idempotency_key": "<string>"
}
'import requests
url = "https://api.onstacks.io/v1/ramp/payments"
payload = {
"source_asset": "USDC",
"source_amount": "1000000",
"destination_asset": "NGN",
"country_code": "NG",
"destination": {},
"source_network": "base",
"destination_network": "<string>",
"metadata": {},
"idempotency_key": "<string>"
}
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({
source_asset: 'USDC',
source_amount: '1000000',
destination_asset: 'NGN',
country_code: 'NG',
destination: {},
source_network: 'base',
destination_network: '<string>',
metadata: {},
idempotency_key: '<string>'
})
};
fetch('https://api.onstacks.io/v1/ramp/payments', 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.onstacks.io/v1/ramp/payments",
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([
'source_asset' => 'USDC',
'source_amount' => '1000000',
'destination_asset' => 'NGN',
'country_code' => 'NG',
'destination' => [
],
'source_network' => 'base',
'destination_network' => '<string>',
'metadata' => [
],
'idempotency_key' => '<string>'
]),
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.onstacks.io/v1/ramp/payments"
payload := strings.NewReader("{\n \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\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.onstacks.io/v1/ramp/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onstacks.io/v1/ramp/payments")
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 \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference": "<string>",
"status": "pending",
"direction": "on_ramp",
"rail": "bank",
"provider": "<string>",
"provider_reference": "<string>",
"quote_reference": "<string>",
"source": {
"amount": "1000000",
"asset": "USDC",
"network": "base"
},
"destination_amount": {
"amount": "1000000",
"asset": "USDC",
"network": "base"
},
"destination": {
"bank_account": {
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"bank_name": "<string>",
"iban": "<string>",
"swift_code": "<string>",
"sort_code": "<string>",
"routing_number": "<string>",
"account_type": "<string>",
"beneficiary": {
"email": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
}
},
"mobile_money": {
"phone_number": "<string>",
"provider_code": "<string>",
"country_code": "<string>",
"account_name": "<string>",
"currency_code": "<string>"
},
"wallet": {
"address": "<string>",
"network": "base",
"memo": "<string>"
}
},
"funding_instructions": {},
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"error": null,
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}Create payment
Create a payment without quoting first. Onstacks selects the provider. Idempotent on idempotency_key.
POST
https://api.onstacks.io
/
v1
/
ramp
/
payments
Create payment
curl --request POST \
--url https://api.onstacks.io/v1/ramp/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_asset": "USDC",
"source_amount": "1000000",
"destination_asset": "NGN",
"country_code": "NG",
"destination": {},
"source_network": "base",
"destination_network": "<string>",
"metadata": {},
"idempotency_key": "<string>"
}
'import requests
url = "https://api.onstacks.io/v1/ramp/payments"
payload = {
"source_asset": "USDC",
"source_amount": "1000000",
"destination_asset": "NGN",
"country_code": "NG",
"destination": {},
"source_network": "base",
"destination_network": "<string>",
"metadata": {},
"idempotency_key": "<string>"
}
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({
source_asset: 'USDC',
source_amount: '1000000',
destination_asset: 'NGN',
country_code: 'NG',
destination: {},
source_network: 'base',
destination_network: '<string>',
metadata: {},
idempotency_key: '<string>'
})
};
fetch('https://api.onstacks.io/v1/ramp/payments', 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.onstacks.io/v1/ramp/payments",
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([
'source_asset' => 'USDC',
'source_amount' => '1000000',
'destination_asset' => 'NGN',
'country_code' => 'NG',
'destination' => [
],
'source_network' => 'base',
'destination_network' => '<string>',
'metadata' => [
],
'idempotency_key' => '<string>'
]),
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.onstacks.io/v1/ramp/payments"
payload := strings.NewReader("{\n \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\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.onstacks.io/v1/ramp/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onstacks.io/v1/ramp/payments")
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 \"source_asset\": \"USDC\",\n \"source_amount\": \"1000000\",\n \"destination_asset\": \"NGN\",\n \"country_code\": \"NG\",\n \"destination\": {},\n \"source_network\": \"base\",\n \"destination_network\": \"<string>\",\n \"metadata\": {},\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference": "<string>",
"status": "pending",
"direction": "on_ramp",
"rail": "bank",
"provider": "<string>",
"provider_reference": "<string>",
"quote_reference": "<string>",
"source": {
"amount": "1000000",
"asset": "USDC",
"network": "base"
},
"destination_amount": {
"amount": "1000000",
"asset": "USDC",
"network": "base"
},
"destination": {
"bank_account": {
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"bank_name": "<string>",
"iban": "<string>",
"swift_code": "<string>",
"sort_code": "<string>",
"routing_number": "<string>",
"account_type": "<string>",
"beneficiary": {
"email": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
}
},
"mobile_money": {
"phone_number": "<string>",
"provider_code": "<string>",
"country_code": "<string>",
"account_name": "<string>",
"currency_code": "<string>"
},
"wallet": {
"address": "<string>",
"network": "base",
"memo": "<string>"
}
},
"funding_instructions": {},
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"error": null,
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}Authorizations
Workspace API key. Send it as Authorization: Bearer <api_key>.
Query Parameters
Environment scope for environment-partitioned resources. Defaults to sandbox when omitted.
Available options:
sandbox, live Body
application/json
Direct payment: Onstacks selects the provider. Use the quote flow when you want to show options first.
Available options:
on_ramp, off_ramp Example:
"USDC"
Example:
"1000000"
Example:
"NGN"
Example:
"NG"
Available options:
bank, mobile_money, wallet, ach, wire, sepa, faster_payments, interac Exactly one of the destination types must be set, matching the rail.
Show child attributes
Show child attributes
Optional. When omitted Onstacks chooses the network for the transaction.
Example:
"base"
For on-ramps, the network to deliver the stablecoin on. Optional.