Lexicon Garden

com.atiproto.payment.item.create

Create a item on a DID or specific record. Creates or adds to a cart and returns a checkout URL.

Repository @atiproto.com did:plc:4x5dcv6u4wlkjcssto7f22nu namespace authority
Details · procedure
Kindprocedure
Authorityitem.payment.atiproto.com
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

amount

requiredinteger

Tip amount in cents

cartUri

string · at-uri

AT-URI of an existing cart to add this item to. If omitted, a new cart is created.

currency

requiredstring

ISO 4217 currency code

  • maxLength: 3

isPrivate

boolean

If true, the recipient (subject) and recordUri are stored only in atiproto's private database and are omitted from the PDS item record.

message

string

Optional message (max 500 chars)

  • maxLength: 5000
  • maxGraphemes: 500

recordUri

string · at-uri

AT-URI of specific record being tipped

redirectUrl

string · uri

URL to redirect to after checkout completes

subject

requiredstring · did

DID of the user being tipped

workflow

ref

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

Reference

Output

application/json

cart

ref

The cart record (new or updated)

Reference

cartUri

string · at-uri

URI of the cart record in PDS

checkoutUrl

string · uri

Checkout URL hosted by atiproto

item

ref

The created item record (status: pending)

Reference

itemUri

string · at-uri

URI of the item record in PDS

workflow

ref

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

Reference

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.