{"id":6,"date":"2026-09-25T10:26:31","date_gmt":"2026-09-25T10:26:31","guid":{"rendered":"https:\/\/demos.canvaswp.com\/ai-payments\/docs\/"},"modified":"2026-10-01T08:57:50","modified_gmt":"2026-10-01T08:57:50","slug":"docs","status":"publish","type":"page","link":"https:\/\/demos.canvaswp.com\/ai-payments\/docs\/","title":{"rendered":"Docs"},"content":{"rendered":"
\n
\n
\n
\n

Quick start<\/p>\n

Your first card
in minutes<\/em><\/h2>\n

Install an SDK, create an API key and issue a single-use card from code. The same steps work in any agent framework.<\/p>\n

\n
<\/i> Install the Node or Python SDK<\/div>\n
<\/i> Create an API key in the dashboard<\/div>\n
<\/i> Issue a single-use card from code<\/div>\n
<\/i> Listen for the card.charged webhook<\/div>\n<\/div>\n
\nGet an API key<\/i><\/a>\n<\/div>\n<\/div>\n
\n
<\/i> Node SDK \u00a0–\u00a0 Quick start<\/div>\n
\n
\n
<\/div>\n
<\/div>\n
<\/div>\nissue-card.js<\/span>\n<\/div>\n
\n
\/\/ Install: npm install @canvasorbit\/node<\/span><\/div>\n
<\/div>\n
import<\/span> { Client<\/span> } from<\/span> "@canvasorbit\/node"<\/span>;<\/div>\n
<\/div>\n
\/\/ Initialize with your API key<\/span><\/div>\n
const<\/span> client<\/span> = new<\/span> Client<\/span>("co_live_sk_\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"<\/span>);<\/div>\n
<\/div>\n
\/\/ Issue a single-use card for one purchase<\/span><\/div>\n
const<\/span> card<\/span> = await<\/span> client<\/span>.cards.issue<\/span>({<\/div>\n
\u00a0\u00a0agentId<\/span>: "agent_research_01"<\/span>,<\/div>\n
\u00a0\u00a0budgetUsd<\/span>: 49<\/span>,<\/div>\n
\u00a0\u00a0type<\/span>: "single_use"<\/span>,<\/div>\n
\u00a0\u00a0merchantLock<\/span>: "browserless.io"<\/span><\/div>\n
});<\/div>\n
<\/div>\n
console<\/span>.log<\/span>(card<\/span>.last4<\/span>); \/\/ 8821<\/span><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n

API reference<\/p>\n

Three resources,
one REST API<\/em><\/h2>\n<\/div>\n
\n

Every endpoint takes JSON and returns JSON, and the version lives in the URL. Authenticate with a secret key in the Authorization header.<\/p>\n<\/div>\n<\/div>\n

\n
\n
\n<\/i>\n<\/div>\n
Cards<\/div>\n

Issue, read, freeze and close virtual cards. Every card carries its policy as configuration your agent can read.<\/p>\n

\n
POST<\/span> \/v1\/cards<\/span><\/div>\n
GET<\/span> \/v1\/cards\/:id<\/span><\/div>\n
POST<\/span> \/v1\/cards\/:id\/freeze<\/span><\/div>\n
DELETE<\/span> \/v1\/cards\/:id<\/span><\/div>\n<\/div>\n<\/div>\n
\n
\n<\/i>\n<\/div>\n
Approvals<\/div>\n

List the requests waiting for a person and answer them from your own tools, or let the dashboard and Slack do it.<\/p>\n

\n
GET<\/span> \/v1\/approvals<\/span><\/div>\n
POST<\/span> \/v1\/approvals\/:id\/approve<\/span><\/div>\n
POST<\/span> \/v1\/approvals\/:id\/deny<\/span><\/div>\n<\/div>\n<\/div>\n
\n
\n<\/i>\n<\/div>\n
Transactions<\/div>\n

Every authorization and charge, with the agent, the merchant and the policy that allowed it. Exports for your auditors.<\/p>\n

\n
GET<\/span> \/v1\/transactions<\/span><\/div>\n
GET<\/span> \/v1\/transactions\/:id<\/span><\/div>\n
GET<\/span> \/v1\/transactions\/export<\/span><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n

SDKs<\/p>\n

Official SDKs for
Node and Python<\/em><\/h2>\n

Typed clients that handle retries, pagination and webhook signatures for you. Anything else can call the REST API directly.<\/p>\nBack to the quick start<\/i><\/a>\n<\/div>\n

\n
\n
\n
\n
Python SDK<\/div>\n
pip install canvasorbit<\/div>\n
Python 3.9 and newer<\/div>\n
Sync and async clients<\/div>\n<\/div>\n<\/div>\n
\n
\n
Node SDK<\/div>\n
@canvasorbit\/node<\/div>\n
Node 18+<\/div>\n
Full TypeScript types<\/div>\n<\/div>\n<\/div>\n
\n
\n
REST API<\/div>\n
JSON over HTTPS<\/div>\n
v1<\/div>\n
Versioned in the URL<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n

Webhooks<\/p>\n

Every card event,
pushed to you<\/em><\/h2>\n

Register an endpoint and we send a signed POST for every card event. Failed deliveries are retried with backoff for up to three days.<\/p>\n

\n
<\/i> Signed with your webhook secret<\/div>\n
<\/i> Retried with exponential backoff<\/div>\n
<\/i> Ordered per card, never per account<\/div>\n
<\/i> Replayable from the dashboard<\/div>\n<\/div>\n
\nCheck API status<\/i><\/a>\n<\/div>\n<\/div>\n
\n
<\/i> Python SDK \u00a0–\u00a0 Verify a webhook<\/div>\n
\n
\n
<\/div>\n
<\/div>\n
<\/div>\nwebhooks.py<\/span>\n<\/div>\n
\n
import<\/span> canvasorbit<\/span> as<\/span> co<\/span><\/div>\n
<\/div>\n
# Verify the signature before trusting the payload<\/span><\/div>\n
event<\/span> = co.Webhook.verify<\/span>(<\/div>\n
\u00a0\u00a0payload<\/span>=request<\/span>.body<\/span>,<\/div>\n
\u00a0\u00a0signature<\/span>=request<\/span>.headers<\/span>["CO-Signature"<\/span>],<\/div>\n
\u00a0\u00a0secret<\/span>="whsec_\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"<\/span><\/div>\n
)<\/div>\n
<\/div>\n
if<\/span> event<\/span>.type<\/span> == "card.charged"<\/span>:<\/div>\n
\u00a0\u00a0record_receipt<\/span>(event<\/span>.data<\/span>) # your code<\/span><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n

Get started<\/p>\n

Ship your first
agent payment<\/em><\/h2>\n

Create a free account, copy your API key and issue a card from the quick start above.<\/p>\n

\nGet an API key<\/i><\/a>\nSchedule a call<\/a>\n<\/div>\n

100 free cards on signup. No credit card needed.<\/p>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

CanvasOrbit documentation: a quick start for issuing your first virtual card, the REST API reference, the Node and Python SDKs and the webhook events.<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page-canvas","meta":{"footnotes":""},"class_list":["post-6","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/pages\/6","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/comments?post=6"}],"version-history":[{"count":0,"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/pages\/6\/revisions"}],"wp:attachment":[{"href":"https:\/\/demos.canvaswp.com\/ai-payments\/wp-json\/wp\/v2\/media?parent=6"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}