Create a PayOrder
curl --request POST \
--url https://api.coinvoyage.io/v2/pay-orders \
--header 'Authorization-Signature: <authorization-signature>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"intent": {
"amount": {
"fiat": {
"amount": 100,
"unit": "USD"
},
"token_amount": 100
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
},
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "SALE"
}
'import requests
url = "https://api.coinvoyage.io/v2/pay-orders"
payload = {
"intent": {
"amount": {
"fiat": {
"amount": 100,
"unit": "USD"
},
"token_amount": 100
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
},
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "SALE"
}
headers = {
"X-API-KEY": "<api-key>",
"Authorization-Signature": "<authorization-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'Authorization-Signature': '<authorization-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
intent: {
amount: {fiat: {amount: 100, unit: 'USD'}, token_amount: 100},
asset: {
address: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
chain_id: 30000000000001
},
receiving_address: '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM'
},
metadata: {
items: [
{
currency: 'USD',
description: 'High-quality widget with extra features',
image: 'https://example.com/images/widget.png',
name: 'Premium Widget',
quantity: 2,
unit_price: 49.99
}
],
refund: {
additional_info: 'Item was never shipped',
currency: 'USD',
name: 'Order Cancellation',
reason: 'Customer requested refund',
refund_amount: 99.98
}
},
mode: 'SALE'
})
};
fetch('https://api.coinvoyage.io/v2/pay-orders', 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.coinvoyage.io/v2/pay-orders",
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([
'intent' => [
'amount' => [
'fiat' => [
'amount' => 100,
'unit' => 'USD'
],
'token_amount' => 100
],
'asset' => [
'address' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
'chain_id' => 30000000000001
],
'receiving_address' => '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM'
],
'metadata' => [
'items' => [
[
'currency' => 'USD',
'description' => 'High-quality widget with extra features',
'image' => 'https://example.com/images/widget.png',
'name' => 'Premium Widget',
'quantity' => 2,
'unit_price' => 49.99
]
],
'refund' => [
'additional_info' => 'Item was never shipped',
'currency' => 'USD',
'name' => 'Order Cancellation',
'reason' => 'Customer requested refund',
'refund_amount' => 99.98
]
],
'mode' => 'SALE'
]),
CURLOPT_HTTPHEADER => [
"Authorization-Signature: <authorization-signature>",
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.coinvoyage.io/v2/pay-orders"
payload := strings.NewReader("{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Authorization-Signature", "<authorization-signature>")
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.coinvoyage.io/v2/pay-orders")
.header("X-API-KEY", "<api-key>")
.header("Authorization-Signature", "<authorization-signature>")
.header("Content-Type", "application/json")
.body("{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coinvoyage.io/v2/pay-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization-Signature"] = '<authorization-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-01-01T00:00:00Z",
"fulfillment": {
"amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001,
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"swap": {
"requested_destination_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"requested_source_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
}
}
},
"hosted_url": "https://pay.coinvoyage.io/pay/cuidjkhg3e289y74u5t6v",
"id": "cuidjkhg3e289y74u5t6v",
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "DEPOSIT",
"organization_id": "org_1234567890abcdef",
"payment": {
"destination_tx_hash": "0x5678...efgh",
"dst": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"estimated_duration_seconds": 120,
"expires_at": "2025-11-03T12:30:00Z",
"fee_tx_hash": "0xfee1...fee2",
"payment_rail": "CRYPTO",
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
"refund_tx_hash": "0x9abc...ijkl",
"refunded_reason": "execution failed: provider error",
"source_tx_hash": "0x1234...abcd",
"src": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"base": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"fees": {
"custom_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"protocol_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"relayer_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"total_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"gas": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC",
"total": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"steps": [
{
"deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
"kind": "deposit",
"rail": "CRYPTO"
}
]
},
"settings": {
"hide_footer": true,
"logo_url": "https://example.com/logo.png",
"theme_color": "#000000"
},
"status": "PENDING",
"updated_at": "2023-01-01T00:00:00Z"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}pay-orders
Create a PayOrder
Create a new PayOrder for cryptocurrency payment processing. SALE mode requires an Authorization signature; other modes accept either X-API-KEY or Authorization.
POST
/
pay-orders
Create a PayOrder
curl --request POST \
--url https://api.coinvoyage.io/v2/pay-orders \
--header 'Authorization-Signature: <authorization-signature>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"intent": {
"amount": {
"fiat": {
"amount": 100,
"unit": "USD"
},
"token_amount": 100
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
},
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "SALE"
}
'import requests
url = "https://api.coinvoyage.io/v2/pay-orders"
payload = {
"intent": {
"amount": {
"fiat": {
"amount": 100,
"unit": "USD"
},
"token_amount": 100
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
},
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "SALE"
}
headers = {
"X-API-KEY": "<api-key>",
"Authorization-Signature": "<authorization-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'Authorization-Signature': '<authorization-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
intent: {
amount: {fiat: {amount: 100, unit: 'USD'}, token_amount: 100},
asset: {
address: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
chain_id: 30000000000001
},
receiving_address: '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM'
},
metadata: {
items: [
{
currency: 'USD',
description: 'High-quality widget with extra features',
image: 'https://example.com/images/widget.png',
name: 'Premium Widget',
quantity: 2,
unit_price: 49.99
}
],
refund: {
additional_info: 'Item was never shipped',
currency: 'USD',
name: 'Order Cancellation',
reason: 'Customer requested refund',
refund_amount: 99.98
}
},
mode: 'SALE'
})
};
fetch('https://api.coinvoyage.io/v2/pay-orders', 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.coinvoyage.io/v2/pay-orders",
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([
'intent' => [
'amount' => [
'fiat' => [
'amount' => 100,
'unit' => 'USD'
],
'token_amount' => 100
],
'asset' => [
'address' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
'chain_id' => 30000000000001
],
'receiving_address' => '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM'
],
'metadata' => [
'items' => [
[
'currency' => 'USD',
'description' => 'High-quality widget with extra features',
'image' => 'https://example.com/images/widget.png',
'name' => 'Premium Widget',
'quantity' => 2,
'unit_price' => 49.99
]
],
'refund' => [
'additional_info' => 'Item was never shipped',
'currency' => 'USD',
'name' => 'Order Cancellation',
'reason' => 'Customer requested refund',
'refund_amount' => 99.98
]
],
'mode' => 'SALE'
]),
CURLOPT_HTTPHEADER => [
"Authorization-Signature: <authorization-signature>",
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.coinvoyage.io/v2/pay-orders"
payload := strings.NewReader("{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Authorization-Signature", "<authorization-signature>")
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.coinvoyage.io/v2/pay-orders")
.header("X-API-KEY", "<api-key>")
.header("Authorization-Signature", "<authorization-signature>")
.header("Content-Type", "application/json")
.body("{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coinvoyage.io/v2/pay-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization-Signature"] = '<authorization-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intent\": {\n \"amount\": {\n \"fiat\": {\n \"amount\": 100,\n \"unit\": \"USD\"\n },\n \"token_amount\": 100\n },\n \"asset\": {\n \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n \"chain_id\": 30000000000001\n },\n \"receiving_address\": \"9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM\"\n },\n \"metadata\": {\n \"items\": [\n {\n \"currency\": \"USD\",\n \"description\": \"High-quality widget with extra features\",\n \"image\": \"https://example.com/images/widget.png\",\n \"name\": \"Premium Widget\",\n \"quantity\": 2,\n \"unit_price\": 49.99\n }\n ],\n \"refund\": {\n \"additional_info\": \"Item was never shipped\",\n \"currency\": \"USD\",\n \"name\": \"Order Cancellation\",\n \"reason\": \"Customer requested refund\",\n \"refund_amount\": 99.98\n }\n },\n \"mode\": \"SALE\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-01-01T00:00:00Z",
"fulfillment": {
"amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001,
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"swap": {
"requested_destination_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"requested_source_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
}
}
},
"hosted_url": "https://pay.coinvoyage.io/pay/cuidjkhg3e289y74u5t6v",
"id": "cuidjkhg3e289y74u5t6v",
"metadata": {
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
},
"mode": "DEPOSIT",
"organization_id": "org_1234567890abcdef",
"payment": {
"destination_tx_hash": "0x5678...efgh",
"dst": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"estimated_duration_seconds": 120,
"expires_at": "2025-11-03T12:30:00Z",
"fee_tx_hash": "0xfee1...fee2",
"payment_rail": "CRYPTO",
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
"refund_tx_hash": "0x9abc...ijkl",
"refunded_reason": "execution failed: provider error",
"source_tx_hash": "0x1234...abcd",
"src": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"base": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"fees": {
"custom_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"protocol_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"relayer_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"total_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"gas": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC",
"total": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"steps": [
{
"deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
"kind": "deposit",
"rail": "CRYPTO"
}
]
},
"settings": {
"hide_footer": true,
"logo_url": "https://example.com/logo.png",
"theme_color": "#000000"
},
"status": "PENDING",
"updated_at": "2023-01-01T00:00:00Z"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}{
"code": 400,
"error": "Bad Request",
"message": "Invalid request parameters"
}Authorizations
Headers
API key for authentication
Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'
Body
application/json
Available options:
SALE, DEPOSIT Example:
"SALE"
Show child attributes
Show child attributes
Example:
{
"amount": {
"fiat": { "amount": 100, "unit": "USD" },
"token_amount": 100
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
}
Show child attributes
Show child attributes
Example:
{
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
}
Response
PayOrder created successfully
Example:
"cuidjkhg3e289y74u5t6v"
Example:
"2023-01-01T00:00:00Z"
Example:
"2023-01-01T00:00:00Z"
Example:
"org_1234567890abcdef"
Available options:
SALE, DEPOSIT, REFUND, SWAP, FEE_CLAIM Example:
"DEPOSIT"
Available options:
PENDING, EXPIRED, FAILED, AWAITING_PAYMENT, OPTIMISTIC_CONFIRMED, AWAITING_CONFIRMATION, EXECUTING_ORDER, COMPLETED, REFUNDED, PARTIAL_PAYMENT Example:
"PENDING"
Show child attributes
Show child attributes
Example:
{
"amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"asset": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001,
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"swap": {
"requested_destination_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
},
"requested_source_currency": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"chain_id": 30000000000001
}
}
}
Example:
"https://pay.coinvoyage.io/pay/cuidjkhg3e289y74u5t6v"
Show child attributes
Show child attributes
Example:
{
"destination_tx_hash": "0x5678...efgh",
"dst": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC"
},
"estimated_duration_seconds": 120,
"expires_at": "2025-11-03T12:30:00Z",
"fee_tx_hash": "0xfee1...fee2",
"payment_rail": "CRYPTO",
"receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
"refund_tx_hash": "0x9abc...ijkl",
"refunded_reason": "execution failed: provider error",
"source_tx_hash": "0x1234...abcd",
"src": {
"address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"amount_out_minimum": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"base": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"chain_id": 30000000000001,
"currency_amount": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"decimals": 6,
"fees": {
"custom_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"protocol_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"relayer_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"total_fee": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"gas": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
},
"id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
"name": "USD Coin",
"price_usd": 1,
"ticker": "USDC",
"total": {
"raw_amount": "2400000",
"ui_amount": 2.4,
"ui_amount_display": "2.4",
"value_usd": 123.45
}
},
"steps": [
{
"deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
"kind": "deposit",
"rail": "CRYPTO"
}
]
}
Show child attributes
Show child attributes
Example:
{
"items": [
{
"currency": "USD",
"description": "High-quality widget with extra features",
"image": "https://example.com/images/widget.png",
"name": "Premium Widget",
"quantity": 2,
"unit_price": 49.99
}
],
"refund": {
"additional_info": "Item was never shipped",
"currency": "USD",
"name": "Order Cancellation",
"reason": "Customer requested refund",
"refund_amount": 99.98
}
}
Widget/client UI settings configured on the organization. Known fields are documented here; arbitrary extra JSON settings are also allowed.
Show child attributes
Show child attributes
Example:
{
"hide_footer": true,
"logo_url": "https://example.com/logo.png",
"theme_color": "#000000"
}
Was this page helpful?
⌘I