---
title: "codespar sellers"
description: "Sellers: onboarding status, custody, pending settlement, ledger"
---

Sellers: onboarding status, custody, pending settlement, ledger

6 commands in `@codespar/cli 0.16.0`.

Each one prints what its operation answered. [What a command prints](/docs/cli/reference#what-a-command-prints) has the rule, and [Configuration](/docs/cli/config#what-a-script-gets-when-a-command-fails) has the exit codes and the shape of a failure.

### `codespar sellers create`

Onboard a seller (KYB) and affiliate it at Rinne

```bash
codespar sellers create --input-file body.json
```

```json title="body.json"
{
  "full_name": "Example",
  "name": "Example",
  "document_number": "string",
  "document_type": "CNPJ",
  "document_tax_type": "PJ",
  "mcc": "string",
  "contact": {},
  "address": {},
  "transfer_configurations": {
    "automatic_transfer_enabled": true,
    "transfer_frequency": "DAILY",
    "rail": "PIX",
    "utc_hour_of_day": 0,
    "day_of_week": 0,
    "day_of_month": 0,
    "min_balance": 1000
  },
  "declared_revenue": 0,
  "declared_income": 0,
  "net_worth": 0,
  "company_logo_url": "https://example.com/hook",
  "website_url": "https://example.com/hook",
  "fee_policy_id": "feepolicy_0000000000000000",
  "metadata": {},
  "linked_consumer_id": "linkedconsumer_0000000000000000",
  "allowed_capture_methods": [
    "string"
  ],
  "allowed_payment_methods": [
    "string"
  ]
}
```

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |
| `-i, --input <json>` | Request body as a JSON string |
| `-f, --input-file <path>` | Request body from a JSON file |

`POST /v1/sellers` · [parameters, responses and refusals](/docs/api/reference/sellers#post-v1sellers)

### `codespar sellers get`

Read one seller

```bash
codespar sellers get slr_0000000000000000
```

| argument | what it is |
|---|---|
| `<sellerId>` | String. |

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

`GET /v1/sellers/{sellerId}` · [parameters, responses and refusals](/docs/api/reference/sellers#get-v1sellerssellerid)

### `codespar sellers status`

Refresh a seller's affiliation status from Rinne

```bash
codespar sellers status slr_0000000000000000
```

| argument | what it is |
|---|---|
| `<sellerId>` | String. |

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

`GET /v1/sellers/{sellerId}/status` · [parameters, responses and refusals](/docs/api/reference/sellers#get-v1sellersselleridstatus)

### `codespar sellers pending-settlement`

What Rinne reports as sold but not yet settled

```bash
codespar sellers pending-settlement slr_0000000000000000
```

| argument | what it is |
|---|---|
| `<sellerId>` | String. |

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

`GET /v1/sellers/{sellerId}/pending-settlement` · [parameters, responses and refusals](/docs/api/reference/sellers#get-v1sellersselleridpending-settlement)

### `codespar sellers custody`

Compare this seller's ledger against Rinne's custody

```bash
codespar sellers custody slr_0000000000000000
```

| argument | what it is |
|---|---|
| `<sellerId>` | String. |

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

`GET /v1/sellers/{sellerId}/custody` · [parameters, responses and refusals](/docs/api/reference/sellers#get-v1sellersselleridcustody)

### `codespar sellers ledger`

This seller's wallet ledger, without learning the wallet id

```bash
codespar sellers ledger slr_0000000000000000
```

| argument | what it is |
|---|---|
| `<sellerId>` | String. |

| option | what it does |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

`GET /v1/sellers/{sellerId}/ledger` · [parameters, responses and refusals](/docs/api/reference/sellers#get-v1sellersselleridledger)