Pix in

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.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/consumers/{consumerId}/pix/charges/{reference}

A minted Pix charge's state

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

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

GET /v1/consumers/{consumerId}/pix/receivements/{endToEndId}

Did this specific Pix land on this consumer's account

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

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