curl --request POST \
--url https://api.orbit.devotel.io/api/v1/billing/pay-by-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountMinor": 123,
"currency": "<string>",
"description": "<string>",
"preferredChannels": [],
"reachableChannels": [],
"successUrl": "<string>",
"cancelUrl": "<string>",
"conversationId": "<string>",
"contactId": "<string>",
"merchantName": "<string>",
"locale": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/billing/pay-by-link"
payload = {
"amountMinor": 123,
"currency": "<string>",
"description": "<string>",
"preferredChannels": [],
"reachableChannels": [],
"successUrl": "<string>",
"cancelUrl": "<string>",
"conversationId": "<string>",
"contactId": "<string>",
"merchantName": "<string>",
"locale": "<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({
amountMinor: 123,
currency: '<string>',
description: '<string>',
preferredChannels: [],
reachableChannels: [],
successUrl: '<string>',
cancelUrl: '<string>',
conversationId: '<string>',
contactId: '<string>',
merchantName: '<string>',
locale: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/billing/pay-by-link', 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.orbit.devotel.io/api/v1/billing/pay-by-link",
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([
'amountMinor' => 123,
'currency' => '<string>',
'description' => '<string>',
'preferredChannels' => [
],
'reachableChannels' => [
],
'successUrl' => '<string>',
'cancelUrl' => '<string>',
'conversationId' => '<string>',
'contactId' => '<string>',
'merchantName' => '<string>',
'locale' => '<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.orbit.devotel.io/api/v1/billing/pay-by-link"
payload := strings.NewReader("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<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.orbit.devotel.io/api/v1/billing/pay-by-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/billing/pay-by-link")
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 \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Create a pay-by-link request-to-pay
Mints a hosted checkout link for a one-off customer payment, picks the highest-priority delivery channel the contact is reachable on, and renders the request-to-pay message for that channel (SMS, RCS, WhatsApp, email, or voice). Nothing is sent here; the host carries the returned URL and rendered message into its own send pipeline. Payment settlement lands asynchronously on the checkout webhook. Owner, admin, or billing role required; the call is audit-logged. Returns 422 when the amount is below the provider’s minimum or no preferred channel is reachable.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/billing/pay-by-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountMinor": 123,
"currency": "<string>",
"description": "<string>",
"preferredChannels": [],
"reachableChannels": [],
"successUrl": "<string>",
"cancelUrl": "<string>",
"conversationId": "<string>",
"contactId": "<string>",
"merchantName": "<string>",
"locale": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/billing/pay-by-link"
payload = {
"amountMinor": 123,
"currency": "<string>",
"description": "<string>",
"preferredChannels": [],
"reachableChannels": [],
"successUrl": "<string>",
"cancelUrl": "<string>",
"conversationId": "<string>",
"contactId": "<string>",
"merchantName": "<string>",
"locale": "<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({
amountMinor: 123,
currency: '<string>',
description: '<string>',
preferredChannels: [],
reachableChannels: [],
successUrl: '<string>',
cancelUrl: '<string>',
conversationId: '<string>',
contactId: '<string>',
merchantName: '<string>',
locale: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/billing/pay-by-link', 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.orbit.devotel.io/api/v1/billing/pay-by-link",
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([
'amountMinor' => 123,
'currency' => '<string>',
'description' => '<string>',
'preferredChannels' => [
],
'reachableChannels' => [
],
'successUrl' => '<string>',
'cancelUrl' => '<string>',
'conversationId' => '<string>',
'contactId' => '<string>',
'merchantName' => '<string>',
'locale' => '<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.orbit.devotel.io/api/v1/billing/pay-by-link"
payload := strings.NewReader("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<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.orbit.devotel.io/api/v1/billing/pay-by-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/billing/pay-by-link")
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 \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"preferredChannels\": [],\n \"reachableChannels\": [],\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"merchantName\": \"<string>\",\n \"locale\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Body
Charge amount in the currency's minor units (e.g. cents). Minimum 50 — the payment provider's universal per-currency floor.
Three-letter ISO 4217 currency code.
What the payment is for; rendered into the request-to-pay message.
Delivery channels in descending priority order (cross-channel fallback).
sms, rcs, whatsapp, email, voice Channels the contact is currently reachable on.
sms, rcs, whatsapp, email, voice Post-payment redirect URL (trusted Orbit origin).
Redirect URL when the payment is abandoned (trusted Orbit origin).
Optional conversation id that links the payment back to a thread.
Optional contact id of the payer.
Optional merchant name rendered into the message (defaults to the org name).
Optional BCP-47 locale for the rendered message.
Response
Successful response.