Command reference
codespar pix-keys
Pix keys of a consumer's own account: list, register, delete (with --confirm)
1 min read
Pix keys of a consumer's own account: list, register, delete (with --confirm)
3 commands in @codespar/cli 0.22.1.
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 pix-keys list
List the account's Pix keys, read from the bank
codespar pix-keys list [options]| option | what it does |
|---|---|
--consumer <id> | The consumer whose account (a Test project's own account is sbx_<projectId>) |
codespar pix-keys register
Register one Pix key; a random key (EVP) by default, the only type a Test project's own account takes
codespar pix-keys register [options]| option | what it does |
|---|---|
--consumer <id> | The consumer whose account |
--type <type> | EVP |
--key <value> | The key value for CPF, CNPJ, EMAIL or PHONE |
codespar pix-keys delete
Delete one Pix key; sends nothing without --confirm
codespar pix-keys delete [options] <key>| option | what it does |
|---|---|
--consumer <id> | The consumer whose account |
--confirm | You confirmed: after it is deleted, the key no longer points to this account |