network.attested.payment.status Documentation (EN)

main query

Check the status of a payment initiated via network.attested.payment.initiate. Returns the current status and, when completed, a com.atproto.repo.strongRef pointing to the attested payment record in the payer's repository.

Parameters

token string Required

Token returned from network.attested.payment.initiate.

Output

Encodingapplication/json

ref refcom.atproto.repo.strongRef Optional

Present when status is 'completed'. Points to the attested payment record in the payer's repository.

status string Required

Current payment status.

Known values: pending, completed, failed

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

token * Token returned from network.attested.payment.initiate.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "ref": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref",
          "description": "Present when status is 'completed'. Points to the attested payment record in the payer's repository."
        },
        "status": {
          "type": "string",
          "description": "Current payment status.",
          "knownValues": [
            "pending",
            "completed",
            "failed"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "token"
    ],
    "properties": {
      "token": {
        "type": "string",
        "description": "Token returned from network.attested.payment.initiate."
      }
    }
  },
  "description": "Check the status of a payment initiated via network.attested.payment.initiate. Returns the current status and, when completed, a com.atproto.repo.strongRef pointing to the attested payment record in the payer's repository."
}