---
title: "codespar consumers"
description: "Consumers: profile, Pix keys, Pix lookups, receipts, contact verification"
---

# codespar consumers

Consumers: profile, Pix keys, Pix lookups, receipts, contact verification

31 comandos. Esta página é gerada da árvore de `--help` da CLI publicada, então ela descreve o que você instala, não o que está em `main`.

### `codespar consumers list`

`GET /v1/consumers`

```bash
codespar consumers list [options]
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers create`

`POST /v1/consumers`

```bash
codespar consumers create [options]
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers get`

`GET /v1/consumers/{id}`

```bash
codespar consumers get [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers update`

`PATCH /v1/consumers/{id}`

```bash
codespar consumers update [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers mandates-spend`

`POST /v1/consumers/mandates/{id}/spend`

```bash
codespar consumers mandates-spend [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers consents`

`GET /v1/consumers/consents`

```bash
codespar consumers consents [options]
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers funding-sources`

`GET /v1/consumers/funding-sources`

```bash
codespar consumers funding-sources [options]
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers list-pix-keys`

`GET /v1/consumers/{consumerId}/pix-keys`

```bash
codespar consumers list-pix-keys [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers create-pix-keys`

`POST /v1/consumers/{consumerId}/pix-keys`

```bash
codespar consumers create-pix-keys [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers delete-pix-keys`

`DELETE /v1/consumers/{consumerId}/pix-keys/{key}`

```bash
codespar consumers delete-pix-keys [options] <consumerId> <key>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers pix-charges`

`GET /v1/consumers/{consumerId}/pix/charges/{reference}`

```bash
codespar consumers pix-charges [options] <consumerId> <reference>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers pix-receivements`

`GET /v1/consumers/{consumerId}/pix/receivements/{endToEndId}`

```bash
codespar consumers pix-receivements [options] <consumerId> <endToEndId>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers get-pix-devolutions`

`GET /v1/consumers/{consumerId}/pix/devolutions/{devolutionId}`

```bash
codespar consumers get-pix-devolutions [options] <consumerId> <devolutionId>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers fund`

`GET /v1/consumers/{consumerId}/fund/{txId}`

```bash
codespar consumers fund [options] <consumerId> <txId>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers wallet`

`GET /v1/consumers/{id}/wallet`

```bash
codespar consumers wallet [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers list-mandates-card`

`GET /v1/consumers/mandates/{id}/card`

```bash
codespar consumers list-mandates-card [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers delete-mandates-card`

`DELETE /v1/consumers/mandates/{id}/card`

```bash
codespar consumers delete-mandates-card [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers list-receipts`

`GET /v1/consumers/{consumerId}/receipts`

```bash
codespar consumers list-receipts [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers get-receipts`

`GET /v1/consumers/receipts/{id}`

```bash
codespar consumers get-receipts [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers fund-sandbox`

`POST /v1/consumers/{consumerId}/fund/sandbox`

```bash
codespar consumers fund-sandbox [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers fund-pix-in`

`POST /v1/consumers/{consumerId}/fund/pix-in`

```bash
codespar consumers fund-pix-in [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers fund-pix-in-settle`

`POST /v1/consumers/{consumerId}/fund/pix-in/settle`

```bash
codespar consumers fund-pix-in-settle [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers contact-verifications`

`POST /v1/consumers/{consumerId}/contact-verifications`

```bash
codespar consumers contact-verifications [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers contact-verifications-verify`

`POST /v1/consumers/{consumerId}/contact-verifications/{id}/verify`

```bash
codespar consumers contact-verifications-verify [options] <consumerId> <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers create-pix-devolutions`

`POST /v1/consumers/{consumerId}/pix/devolutions`

```bash
codespar consumers create-pix-devolutions [options] <consumerId>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers mandates-receipts`

`GET /v1/consumers/mandates/{id}/receipts`

```bash
codespar consumers mandates-receipts [options] <id>
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers receipts-delivery`

`POST /v1/consumers/receipts/{id}/delivery`

```bash
codespar consumers receipts-delivery [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers mandates`

`GET /v1/consumers/mandates`

```bash
codespar consumers mandates [options]
```

| opção | o que faz |
|---|---|
| `-q, --query <key=value>` | Query parameter (repeatable) (default: []) |
| `--timeout <ms>` | Per-request timeout in milliseconds |

### `codespar consumers mandates-pause`

`POST /v1/consumers/mandates/{id}/pause`

```bash
codespar consumers mandates-pause [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers mandates-resume`

`POST /v1/consumers/mandates/{id}/resume`

```bash
codespar consumers mandates-resume [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |

### `codespar consumers mandates-revoke`

`POST /v1/consumers/mandates/{id}/revoke`

```bash
codespar consumers mandates-revoke [options] <id>
```

| opção | o que faz |
|---|---|
| `-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 |