network.attested.payment.lookup

{
  "id": "network.attested.payment.lookup",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "payments"
          ],
          "properties": {
            "payments": {
              "type": "array",
              "items": {
                "refs": [
                  "network.attested.payment.oneTime",
                  "network.attested.payment.recurring",
                  "network.attested.payment.scheduled"
                ],
                "type": "union"
              },
              "description": "List of verified payment records. Each element is a union of network.attested.payment.oneTime, network.attested.payment.recurring, or network.attested.payment.scheduled, discriminated by its $type field."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "payer",
          "recipient"
        ],
        "properties": {
          "payer": {
            "type": "string",
            "format": "did",
            "description": "DID of the payer (supporter)."
          },
          "brokers": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "did"
            },
            "description": "Optional list of broker DIDs. When provided, only returns payments that have at least one validating signature from an identity in this list."
          },
          "recipient": {
            "type": "string",
            "format": "did",
            "description": "DID of the recipient (creator)."
          },
          "paymentType": {
            "type": "string",
            "format": "nsid",
            "description": "Optional filter by payment collection. Must be a full NSID identifying one of the network.attested.payment record types.",
            "knownValues": [
              "network.attested.payment.oneTime",
              "network.attested.payment.recurring",
              "network.attested.payment.scheduled"
            ]
          },
          "entitlements": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "at-uri"
            },
            "description": "Optional list of entitlement AT-URIs. When provided, only returns payments whose entitlements array contains one or more of the given references."
          }
        }
      },
      "description": "Look up verified payment records between a payer and a recipient. Returns only records whose attestations have been cryptographically verified. Results may include any combination of oneTime, recurring, and scheduled payment records."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}