codespar consumers

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

31 commands in @codespar/cli 0.16.0.

Each one prints what its operation answered. What a command prints has the rule, and Configuration has the exit codes and the shape of a failure.

`codespar consumers list`

List titulars

codespar consumers list

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

GET /v1/consumers · parameters, responses and refusals

`codespar consumers create`

Create the titular, without a document

codespar consumers create --input '{"display_name":"Example","metadata":{}}'

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/consumers · parameters, responses and refusals

`codespar consumers get`

Read one titular, with the ids of what hangs off it

codespar consumers get [options] <id>

argument	what it is
`<id>`	—

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

GET /v1/consumers/{id} · parameters, responses and refusals

`codespar consumers update`

Update the mutable fields of a titular

codespar consumers update [options] <id>

argument	what it is
`<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

PATCH /v1/consumers/{id} · parameters, responses and refusals

`codespar consumers mandates-spend`

Spend under a mandate already projected here

codespar consumers mandates-spend obj_0000000000000000 --input-file body.json

body.json

{
  "amount_minor": 1000,
  "payee": "string",
  "agent_id": "agt_0000000000000000",
  "attempt_id": "attempt_0000000000000000",
  "ted": {
    "bank": "string",
    "branch": "string",
    "account": "string",
    "tax_id": "tax_0000000000000000",
    "name": "Example",
    "account_type": "CC",
    "person_type": "F",
    "client_finality": "string"
  },
  "quote": {
    "seller": "string",
    "resource": "string",
    "price_minor": 1,
    "payee": "string",
    "session_id": "ses_0000000000000000",
    "at": "2026-01-15T12:00:00.000Z"
  },
  "actor": {
    "type": "agent",
    "id": "paymentactor_0000000000000000",
    "on_behalf_of": "string"
  },
  "approval": {
    "items_hash": "string",
    "batch_hash": "string"
  },
  "session_id": "ses_0000000000000000"
}

argument	what it is
`<id>`	The mandate's 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/consumers/mandates/{id}/spend · parameters, responses and refusals

`codespar consumers consents`

List consent evidence (deprecated 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.

codespar consumers consents

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

GET /v1/consumers/consents · parameters, responses and refusals

`codespar consumers funding-sources`

List consumer funding sources, optionally with live balance (deprecated 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.

codespar consumers funding-sources

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

GET /v1/consumers/funding-sources · parameters, responses and refusals

`codespar consumers list-pix-keys`

List the Pix keys on the consumer's account

codespar consumers list-pix-keys csm_0000000000000000

argument	what it is
`<consumerId>`	String.

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

GET /v1/consumers/{consumerId}/pix-keys · parameters, responses and refusals

`codespar consumers create-pix-keys`

codespar consumers create-pix-keys csm_0000000000000000 --input '{"key_type":"EVP","key":"string"}'

argument	what it is
`<consumerId>`	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/consumers/{consumerId}/pix-keys · parameters, responses and refusals

`codespar consumers delete-pix-keys`

Delete a Pix key from the consumer's account

codespar consumers delete-pix-keys csm_0000000000000000 string

argument	what it is
`<consumerId>`	String.
`<key>`	The key value. Trimmed; an empty value is 400.

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

DELETE /v1/consumers/{consumerId}/pix-keys/{key} · parameters, responses and refusals

`codespar consumers pix-charges`

A minted Pix charge's state

codespar consumers pix-charges csm_0000000000000000 string

argument	what it is
`<consumerId>`	String.
`<reference>`	The charge id, the mint's transaction id, or its client request id. Up to 128 characters of letters, digits, `_` and `-`.

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

GET /v1/consumers/{consumerId}/pix/charges/{reference} · parameters, responses and refusals

`codespar consumers pix-receivements`

Did this specific Pix land on this consumer's account

codespar consumers pix-receivements csm_0000000000000000 endtoend_0000000000000000

argument	what it is
`<consumerId>`	String.
`<endToEndId>`	The payment's end-to-end id, the reference the payer's receipt carries. 16 to 64 alphanumeric characters.

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

GET /v1/consumers/{consumerId}/pix/receivements/{endToEndId} · parameters, responses and refusals

`codespar consumers get-pix-devolutions`

A Pix devolution's state

codespar consumers get-pix-devolutions csm_0000000000000000 devolution_0000000000000000

argument	what it is
`<consumerId>`	String.
`<devolutionId>`	String.

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

GET /v1/consumers/{consumerId}/pix/devolutions/{devolutionId} · parameters, responses and refusals

`codespar consumers fund`

Poll an onramp, and credit the wallet when it settles

codespar consumers fund csm_0000000000000000 tx_0000000000000000

argument	what it is
`<consumerId>`	String.
`<txId>`	The ramp provider's transaction id, from the fund call.

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

GET /v1/consumers/{consumerId}/fund/{txId} · parameters, responses and refusals

`codespar consumers wallet`

The consumer's unified wallet, rolled up per currency

codespar consumers wallet 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/consumers/{id}/wallet · parameters, responses and refusals

`codespar consumers list-mandates-card`

The card bound to a mandate, and its recent authorizations

codespar consumers list-mandates-card obj_0000000000000000

argument	what it is
`<id>`	The mandate id.

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

GET /v1/consumers/mandates/{id}/card · parameters, responses and refusals

`codespar consumers delete-mandates-card`

Unbind the card from a mandate

codespar consumers delete-mandates-card obj_0000000000000000

argument	what it is
`<id>`	The mandate id.

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

DELETE /v1/consumers/mandates/{id}/card · parameters, responses and refusals

`codespar consumers list-receipts`

A consumer's agentic receipts

codespar consumers list-receipts csm_0000000000000000

argument	what it is
`<consumerId>`	String.

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

GET /v1/consumers/{consumerId}/receipts · parameters, responses and refusals

`codespar consumers get-receipts`

Read one agentic receipt

codespar consumers get-receipts obj_0000000000000000

argument	what it is
`<id>`	The receipt id.

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

GET /v1/consumers/receipts/{id} · parameters, responses and refusals

`codespar consumers fund-sandbox`

Credit a consumer in the sandbox (deprecated 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.

codespar consumers fund-sandbox csm_0000000000000000 --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"account":"string"}'

argument	what it is
`<consumerId>`	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/consumers/{consumerId}/fund/sandbox · parameters, responses and refusals

`codespar consumers fund-pix-in`

Mint a sandbox Pix charge to fund a consumer (deprecated 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.

codespar consumers fund-pix-in csm_0000000000000000 --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"description":"string"}'

argument	what it is
`<consumerId>`	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/consumers/{consumerId}/fund/pix-in · parameters, responses and refusals

`codespar consumers fund-pix-in-settle`

Settle a sandbox Pix charge and credit the consumer (deprecated 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.

codespar consumers fund-pix-in-settle csm_0000000000000000 --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"transaction_id":"transaction_0000000000000000"}'

argument	what it is
`<consumerId>`	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/consumers/{consumerId}/fund/pix-in/settle · parameters, responses and refusals

`codespar consumers contact-verifications`

Send a one-time code to a consumer's e-mail address or phone number

codespar consumers contact-verifications csm_0000000000000000 --input '{"channel":"email","target":"string","locale":"string"}'

argument	what it is
`<consumerId>`	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/consumers/{consumerId}/contact-verifications · parameters, responses and refusals

`codespar consumers contact-verifications-verify`

Check the code the consumer received

codespar consumers contact-verifications-verify csm_0000000000000000 obj_0000000000000000 --input '{"code":"string","target":"string"}'

argument	what it is
`<consumerId>`	String.
`<id>`	String, in uuid format.

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/consumers/{consumerId}/contact-verifications/{id}/verify · parameters, responses and refusals

`codespar consumers create-pix-devolutions`

Reverse a Pix, in either direction

codespar consumers create-pix-devolutions csm_0000000000000000 --input-file body.json

body.json

{
  "end_to_end_id": "endtoend_0000000000000000",
  "amount_minor": 1000,
  "idempotency_key": "string",
  "reason": "string",
  "description": "string",
  "payment_direction": "inbound"
}

argument	what it is
`<consumerId>`	The consumer whose account the original payment touched. It is also what binds the statement lookup.

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/consumers/{consumerId}/pix/devolutions · parameters, responses and refusals

`codespar consumers mandates-receipts`

The spend feed for one allowance

codespar consumers mandates-receipts obj_0000000000000000

argument	what it is
`<id>`	The consumer mandate.

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

GET /v1/consumers/mandates/{id}/receipts · parameters, responses and refusals

`codespar consumers receipts-delivery`

Seal a delivery proof onto a receipt

codespar consumers receipts-delivery obj_0000000000000000 --input '{"result":"confirmed","proof":"string","kind":"order_confirmation","nfe_chave":"string","at":"2026-01-15T12:00:00.000Z"}'

argument	what it is
`<id>`	The agentic receipt to seal onto.

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/consumers/receipts/{id}/delivery · parameters, responses and refusals

`codespar consumers mandates`

List consumer allowances (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.

codespar consumers mandates

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

GET /v1/consumers/mandates · parameters, responses and refusals

`codespar consumers mandates-pause`

Pause an allowance (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.

codespar consumers mandates-pause 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/consumers/mandates/{id}/pause · parameters, responses and refusals

`codespar consumers mandates-resume`

Resume a paused allowance (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.

codespar consumers mandates-resume 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/consumers/mandates/{id}/resume · parameters, responses and refusals

`codespar consumers mandates-revoke`

Revoke an allowance (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.

codespar consumers mandates-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/consumers/mandates/{id}/revoke · parameters, responses and refusals

codespar consumers

On this page