API Pay
Current reading — 2026-10-17 [D]. This page retains an older paid-endpoint
API Pay design inside planned Skyzai Work composition. Its wedge, pricing,
settlement and OFN issuance examples are proposals, not an independent
operating SKU or public API. LIQUID owns payment and transaction semantics;
OFN separately owns economic receipt issuance. The current
usage-pricing direction is a proposed commercial
interface, and the separate historical API PAY payroll name does not create
a payment rail. Linked routes are compatibility coordinates, not deployment
proof.
Status: pre-launch. This page describes target design; this document does not establish a deployed service.
Scope: proposed paid-endpoint capability for the planned Skyzai Work app package, with Personal use requiring its own product and permission contract. The app packages are not additional product owners. See The Product Family.
Surface: api-pay.skyzai.com (declarative)
Docs: API Pay reference (public documentation; not a live service)
Status: HISTORICAL LOCAL-PROOF CLAIM · current integration unaccepted
Evidence tier: [D] for this public proposal. An older [B] claim describes
one local loop but has no linked current, reproducible OFN issuance proof here;
[E] requires independent measurement, accepted integration and exact-act authority.
Canonical manifest: (private, unpublished)
What API Pay Is
The retained proposal explores a paid endpoint that could be independently consumed without adopting a whole app. It sketches five separate steps:
- Quote — returns the price for the paid action
- 402 Gate — rejects with
402 Payment Requiredif entitlement insufficient - Payment evidence — checks an actual payment rail and settlement state
- OFN receipt — requests an economic receipt from an authorised issuer only when its required facts exist
- Finance export — exports accepted, typed records to an authorised controls stack
Independent use is an intended composability test, not a verified customer offering. A quote, local JSON record or 402 response proves neither payment nor OFN issuance.
Architecture
Conceptual target flow only. It does not establish an implemented settlement rail, admitted issuer or production export.
Client request -> proposed quote -> eligibility and exact-act authority
-> permitted payment rail -> independent settlement evidence
-> separately owned OFN issuer, if economic fields are complete
-> typed economic receipt -> separately authorised finance export
API Specification
Illustrative, unpublished request and response shapes follow. The URLs, IDs, prices, transaction hashes and success response are synthetic; no accepted public endpoint or OFN-issued receipt is established by this example.
POST /v1/quote
Returns a quote for the paid action.
Request:
{
"endpoint": "swap",
"params": {
"from": "USDC",
"to": "ETH",
"amount": "100.00"
},
"buyer_id": "org_abc123"
}
Response:
{
"quote_id": "qt_20260509_001",
"price": {
"amount": "0.5",
"currency": "USDC",
" Breakdown": {
"service_fee": "0.02",
"gas_estimate": "0.48"
}
},
"expires_at": "2026-05-09T12:05:00Z",
"status": "valid"
}
POST /v1/pay
Executes the paid action after entitlement check.
Request:
{
"quote_id": "qt_20260509_001",
"buyer_id": "org_abc123",
"payment_tx": "0xabc...",
"authorization_receipt": "receipt:..."
}
Illustrative target response after independently verified settlement and issuance:
{
"receipt_id": "ofn:2026:abc123...",
"status": "settled",
"tx_hash": "0xabc...",
"timestamp": "2026-05-09T12:00:00Z"
}
Response (insufficient entitlement):
402 Payment Required
{
"error": "INSUFFICIENT_ENTITLEMENT",
"message": "Buyer entitlement insufficient for this action.",
"upgrade_url": "`https://skyzai.com/products/api-pay`"
}
Evidence Tiers
Ladder per 14-evidence-tiers.md ([C] < [D] < [S] < [B] < [E]):
| Tier | Claim | Required Evidence |
|---|---|---|
| [D] | API Pay can wrap one endpoint | Design document, API spec |
| [B] | A bounded local paid-endpoint loop can emit a typed synthetic record | Dated local integration run, reproducible steps; this is not OFN issuance |
| [E] | External customer paid for API Pay service | Independent settlement proof, typed external authority, and live-environment measurement |
The older page classified one local loop as [B]. Its exact source and issuer acceptance are not linked here, so the current public integration claim remains [D]. An independently verified settlement and OFN-issued receipt would need their own evidence; a local run never promotes the system.
Integration Guide
The following is design pseudocode, not an installable SDK or live webhook configuration.
Quick Start (Python)
from skyzai import APIPayClient
client = APIPayClient(api_key="your_key")
# Get quote
quote = client.quote(endpoint="swap", params={"from": "USDC", "to": "ETH", "amount": "100"})
# Execute (requires typed authority; a public DAV uses a valid PRISM receipt)
receipt = client.pay(
quote_id=quote.id,
payment_tx="0x...",
authorization_receipt="receipt:..."
)
print(receipt.id) # ofn:2026:...
Webhook
Configure webhooks for settlement events:
client.webhooks.create(
url="https://your-domain.com/webhooks/skyzai",
events=["settlement.confirmed", "settlement.failed", "receipt.emitted"]
)
Security
These safeguards are design requirements, not evidence that a public payment endpoint enforces them today.
- Typed authority: High-value acts require the lawful executor and authorization receipt appropriate to the acting Person; every exact public-DAV consequence requires a complete valid bound PRISM decision receipt from the signer(s) required by applicable law, the entity's governing instrument, or a valid competent mandate binding that exact consequence; PRISM verifies only
- Constraint gate: A proposed check may HOLD, RETURN or produce a non-authorising PASS; it does not supply the legal authority to execute.
- Replay Protection: Nonce-based replay protection on all payment transactions
- Timelock: 24-hour timelock on settlement execution (configurable per contract)
η = 0 Compliance
This retained charge classification is a proposal, not an accepted tariff or statement of what an external rail charges.
| Chargeable | Not Chargeable |
|---|---|
| Software development | Settlement access |
| Integration services | DLT rail usage |
| Dashboards and analytics | Chain gas fees (pass-through) |
| Support and SLA | Sovereignty or exit |
Cross-links
- Product page:
/products/api-pay/ - Buyer deck:
/products/api-pay/deck/ - Resource room:
/products/api-pay/resources/ - Access form:
/products/api-pay/access/ - Adjacent canon: OFN Receipts (P1), Wallet Boundaries (P3)
- Source markdown: (private, unpublished)
Refer to the canonical
WEBSITE.mdsource for complete product spec. This wiki page exists so the.com→.orgbidirectional pair resolves cleanly.
See Also
API Pay — Commercial page- OFN Receipts — Technical docs
- Wallet Boundaries — Technical docs
- Gate-service implementation code (private, unpublished)
- FlowWallet contract code (private, unpublished)