Skip to main content
Command reference

codespar test

Sandbox money (test keys only): credit a consumer directly, or mint a Pix charge and settle it

2 min read
View MarkdownEdit on GitHub

Sandbox money (test keys only): credit a consumer directly, or mint a Pix charge and settle it

4 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 test charges-pay

Pay a charge in the sandbox

codespar test charges-pay charge_0000000000000000 --input '{"amount_minor":1000}'
argumentwhat it is
<chargeId>String.
optionwhat 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/test/charges/{chargeId}/pay · parameters, responses and refusals

codespar test fund

Credit a consumer in the sandbox

codespar test fund --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"account":"string"}'
optionwhat 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/test/fund · parameters, responses and refusals

codespar test pix-in

Mint a sandbox Pix charge to fund a consumer

codespar test pix-in --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"description":"string"}'
optionwhat 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/test/pix-in · parameters, responses and refusals

codespar test settle-pix-in

Settle a sandbox Pix charge and credit the consumer

codespar test settle-pix-in --input '{"consumer_id":"csm_0000000000000000","amount_minor":1000,"transaction_id":"transaction_0000000000000000"}'
optionwhat 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/test/settle-pix-in · parameters, responses and refusals

codespar test | CodeSpar