---
title: "codespar ofb"
description: "Open Finance (Test): sweeping consents and pulls, Pix com biometria enrollments and payments"
---

Open Finance (Test): sweeping consents and pulls, Pix com biometria enrollments and payments

19 commands in `@codespar/cli 0.22.7`.

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 ofb get-consents`

Read one bank consent

> **Deprecated route.** The served document marks this operation as dead. The command still answers today and will go; the HTTP reference below names what took its place.

```bash
codespar ofb get-consents obj_0000000000000000
```

| argument | what it is |
|---|---|
| `<id>` | `ofb_`-prefixed consent id. |

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

`GET /v1/ofb/consents/{id}` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbconsentsid)

### `codespar ofb list-sweeping-consents`

List sweeping consents

```bash
codespar ofb list-sweeping-consents
```

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

`GET /v1/ofb/sweeping/consents` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbsweepingconsents)

### `codespar ofb create-sweeping-consents`

Open a sweeping consent

```bash
codespar ofb create-sweeping-consents --input-file body.json
```

```json title="body.json"
{
  "consumer_id": "csm_0000000000000000",
  "wallet_id": "wlt_0000000000000000",
  "funding_source_id": "fundingsource_0000000000000000",
  "participant_id": "participant_0000000000000000",
  "triggers": [
    "manual"
  ],
  "limits": {},
  "expires_at": "2026-01-15T12:00:00.000Z",
  "redirect_url": "https://example.com/hook"
}
```

| 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/ofb/sweeping/consents` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbsweepingconsents)

### `codespar ofb get-sweeping-consents`

Read one sweeping consent

```bash
codespar ofb get-sweeping-consents obj_0000000000000000
```

| argument | what it is |
|---|---|
| `<id>` | `ofb_`-prefixed sweeping consent id. |

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

`GET /v1/ofb/sweeping/consents/{id}` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbsweepingconsentsid)

### `codespar ofb sweeping-consents-revoke`

Revoke a sweeping consent

```bash
codespar ofb sweeping-consents-revoke obj_0000000000000000 --input '{"reason":"string"}'
```

| argument | what it is |
|---|---|
| `<id>` | `ofb_`-prefixed sweeping consent id. |

| 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/ofb/sweeping/consents/{id}/revoke` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbsweepingconsentsidrevoke)

### `codespar ofb list-sweeping-pulls`

List sweeping pulls

```bash
codespar ofb list-sweeping-pulls
```

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

`GET /v1/ofb/sweeping/pulls` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbsweepingpulls)

### `codespar ofb create-sweeping-pulls`

Pull Pix under a sweeping consent

```bash
codespar ofb create-sweeping-pulls --input '{"consent_id":"consent_0000000000000000","amount_minor":1000,"risk_signals":{"type":"AUTOMATIC","last_login_date_time":"2026-01-15T12:00:00.000Z"}}'
```

| 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/ofb/sweeping/pulls` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbsweepingpulls)

### `codespar ofb get-sweeping-pulls`

Read one sweeping pull

```bash
codespar ofb get-sweeping-pulls obj_0000000000000000
```

| argument | what it is |
|---|---|
| `<id>` | `swp_`-prefixed sweeping pull id. |

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

`GET /v1/ofb/sweeping/pulls/{id}` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbsweepingpullsid)

### `codespar ofb list-jsr-enrollments`

List JSR enrollments

```bash
codespar ofb list-jsr-enrollments
```

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

`GET /v1/ofb/jsr/enrollments` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbjsrenrollments)

### `codespar ofb create-jsr-enrollments`

Register a passkey for Pix com biometria

```bash
codespar ofb create-jsr-enrollments --input-file body.json
```

