Mandates

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.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 { CodeSpar } from "@codespar/sdk";

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

GET /v1/mandates

List consumer allowances

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

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

GET /v1/mandates/{id}

Read one consumer allowance

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

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

POST /v1/mandates/{id}/pause

Pause an allowance

const result = await cs.api.post("/v1/mandates/{id}/pause", {
  path: {
    id: "mandate_0000000000000000"
  },
  body: {
    reason: "string"
  }
});

Parameters, body and every documented response: POST /v1/mandates/{id}/pause in the HTTP reference.

POST /v1/mandates/{id}/resume

Resume a paused allowance

const result = await cs.api.post("/v1/mandates/{id}/resume", {
  path: {
    id: "mandate_0000000000000000"
  },
  body: {
    reason: "string"
  }
});

Parameters, body and every documented response: POST /v1/mandates/{id}/resume in the HTTP reference.

POST /v1/mandates/{id}/revoke

Revoke an allowance

const result = await cs.api.post("/v1/mandates/{id}/revoke", {
  path: {
    id: "mandate_0000000000000000"
  },
  body: {
    reason: "string"
  }
});

Parameters, body and every documented response: POST /v1/mandates/{id}/revoke in the HTTP reference.