# network.attested.payment.status

> Published by [attested.network](https://lexicon.garden/identity/did:plc:cq3w3bw7awp2rkeswfdzoubb)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cq3w3bw7awp2rkeswfdzoubb/network.attested.payment.status)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cq3w3bw7awp2rkeswfdzoubb/network.attested.payment.status/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cq3w3bw7awp2rkeswfdzoubb/network.attested.payment.status/examples)

## Definitions

### `network.attested.payment.status`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `token` | `string` | Yes | Token returned from network.attested.payment.initiate. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ref` | `ref` → `com.atproto.repo.strongRef` | No | Present when status is 'completed'. Points to the attested payment record in the payer's repository. |
| `status` | `string` | Yes | Current payment status. |

## Raw Schema

```json
{
  "id": "network.attested.payment.status",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```