Receipts

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

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

GET /v1/consumers/receipts/{id}

Read one agentic receipt

const result = await cs.api.get("/v1/consumers/receipts/{id}", {
  path: {
    id: "receipt_0000000000000000"
  }
});

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

POST /v1/consumers/receipts/{id}/delivery

Seal a delivery proof onto a receipt

const result = await cs.api.post("/v1/consumers/receipts/{id}/delivery", {
  path: {
    id: "receipt_0000000000000000"
  },
  body: {
    result: "confirmed",
    proof: "string",
    kind: "order_confirmation",
    nfe_chave: "string",
    at: "2026-01-15T12:00:00.000Z"
  }
});

Parameters, body and every documented response: POST /v1/consumers/receipts/{id}/delivery in the HTTP reference.

GET /v1/consumers/{consumerId}/receipts

A consumer's agentic receipts

const result = await cs.api.get("/v1/consumers/{consumerId}/receipts", {
  path: {
    consumerId: "csm_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/consumers/{consumerId}/receipts in the HTTP reference.