com.atiproto.payment.cart.create Documentation (EN)

main procedure

Create a new empty cart

Input

Encodingapplication/json

currency string Required

ISO 4217 currency code

maxLength: 3 bytes

redirectUrl stringuri Optional

URI to redirect to after checkout is complete/cancelled

workflow refcom.atiproto.actions#inboundWorkflow Optional

Workflow callback envelope. Present on agent-driven callbacks; absent on initial calls.

Output

Encodingapplication/json

cart refcom.atiproto.cart#view Optional

The created cart record

cartUri stringat-uri Optional

URI of the cart record

checkoutUrl stringuri Optional

Checkout URL hosted by atiproto

workflow refcom.atiproto.actions#outboundWorkflow Optional

Workflow envelope. When present, the agent runs the actions and calls back. When absent, this is the final native result.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "currency"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "maxLength": 3,
          "description": "ISO 4217 currency code"
        },
        "workflow": {
          "ref": "com.atiproto.actions#inboundWorkflow",
          "type": "ref",
          "description": "Workflow callback envelope. Present on agent-driven callbacks; absent on initial calls."
        },
        "redirectUrl": {
          "type": "string",
          "format": "uri",
          "description": "URI to redirect to after checkout is complete/cancelled"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "properties": {
        "cart": {
          "ref": "com.atiproto.cart#view",
          "type": "ref",
          "description": "The created cart record"
        },
        "cartUri": {
          "type": "string",
          "format": "at-uri",
          "description": "URI of the cart record"
        },
        "workflow": {
          "ref": "com.atiproto.actions#outboundWorkflow",
          "type": "ref",
          "description": "Workflow envelope. When present, the agent runs the actions and calls back. When absent, this is the final native result."
        },
        "checkoutUrl": {
          "type": "string",
          "format": "uri",
          "description": "Checkout URL hosted by atiproto"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Create a new empty cart"
}