Charges

Available from @codespar/sdk 0.12.0; the version on npm is 0.15.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check 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/charges

List charges

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

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

POST /v1/charges

Issue a charge

const result = await cs.api.post("/v1/charges", {
  body: {
    amount: 1000,
    currency: "BRL",
    method: "string",
    description: "string",
    buyer: {},
    due_date: "string",
    idempotency_key: "string",
    country: "string",
    metadata: {}
  }
});

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

GET /v1/charges/{chargeId}

Read a charge

const result = await cs.api.get("/v1/charges/{chargeId}", {
  path: {
    chargeId: "charge_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/charges/{chargeId} in the HTTP reference.

POST /v1/charges/{chargeId}/cancel

Withdraw a charge

const result = await cs.api.post("/v1/charges/{chargeId}/cancel", {
  path: {
    chargeId: "charge_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/charges/{chargeId}/cancel in the HTTP reference.