```json title="body.json"
{
  "consumer_id": "csm_0000000000000000",
  "wallet_id": "wlt_0000000000000000",
  "funding_source_id": "fundingsource_0000000000000000",
  "participant_id": "participant_0000000000000000",
  "device_context": {
    "os_version": "string",
    "user_time_zone_offset": "string",
    "language": "string",
    "screen_dimensions": {
      "width": 0,
      "height": 0
    },
    "account_tenure": "2026-01-15"
  }
}
```

| 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/ofb/jsr/enrollments` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbjsrenrollments)

### `codespar ofb get-jsr-enrollments`

Read one JSR enrollment

```bash
codespar ofb get-jsr-enrollments obj_0000000000000000
```

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

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

`GET /v1/ofb/jsr/enrollments/{id}` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbjsrenrollmentsid)

### `codespar ofb jsr-enrollments-revoke`

Revoke a JSR enrollment

```bash
codespar ofb jsr-enrollments-revoke obj_0000000000000000 --input '{"reason":"string"}'
```

| argument | what it is |
|---|---|
| `<id>` | 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/ofb/jsr/enrollments/{id}/revoke` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbjsrenrollmentsidrevoke)

### `codespar ofb list-jsr-payments`

List JSR payments

```bash
codespar ofb list-jsr-payments
```

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

`GET /v1/ofb/jsr/payments` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbjsrpayments)

### `codespar ofb create-jsr-payments`

Pay from the consumer's bank with Pix com biometria

```bash
codespar ofb create-jsr-payments --input '{"enrollment_id":"enrollment_0000000000000000","amount_minor":1000,"description":"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/ofb/jsr/payments` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbjsrpayments)

### `codespar ofb get-jsr-payments`

Read one JSR payment

```bash
codespar ofb get-jsr-payments obj_0000000000000000
```

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

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

`GET /v1/ofb/jsr/payments/{id}` · [parameters, responses and refusals](/docs/api/reference/ofb#get-v1ofbjsrpaymentsid)

### `codespar ofb create-consents`

Initiate a bank consent (legacy path)

> **Deprecated route.** The served document marks this operation as dead. The command still answers today and will go; the HTTP reference below names what took its place.

```bash
codespar ofb create-consents --input-file body.json
```

```json title="body.json"
{
  "bank_id": "bank_0000000000000000",
  "consumer_id": "csm_0000000000000000",
  "scopes": [
    "string"
  ],
  "redirect_url": "https://example.com/hook",
  "wallet_id": "wlt_0000000000000000"
}
```

| 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/ofb/consents` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbconsents)

### `codespar ofb consents-callback`

Finalise a consent after the consumer authorises it (legacy path)

> **Deprecated route.** The served document marks this operation as dead. The command still answers today and will go; the HTTP reference below names what took its place.

```bash
codespar ofb consents-callback obj_0000000000000000 --input '{"auth_code":"string"}'
```

| argument | what it is |
|---|---|
| `<id>` | 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/ofb/consents/{id}/callback` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbconsentsidcallback)

### `codespar ofb consents-refresh-statement`

Fetch the bank statement and ingest it (legacy path)

> **Deprecated route.** The served document marks this operation as dead. The command still answers today and will go; the HTTP reference below names what took its place.

```bash
codespar ofb consents-refresh-statement obj_0000000000000000 --input '{"since":"2026-01-15T12:00:00.000Z","until":"2026-01-15T12:00:00.000Z"}'
```

| argument | what it is |
|---|---|
| `<id>` | 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/ofb/consents/{id}/refresh-statement` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbconsentsidrefresh-statement)

### `codespar ofb consents-revoke`

Revoke a bank consent (legacy path)

> **Deprecated route.** The served document marks this operation as dead. The command still answers today and will go; the HTTP reference below names what took its place.

```bash
codespar ofb consents-revoke obj_0000000000000000 --input '{"reason":"string"}'
```

| argument | what it is |
|---|---|
| `<id>` | 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/ofb/consents/{id}/revoke` · [parameters, responses and refusals](/docs/api/reference/ofb#post-v1ofbconsentsidrevoke)
