# com.atiproto.recipient.payment.cart.list

> Published by [atiproto.com](https://lexicon.garden/identity/did:plc:4x5dcv6u4wlkjcssto7f22nu)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:4x5dcv6u4wlkjcssto7f22nu/com.atiproto.recipient.payment.cart.list)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4x5dcv6u4wlkjcssto7f22nu/com.atiproto.recipient.payment.cart.list/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4x5dcv6u4wlkjcssto7f22nu/com.atiproto.recipient.payment.cart.list/examples)

## Definitions

### `com.atiproto.recipient.payment.cart.list`

**Type**: `query`

List carts whose items pay the authenticated user — i.e. carts targeting this user as a payment recipient. Read-only, no PDS writes.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Results per page (1-100, default: 20) |
| `cursor` | `string` | No | Pagination cursor |
| `sender` | `string` (did) | No | Optional: only return carts created by this sender DID |
| `status` | `string` | No | Filter by cart status |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `carts` | `array` | Yes |  |
| `cursor` | `string` | No | Pagination cursor for next page |

### `com.atiproto.recipient.payment.cart.list#cartResponse`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes | CID of the cart record |
| `uri` | `string` (at-uri) | Yes | AT-URI of the cart record |
| `record` | `ref` → `com.atiproto.cart#view` | Yes |  |

## Raw Schema

```json
{
  "id": "com.atiproto.recipient.payment.cart.list",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "carts"
          ],
          "properties": {
            "carts": {
              "type": "array",
              "items": {
                "ref": "#cartResponse",
                "type": "ref"
              }
            },
            "cursor": {
              "type": "string",
              "maxLength": 512,
              "description": "Pagination cursor for next page"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 20,
            "maximum": 100,
            "minimum": 1,
            "description": "Results per page (1-100, default: 20)"
          },
          "cursor": {
            "type": "string",
            "maxLength": 512,
            "description": "Pagination cursor"
          },
          "sender": {
            "type": "string",
            "format": "did",
            "description": "Optional: only return carts created by this sender DID"
          },
          "status": {
            "enum": [
              "open",
              "completed",
              "expired",
              "abandoned"
            ],
            "type": "string",
            "maxLength": 64,
            "description": "Filter by cart status"
          }
        }
      },
      "description": "List carts whose items pay the authenticated user — i.e. carts targeting this user as a payment recipient. Read-only, no PDS writes."
    },
    "cartResponse": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "record"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the cart record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the cart record"
        },
        "record": {
          "ref": "com.atiproto.cart#view",
          "type": "ref"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```