Consumers

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 { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/consumers

List titulars

const result = await cs.api.get("/v1/consumers");

Parameters, body and every documented response: GET /v1/consumers in the HTTP reference.

POST /v1/consumers

Create the titular, without a document

const result = await cs.api.post("/v1/consumers", {
  body: {
    display_name: "Example",
    metadata: {}
  }
});

Parameters, body and every documented response: POST /v1/consumers in the HTTP reference.

GET /v1/consumers/consents

List consent evidence (deprecated path)

const result = await cs.api.get("/v1/consumers/consents");

Parameters, body and every documented response: GET /v1/consumers/consents in the HTTP reference.

GET /v1/consumers/funding-sources

List consumer funding sources, optionally with live balance (deprecated path)

const result = await cs.api.get("/v1/consumers/funding-sources");

Parameters, body and every documented response: GET /v1/consumers/funding-sources in the HTTP reference.

GET /v1/consumers/mandates

List consumer allowances (legacy path)

const result = await cs.api.get("/v1/consumers/mandates");

Parameters, body and every documented response: GET /v1/consumers/mandates in the HTTP reference.

GET /v1/consumers/{id}

Read one titular, with the ids of what hangs off it

const result = await cs.api.get("/v1/consumers/{id}");

Parameters, body and every documented response: GET /v1/consumers/{id} in the HTTP reference.

PATCH /v1/consumers/{id}

Update the mutable fields of a titular

const result = await cs.api.patch("/v1/consumers/{id}", {
  body: {
    display_name: "Example",
    metadata: {},
    tax_type: "PJ"
  }
});

Parameters, body and every documented response: PATCH /v1/consumers/{id} in the HTTP reference.

GET /v1/consumers/{id}/wallet

The consumer's unified wallet, rolled up per currency

const result = await cs.api.get("/v1/consumers/{id}/wallet", {
  path: {
    id: "csm_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/consumers/{id}/wallet in the HTTP reference.