Skip to main content
code<spar>
DocsCookbooksServersSandbox
REST client

Consents

The 4 operations under consents, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.23. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.23, 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/consents

Start a hosted consent

const  = await ..("/v1/consents", {
  : {
    : "agt_0000000000000000",
    : "person@example.com",
    : {
      : "string",
      : 1,
      : 1,
      : "BRL",
      : 0,
      : [
        "*"
      ],
      : "pix-key",
      : [
        "string"
      ],
      : [
        "string"
      ],
      : {
        : "day",
        : 1
      },
      : [
        {
          : "BRL",
          : "string",
          : 1,
          : 1
        }
      ],
      : "Example",
      : "string",
      : {}
    },
    : "https://example.com/hook",
    : "hosted"
  }
});

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

POST /v1/consents/init

POST/v1/consents/init
Deprecated

Start a hosted consent

const  = await ..("/v1/consents/init", {
  : {
    : "agt_0000000000000000",
    : "person@example.com",
    : {
      : "string",
      : 1,
      : 1,
      : "BRL",
      : 0,
      : [
        "*"
      ],
      : "pix-key",
      : [
        "string"
      ],
      : [
        "string"
      ],
      : {
        : "day",
        : 1
      },
      : [
        {
          : "BRL",
          : "string",
          : 1,
          : 1
        }
      ],
      : "Example",
      : "string",
      : {}
    },
    : "https://example.com/hook",
    : "hosted"
  }
});

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

GET /v1/consents/{token}

Read a pending consent

const  = await ..("/v1/consents/{token}", {
  : {
    : "string"
  }
});

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

POST /v1/consents/{token}/submit

Submit a consent and receive the signed mandate

const  = await ..("post", "/v1/consents/{token}/submit", {
  : {
    : "string"
  },
  : {
    : "csm_0000000000000000",
    : "pix-consent",
    : "string",
    : "Example",
    : {
      : "partner_session",
      : 0,
      : "string",
      : {
        : "whatsapp",
        : "message_0000000000000000",
        : "ses_0000000000000000",
        : 0,
        : "string",
        : "string",
        : "string",
        : {
          : "string",
          : "string",
          : "string"
        },
        : "string"
      }
    }
  }
});
// 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/consents/{token}/submit in the HTTP reference.

Edit on GitHub

Boletos you owe (DDA)

The 4 operations under dda, as typed calls on the generated REST client.

Mandates

The 5 operations under mandates, as typed calls on the generated REST client.

On this page

POST /v1/consentsPOST /v1/consents/initGET /v1/consents/{token}POST /v1/consents/{token}/submit
Consents | CodeSpar