Cards
The 5 operations under cards, 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/cards
List issued cards
const = await ..("/v1/cards");Parameters, body and every documented response: GET /v1/cards in the HTTP reference.
POST /v1/cards
Issue a card under a signed mandate
const = await ..("post", "/v1/cards", {
: {
: "string",
: "BRL",
: {
: "Example",
: "person@example.com",
: "string",
: {
: "string",
: "string",
: "string"
},
: {
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string"
},
: "string"
},
: "mandate_0000000000000000",
: {}
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/cards in the HTTP reference.
GET /v1/cards/{id}
Read an issued card, or the mint flow that is producing one
const = await ..("/v1/cards/{id}", {
: {
: "card_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/cards/{id} in the HTTP reference.
POST /v1/issuer/cards
/v1/issuer/cardsIssue a card under a signed mandate (deprecated path)
const = await ..("post", "/v1/issuer/cards", {
: {
: "string",
: "BRL",
: {
: "Example",
: "person@example.com",
: "string",
: {
: "string",
: "string",
: "string"
},
: {
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string",
: "string"
},
: "string"
},
: "mandate_0000000000000000",
: {}
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/issuer/cards in the HTTP reference.
GET /v1/issuer/cards/{id}
/v1/issuer/cards/{id}Read one issued card, or the mint flow behind it
const = await ..("/v1/issuer/cards/{id}", {
: {
: "card_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/issuer/cards/{id} in the HTTP reference.