com.atiproto.item

atiproto.com

Documentation

A record representing a item given by one user to another

main record

A record representing a item given by one user to another

Record Key any Any valid record key

Properties

amount integer Required

Tip amount in cents (0 when recipient allows zero items)

minimum: 0

completedAt string datetime Optional

Completion timestamp

createdAt string datetime Required

Creation timestamp

currency string Required

ISO 4217 currency code

maxLength: 3 bytes

message string Optional

Optional message (max 500 chars)

maxLength: 5000 bytesmaxGraphemes: 500 graphemes

recordUri string at-uri Optional

AT-URI of specific record being tipped

status string Required

Tip status

maxLength: 64 bytes

Allowed: pending, authorized, completed, failed, refunded

subject string did Optional

DID of the user receiving the item

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "amount",
      "currency",
      "status",
      "createdAt"
    ],
    "properties": {
      "amount": {
        "type": "integer",
        "minimum": 0,
        "description": "Tip amount in cents (0 when recipient allows zero items)"
      },
      "status": {
        "enum": [
          "pending",
          "authorized",
          "completed",
          "failed",
          "refunded"
        ],
        "type": "string",
        "maxLength": 64,
        "description": "Tip status"
      },
      "message": {
        "type": "string",
        "maxLength": 5000,
        "description": "Optional message (max 500 chars)",
        "maxGraphemes": 500
      },
      "subject": {
        "type": "string",
        "format": "did",
        "description": "DID of the user receiving the item"
      },
      "currency": {
        "type": "string",
        "maxLength": 3,
        "description": "ISO 4217 currency code"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Creation timestamp"
      },
      "recordUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of specific record being tipped"
      },
      "completedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Completion timestamp"
      }
    }
  },
  "description": "A record representing a item given by one user to another"
}

view object

View of a item record for use in API responses