Test
The 3 operations under test, as typed calls on the generated REST client.
Test
Available from @codespar/sdk 0.12.0; the version on npm is 0.15.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.
Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.
import { } from "@codespar/sdk";
const = new ({ : .. });POST /v1/test/fund
/v1/test/fundCredita a conta de sandbox do consumidor direto, sem passar por um Pix.
Credit a consumer in the sandbox
const = await ..("post", "/v1/test/fund", {
: {
: "csm_0000000000000000",
: 1000,
: "string"
}
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/test/fund in the HTTP reference.
POST /v1/test/pix-in
/v1/test/pix-inMint a sandbox Pix charge to fund a consumer
const = await ..("post", "/v1/test/pix-in", {
: {
: "csm_0000000000000000",
: 1000,
: "string"
}
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/test/pix-in in the HTTP reference.
POST /v1/test/settle-pix-in
/v1/test/settle-pix-inLiquida a cobrança que a cunhagem produziu e credita o consumidor.
Settle a sandbox Pix charge and credit the consumer
const = await ..("post", "/v1/test/settle-pix-in", {
: {
: "csm_0000000000000000",
: 1000,
: "transaction_0000000000000000"
}
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/test/settle-pix-in in the HTTP reference.