Consumer funding
The 4 operations under funding, as typed calls on the generated REST client.
Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it 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/consumers/{consumerId}/fund/pix-in
/v1/consumers/{consumerId}/fund/pix-inMint a sandbox Pix charge to fund a consumer (deprecated path)
const = await ..("post", "/v1/consumers/{consumerId}/fund/pix-in", {
: {
: "csm_0000000000000000"
},
: {
: "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/consumers/{consumerId}/fund/pix-in in the HTTP reference.
POST /v1/consumers/{consumerId}/fund/pix-in/settle
/v1/consumers/{consumerId}/fund/pix-in/settleSettles the charge the mint produced and credits the consumer.
Settle a sandbox Pix charge and credit the consumer (deprecated path)
const = await ..("post", "/v1/consumers/{consumerId}/fund/pix-in/settle", {
: {
: "csm_0000000000000000"
},
: {
: "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/consumers/{consumerId}/fund/pix-in/settle in the HTTP reference.
POST /v1/consumers/{consumerId}/fund/sandbox
/v1/consumers/{consumerId}/fund/sandboxCredits the consumer's sandbox account directly, without going through a Pix.
Credit a consumer in the sandbox (deprecated path)
const = await ..("post", "/v1/consumers/{consumerId}/fund/sandbox", {
: {
: "csm_0000000000000000"
},
: {
: "csm_0000000000000000",
: 1000,
: "string",
: "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/consumers/{consumerId}/fund/sandbox in the HTTP reference.
GET /v1/consumers/{consumerId}/fund/{txId}
Poll an onramp, and credit the wallet when it settles
const = await ..("/v1/consumers/{consumerId}/fund/{txId}", {
: {
: "csm_0000000000000000",
: "tx_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/consumers/{consumerId}/fund/{txId} in the HTTP reference.