curl --request POST \
--url https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offers": [
{
"items": [
{
"productId": "<string>",
"quantity": 123,
"unitAmount": 123
}
],
"requestId": "<string>",
"paymentRail": "acp_stripe",
"buyer": {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"shippingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"billingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offers: [
{
items: [{productId: '<string>', quantity: 123, unitAmount: 123}],
requestId: '<string>',
paymentRail: 'acp_stripe',
buyer: {name: '<string>', email: 'jsmith@example.com', phone: '<string>'},
shippingAddress: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
},
billingAddress: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
}
}
]
})
};
fetch('https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation}"
payload = { "offers": [
{
"items": [
{
"productId": "<string>",
"quantity": 123,
"unitAmount": 123
}
],
"requestId": "<string>",
"paymentRail": "acp_stripe",
"buyer": {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"shippingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"billingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Manage customer-owned purchase offers
Operations
create: offers[] (1–5), with stable requestId, exact purchasable product/variant IDs, quantities, shipping country and optional unitAmount proposals. get/cancel: sessionIds[] (1–20). complete: sessionId, paymentProof, and buyer approval of cartVersion, totalAmount and currency. pay: sessionId and the same exact approval; returns checkoutUrl for Stripe-hosted card entry.
Results and safeguards
Batches return ordered per-target results, succeededCount and failedCount. At most ten unpaid offers may be held per customer. Merchant-approved currency, countries, shipping and tax terms are required. Shopify-listed products return the supported Shopify checkout handoff.
Payment
Completion reuses the existing Stripe ACP or x402 rail. Hosted card checkout requires this organization’s seller Stripe key and a public HTTPS webhook destination; signed Stripe events and a one-shot durable deadline use the same completion service. The page collects an address within the quoted country. Indeterminate confirmation remains payment_pending and blocks a new payment; x402 uncertainty requires merchant reconciliation. Direct creation honors configured bot verification. Payment completion does not book a carrier or establish delivery.
Signed offers and buyer agents
When the platform signing key is configured, payable offers include checkoutJwt: an ES256 JWT of the offer terms (merchant, cart_version, UCP line items and totals in minor units, expiry). Verify it with the /.well-known/ucp signing_keys entry named by its kid; it can serve as an AP2 checkout_jwt. Requests may carry a Web Bot Auth signature (Signature, Signature-Input and Signature-Agent headers); the verified agent origin is recorded on the offer and order.
curl --request POST \
--url https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offers": [
{
"items": [
{
"productId": "<string>",
"quantity": 123,
"unitAmount": 123
}
],
"requestId": "<string>",
"paymentRail": "acp_stripe",
"buyer": {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"shippingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"billingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offers: [
{
items: [{productId: '<string>', quantity: 123, unitAmount: 123}],
requestId: '<string>',
paymentRail: 'acp_stripe',
buyer: {name: '<string>', email: 'jsmith@example.com', phone: '<string>'},
shippingAddress: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
},
billingAddress: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
}
}
]
})
};
fetch('https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/embed/{deploymentId}/checkout-sessions/{operation}"
payload = { "offers": [
{
"items": [
{
"productId": "<string>",
"quantity": 123,
"unitAmount": 123
}
],
"requestId": "<string>",
"paymentRail": "acp_stripe",
"buyer": {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"shippingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"billingAddress": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
Customer session from /api/embed/{deploymentId}/session. Origin and deployment scope must match.
Path Parameters
create, get, cancel, complete, pay Body
- Option 1
- Option 2
- Option 3
- Option 4
1 - 5 elementsShow child attributes
Show child attributes
Response
Buyer-safe offers or completion result; costs, private metadata and payment proofs are excluded.