Bank consents
The 6 operations under bank-consents, as typed calls on the generated REST client.
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 ({ : .. });GET /v1/bank-consents
List Open Finance bank consents
const = await ..("/v1/bank-consents");Parameters, body and every documented response: GET /v1/bank-consents in the HTTP reference.
POST /v1/bank-consents
Initiate a bank consent
const = await ..("post", "/v1/bank-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/bank-consents in the HTTP reference.
GET /v1/bank-consents/{id}
Read one bank consent
const = await ..("/v1/bank-consents/{id}", {
: {
: "bankconsent_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/bank-consents/{id} in the HTTP reference.
POST /v1/bank-consents/{id}/callback
Finalise a consent after the consumer authorises it
const = await ..("post", "/v1/bank-consents/{id}/callback", {
: {
: "bankconsent_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/bank-consents/{id}/callback in the HTTP reference.
POST /v1/bank-consents/{id}/refresh-statement
Fetch the bank statement and ingest it
const = await ..("post", "/v1/bank-consents/{id}/refresh-statement", {
: {
: "bankconsent_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/bank-consents/{id}/refresh-statement in the HTTP reference.
POST /v1/bank-consents/{id}/revoke
Revoke a bank consent
const = await ..("/v1/bank-consents/{id}/revoke", {
: {
: "bankconsent_0000000000000000"
},
: {
: "string"
}
});Parameters, body and every documented response: POST /v1/bank-consents/{id}/revoke in the HTTP reference.