Bank consents (legacy /ofb path)
The 5 operations under ofb, as typed calls on the generated REST client.
Bank consents (legacy /ofb path)
Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.
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 });POST /v1/ofb/consents
/v1/ofb/consentsInitiate a bank consent
const result = await cs.api.post("/v1/ofb/consents", {
body: {
bank_id: "bank_0000000000000000",
consumer_id: "csm_0000000000000000",
scopes: [
"string"
],
redirect_url: "https://example.com/hook",
wallet_id: "wlt_0000000000000000"
}
});Parameters, body and every documented response: POST /v1/ofb/consents in the HTTP reference.
GET /v1/ofb/consents/{id}
/v1/ofb/consents/{id}Read one bank consent
const result = await cs.api.get("/v1/ofb/consents/{id}", {
path: {
id: "consent_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/ofb/consents/{id} in the HTTP reference.
POST /v1/ofb/consents/{id}/callback
/v1/ofb/consents/{id}/callbackFinalise a consent after the consumer authorises it
const result = await cs.api.post("/v1/ofb/consents/{id}/callback", {
path: {
id: "consent_0000000000000000"
},
body: {
auth_code: "string"
}
});Parameters, body and every documented response: POST /v1/ofb/consents/{id}/callback in the HTTP reference.
POST /v1/ofb/consents/{id}/refresh-statement
/v1/ofb/consents/{id}/refresh-statementFetch the bank statement and ingest it
const result = await cs.api.post("/v1/ofb/consents/{id}/refresh-statement", {
path: {
id: "consent_0000000000000000"
},
body: {
since: "2026-01-15T12:00:00.000Z",
until: "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
/v1/ofb/consents/{id}/revokeRevoke a bank consent
const result = await cs.api.post("/v1/ofb/consents/{id}/revoke", {
path: {
id: "consent_0000000000000000"
},
body: {
reason: "string"
}
});Parameters, body and every documented response: POST /v1/ofb/consents/{id}/revoke in the HTTP reference.