com.atiproto.recipient.payment.item.validate

{
  "id": "com.atiproto.recipient.payment.item.validate",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "valid"
          ],
          "properties": {
            "valid": {
              "type": "boolean",
              "description": "Whether a sender has completed and verified item(s) to the authed recipient"
            },
            "amount": {
              "type": "integer",
              "description": "Sum of all verified completed item amounts in cents"
            },
            "reason": {
              "type": "string",
              "maxLength": 1024,
              "description": "If invalid, reason for rejection"
            },
            "currency": {
              "type": "string",
              "maxLength": 3,
              "description": "Currency of the items"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Expected item amount in cents. If omitted, only checks that a item exists."
          },
          "sender": {
            "type": "string",
            "format": "did",
            "description": "DID of the item sender. Ignored if itemUri or recordUri is provided."
          },
          "itemUri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of a specific item record. Takes precedence over recordUri and sender."
          },
          "recordUri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the record being tipped. Takes precedence over sender."
          }
        }
      },
      "description": "Validate that a sender has completed item payment(s) to the authenticated user (as the recipient/subject). Looks up by itemUri (a specific item record), recordUri (sums all items for that record), or sender (sender DID). These are mutually exclusive and resolved in that order."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}