Account

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

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/account/agent-activity

BRL spent and received per agent, over a window

const result = await cs.api.get("/v1/account/agent-activity");

Parameters, body and every documented response: GET /v1/account/agent-activity in the HTTP reference.

GET /v1/account/balances

Account balances, per currency

const result = await cs.api.get("/v1/account/balances");

Parameters, body and every documented response: GET /v1/account/balances in the HTTP reference.

POST /v1/account/fund/sandbox

Add test balance (test projects only)

const r = await cs.api.response("post", "/v1/account/fund/sandbox", {
  body: {
    amount_minor: 1000,
    idempotency_key: "string",
    rail: "pix",
    target: "account",
    mandate_id: "mandate_0000000000000000",
    consumer_id: "csm_0000000000000000"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/account/fund/sandbox in the HTTP reference.

POST /v1/account/fund/sandbox/initial

Grant the initial test balance (test projects only, once)

const r = await cs.api.response("post", "/v1/account/fund/sandbox/initial");
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/account/fund/sandbox/initial in the HTTP reference.

POST /v1/account/fund/sandbox/refill

Refill the test balance (test projects only, confirmed)

const r = await cs.api.response("post", "/v1/account/fund/sandbox/refill", {
  body: {
    confirm: true
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/account/fund/sandbox/refill in the HTTP reference.

GET /v1/account/ledger

The project's ledger, every wallet merged

const result = await cs.api.get("/v1/account/ledger");

Parameters, body and every documented response: GET /v1/account/ledger in the HTTP reference.

GET /v1/account/payments

The project's payments, newest first

const result = await cs.api.get("/v1/account/payments");

Parameters, body and every documented response: GET /v1/account/payments in the HTTP reference.

GET /v1/account/sessions

The project's sessions, as the activity list draws them

const result = await cs.api.get("/v1/account/sessions");

Parameters, body and every documented response: GET /v1/account/sessions in the HTTP reference.

GET /v1/account/spenders

The mandates that can spend from this project

const result = await cs.api.get("/v1/account/spenders");

Parameters, body and every documented response: GET /v1/account/spenders in the HTTP reference.

GET /v1/account/statement

The account statement (extrato) of a period, as PDF

const result = await cs.api.get("/v1/account/statement", {
  query: {
    from: "2026-01-15",
    to: "2026-01-15"
  }
});

Parameters, body and every documented response: GET /v1/account/statement in the HTTP reference.

GET /v1/account/summary

BRL money in, agent spend, tool calls and sessions over a window

const result = await cs.api.get("/v1/account/summary");

Parameters, body and every documented response: GET /v1/account/summary in the HTTP reference.

GET /v1/account/test-balance

The test balance, the refill quota and the Adicionar fundos cap

const result = await cs.api.get("/v1/account/test-balance");

Parameters, body and every documented response: GET /v1/account/test-balance in the HTTP reference.