Resolve an in-thread Apple Messages for Business checkout
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/amb-checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true
},
"config": {
"checkoutId": "<string>",
"hostedBaseUrl": "<string>",
"applePayEnabled": true,
"merchantIdentifier": "<string>",
"description": "<string>",
"reference": "<string>",
"expiresAt": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/amb-checkout"
payload = {
"order": {
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": True
},
"config": {
"checkoutId": "<string>",
"hostedBaseUrl": "<string>",
"applePayEnabled": True,
"merchantIdentifier": "<string>",
"description": "<string>",
"reference": "<string>",
"expiresAt": 123
}
}
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({
order: {
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>'
}
],
subtotal: 123,
currency: '<string>',
mixedCurrency: true
},
config: {
checkoutId: '<string>',
hostedBaseUrl: '<string>',
applePayEnabled: true,
merchantIdentifier: '<string>',
description: '<string>',
reference: '<string>',
expiresAt: 123
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/amb-checkout', 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/commerce/amb-checkout",
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([
'order' => [
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>'
]
],
'subtotal' => 123,
'currency' => '<string>',
'mixedCurrency' => true
],
'config' => [
'checkoutId' => '<string>',
'hostedBaseUrl' => '<string>',
'applePayEnabled' => true,
'merchantIdentifier' => '<string>',
'description' => '<string>',
'reference' => '<string>',
'expiresAt' => 123
]
]),
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/commerce/amb-checkout"
payload := strings.NewReader("{\n \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\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/commerce/amb-checkout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/amb-checkout")
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 \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"method": "<string>",
"currency": "<string>",
"subtotal": 123,
"paymentRequest": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"description": "<string>",
"reference": "<string>",
"checkoutUrl": "<string>",
"status": "pending",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}Commerce
Resolve an in-thread Apple Messages for Business checkout
Resolve native Apple Pay (where the tenant’s AMB agent is capability-enabled) or the hosted pay link, both anchored to one PaymentRequest snapshot.
POST
/
api
/
v1
/
commerce
/
amb-checkout
Resolve an in-thread Apple Messages for Business checkout
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/amb-checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true
},
"config": {
"checkoutId": "<string>",
"hostedBaseUrl": "<string>",
"applePayEnabled": true,
"merchantIdentifier": "<string>",
"description": "<string>",
"reference": "<string>",
"expiresAt": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/amb-checkout"
payload = {
"order": {
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": True
},
"config": {
"checkoutId": "<string>",
"hostedBaseUrl": "<string>",
"applePayEnabled": True,
"merchantIdentifier": "<string>",
"description": "<string>",
"reference": "<string>",
"expiresAt": 123
}
}
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({
order: {
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>'
}
],
subtotal: 123,
currency: '<string>',
mixedCurrency: true
},
config: {
checkoutId: '<string>',
hostedBaseUrl: '<string>',
applePayEnabled: true,
merchantIdentifier: '<string>',
description: '<string>',
reference: '<string>',
expiresAt: 123
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/amb-checkout', 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/commerce/amb-checkout",
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([
'order' => [
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>'
]
],
'subtotal' => 123,
'currency' => '<string>',
'mixedCurrency' => true
],
'config' => [
'checkoutId' => '<string>',
'hostedBaseUrl' => '<string>',
'applePayEnabled' => true,
'merchantIdentifier' => '<string>',
'description' => '<string>',
'reference' => '<string>',
'expiresAt' => 123
]
]),
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/commerce/amb-checkout"
payload := strings.NewReader("{\n \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\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/commerce/amb-checkout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/amb-checkout")
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 \"order\": {\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true\n },\n \"config\": {\n \"checkoutId\": \"<string>\",\n \"hostedBaseUrl\": \"<string>\",\n \"applePayEnabled\": true,\n \"merchantIdentifier\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"expiresAt\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"method": "<string>",
"currency": "<string>",
"subtotal": 123,
"paymentRequest": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"description": "<string>",
"reference": "<string>",
"checkoutUrl": "<string>",
"status": "pending",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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
BearerApiKey
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.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. 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.
Available options:
true, false Body
application/json