Skip to main content
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

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 ({ : .. });

POST /v1/ofb/consents

POST/v1/ofb/consents
Deprecated

Initiate a bank consent (legacy path)

const  = await ..("post", "/v1/ofb/consents", {
  : {
    : "bank_0000000000000000",
    : "csm_0000000000000000",
    : [
      "string"
    ],
    : "https://example.com/hook",
    : "wlt_0000000000000000"
  }
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
  .(.);
}

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
Deprecated

Finalise a consent after the consumer authorises it (legacy path)

const  = await ..("post", "/v1/ofb/consents/{id}/callback", {
  : {
    : "consent_0000000000000000"
  },
  : {
    : "string"
  }
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
  .(.);
}

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
Deprecated

Fetch the bank statement and ingest it (legacy path)

const  = await ..("post", "/v1/ofb/consents/{id}/refresh-statement", {
  : {
    : "consent_0000000000000000"
  },
  : {
    : "2026-01-15T12:00:00.000Z",
    : "2026-01-15T12:00:00.000Z"
  }
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
  .(.);
}

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
Deprecated

Revoke a bank consent (legacy path)

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.

Bank consents (legacy /ofb path) | CodeSpar