Skip to main content

codespar consumers

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

4 min read
View MarkdownEdit on GitHub

codespar consumers

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

19 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

codespar consumers list [options]
opçãoo que faz
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

codespar consumers create

POST /v1/consumers

codespar consumers create [options]
opçãoo 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}

codespar consumers get [options] <id>
opçãoo que faz
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

codespar consumers update

PATCH /v1/consumers/{id}

codespar consumers update [options] <id>
opçãoo 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

codespar consumers mandates-spend [options] <id>
opçãoo 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 list-pix-keys

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

codespar consumers list-pix-keys [options] <consumerId>
opçãoo 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

codespar consumers create-pix-keys [options] <consumerId>
opçãoo 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}

codespar consumers delete-pix-keys [options] <consumerId> <key>
opçãoo 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}

codespar consumers pix-charges [options] <consumerId> <reference>
opçãoo 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}

codespar consumers pix-receivements [options] <consumerId> <endToEndId>
opçãoo que faz
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

codespar consumers pix-devolutions

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

codespar consumers pix-devolutions [options] <consumerId> <devolutionId>
opçãoo 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}

codespar consumers fund [options] <consumerId> <txId>
opçãoo 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

codespar consumers wallet [options] <id>
opçãoo 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

codespar consumers list-mandates-card [options] <id>
opçãoo 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

codespar consumers delete-mandates-card [options] <id>
opçãoo 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

codespar consumers list-receipts [options] <consumerId>
opçãoo 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}

codespar consumers get-receipts [options] <id>
opçãoo que faz
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

codespar consumers contact-verifications

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

codespar consumers contact-verifications [options] <consumerId>
opçãoo 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

codespar consumers contact-verifications-verify [options] <consumerId> <id>
opçãoo 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 | CodeSpar