com.atiproto.recipient.payment.item.validate

atiproto.com

Documentation

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.

main query

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.

Parameters

amount integer Optional

Expected item amount in cents. If omitted, only checks that a item exists.

itemUri string at-uri Optional

AT-URI of a specific item record. Takes precedence over recordUri and sender.

recordUri string at-uri Optional

AT-URI of the record being tipped. Takes precedence over sender.

sender string did Optional

DID of the item sender. Ignored if itemUri or recordUri is provided.

Output

Encodingapplication/json
amount integer Optional

Sum of all verified completed item amounts in cents

currency string Optional

Currency of the items

reason string Optional

If invalid, reason for rejection

valid boolean Required

Whether a sender has completed and verified item(s) to the authed recipient

Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Expected item amount in cents. If omitted, only checks that a item exists.
AT-URI of a specific item record. Takes precedence over recordUri and sender.
AT-URI of the record being tipped. Takes precedence over sender.
DID of the item sender. Ignored if itemUri or recordUri is provided.
View raw schema 
{
  "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."
}

Lexicon Garden

@