Pix out
The 2 operations under pix-devolutions, 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 ({ : .. });POST /v1/consumers/{consumerId}/pix/devolutions
/v1/consumers/{consumerId}/pix/devolutionsReturns money on the Pix rail itself
Reverse a Pix, in either direction
const = await ..("post", "/v1/consumers/{consumerId}/pix/devolutions", {
: {
: "csm_0000000000000000"
},
: {
: "endtoend_0000000000000000",
: 1000,
: "string",
: "string",
: "string",
: "inbound"
}
});
// 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 (.) {
.(.);
}The gates that refuse this call, the meaning of each refusal, parameters and every documented response: POST /v1/consumers/{consumerId}/pix/devolutions in the HTTP reference.
GET /v1/consumers/{consumerId}/pix/devolutions/{devolutionId}
A Pix devolution's state
const = await ..("/v1/consumers/{consumerId}/pix/devolutions/{devolutionId}", {
: {
: "csm_0000000000000000",
: "devolution_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/consumers/{consumerId}/pix/devolutions/{devolutionId} in the HTTP reference.