Pix keys (DICT)
The 3 operations under pix-keys, 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 ({ : .. });GET /v1/consumers/{consumerId}/pix-keys
List the Pix keys on the consumer's account
const = await ..("get", "/v1/consumers/{consumerId}/pix-keys", {
: {
: "csm_0000000000000000"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
.(.);
}Parameters, body and every documented response: GET /v1/consumers/{consumerId}/pix-keys in the HTTP reference.
POST /v1/consumers/{consumerId}/pix-keys
Register a Pix key on the consumer's account
const = await ..("post", "/v1/consumers/{consumerId}/pix-keys", {
: {
: "csm_0000000000000000"
},
: {
: "EVP",
: "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}/pix-keys in the HTTP reference.
DELETE /v1/consumers/{consumerId}/pix-keys/{key}
Delete a Pix key from the consumer's account
const = await ..("delete", "/v1/consumers/{consumerId}/pix-keys/{key}", {
: {
: "csm_0000000000000000",
: "string"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
.(.);
}Parameters, body and every documented response: DELETE /v1/consumers/{consumerId}/pix-keys/{key} in the HTTP reference.