Skip to main content
code<spar>
DocsGuidesServersSandbox
REST client

Bank consents (legacy /ofb path)

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

1 min read
View MarkdownEdit on GitHub

Bank consents (legacy /ofb path)

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

const  = new ({ : .. });

POST /v1/ofb/consents

POST/v1/ofb/consents

Initiate a bank consent

const  = await ..("/v1/ofb/consents", {
  : {
    : "bank_0000000000000000",
    : "csm_0000000000000000",
    : [
      "string"
    ],
    : "https://example.com/hook",
    : "wlt_0000000000000000"
  }
});

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

GET /v1/ofb/consents/{id}

GET/v1/ofb/consents/{id}
Deprecated

Read one bank consent

const  = await ..("/v1/ofb/consents/{id}", {
  : {
    : "consent_0000000000000000"
  }
});

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

POST /v1/ofb/consents/{id}/callback

POST/v1/ofb/consents/{id}/callback

Finalise a consent after the consumer authorises it

const  = await ..("/v1/ofb/consents/{id}/callback", {
  : {
    : "consent_0000000000000000"
  },
  : {
    : "string"
  }
});

Parameters, body and every documented response: POST /v1/ofb/consents/{id}/callback in the HTTP reference.

POST /v1/ofb/consents/{id}/refresh-statement

POST/v1/ofb/consents/{id}/refresh-statement

Fetch the bank statement and ingest it

const  = await ..("/v1/ofb/consents/{id}/refresh-statement", {
  : {
    : "consent_0000000000000000"
  },
  : {
    : "2026-01-15T12:00:00.000Z",
    : "2026-01-15T12:00:00.000Z"
  }
});

Parameters, body and every documented response: POST /v1/ofb/consents/{id}/refresh-statement in the HTTP reference.

POST /v1/ofb/consents/{id}/revoke

POST/v1/ofb/consents/{id}/revoke

Revoke a bank consent

const  = await ..("/v1/ofb/consents/{id}/revoke", {
  : {
    : "consent_0000000000000000"
  },
  : {
    : "string"
  }
});

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

Edit on GitHub

Bank consents

The 1 operation under bank-consents, as typed calls on the generated REST client.

Sessions

The 12 operations under sessions, as typed calls on the generated REST client.

On this page

Bank consents (legacy /ofb path)POST /v1/ofb/consentsGET /v1/ofb/consents/{id}POST /v1/ofb/consents/{id}/callbackPOST /v1/ofb/consents/{id}/refresh-statementPOST /v1/ofb/consents/{id}/revoke
Bank consents (legacy /ofb path) | CodeSpar