support.supper.payment.queryPayments

supper.support

Documentation

Return a bounded public view of up to 50 attested payment record bodies for a specific payer and recipient pair, with optional broker and entitlement filters. This unauthenticated view is not personalized. Absence from this bounded broker lookup is not exhaustive historical evidence and must never be treated as settlement or non-settlement proof; use exact broker verification for payment truth.

main query

Return a bounded public view of up to 50 attested payment record bodies for a specific payer and recipient pair, with optional broker and entitlement filters. This unauthenticated view is not personalized. Absence from this bounded broker lookup is not exhaustive historical evidence and must never be treated as settlement or non-settlement proof; use exact broker verification for payment truth.

Parameters

brokers array of string Optional

Optional broker DID filters.

entitlements array of string Optional

Optional entitlement AT-URI filters.

limit integer Optional

Maximum number of results to return from the broker's bounded first window.

payer string at-identifier Required

Required payer account identifier.

paymentType string nsid Optional

Optional full payment record NSID to filter by.

recipient string at-identifier Required

Required recipient account identifier.

Output

Encodingapplication/json
payments array Required

No description available.

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
Optional broker DID filters.
Optional entitlement AT-URI filters.
Maximum number of results to return from the broker's bounded first window.
Required payer account identifier.
Optional full payment record NSID to filter by.
Required recipient account identifier.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "payments"
      ],
      "properties": {
        "payments": {
          "type": "array",
          "items": {
            "ref": "#paymentView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "payer",
      "recipient"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 50,
        "minimum": 1,
        "description": "Maximum number of results to return from the broker's bounded first window."
      },
      "payer": {
        "type": "string",
        "format": "at-identifier",
        "description": "Required payer account identifier."
      },
      "brokers": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "maxLength": 10,
        "description": "Optional broker DID filters."
      },
      "recipient": {
        "type": "string",
        "format": "at-identifier",
        "description": "Required recipient account identifier."
      },
      "paymentType": {
        "type": "string",
        "format": "nsid",
        "description": "Optional full payment record NSID to filter by.",
        "knownValues": [
          "network.attested.payment.oneTime",
          "network.attested.payment.recurring",
          "network.attested.payment.scheduled"
        ]
      },
      "entitlements": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 50,
        "description": "Optional entitlement AT-URI filters."
      }
    }
  },
  "description": "Return a bounded public view of up to 50 attested payment record bodies for a specific payer and recipient pair, with optional broker and entitlement filters. This unauthenticated view is not personalized. Absence from this bounded broker lookup is not exhaustive historical evidence and must never be treated as settlement or non-settlement proof; use exact broker verification for payment truth."
}
paymentView object

No description available.

Properties

ref ref com.atproto.repo.strongRef Optional

Optional versioned reference to the payment record. Present only when the broker supplies a resolvable record URI/CID; the launch ATM lookup returns bare record bodies, so this is usually absent.

View raw schema 
{
  "type": "object",
  "required": [
    "record"
  ],
  "properties": {
    "ref": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Optional versioned reference to the payment record. Present only when the broker supplies a resolvable record URI/CID; the launch ATM lookup returns bare record bodies, so this is usually absent."
    },
    "record": {
      "refs": [
        "network.attested.payment.oneTime",
        "network.attested.payment.recurring",
        "network.attested.payment.scheduled"
      ],
      "type": "union",
      "closed": false,
      "description": "The attested payment record body returned by the selected broker's bounded network.attested.payment.lookup view. Always present; presence or absence in this view is not settlement proof."
    }
  }
}

Lexicon Garden

@