Skip to main content
REST client

Onboarding

The 3 operations under onboarding, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.29. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.27, 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 ({ : .. });

GET /v1/onboarding

The first-access guide's progress for the project

const  = await ..("/v1/onboarding");

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

GET /v1/onboarding/first-receive

The project's first test receipt (the guide's Receber R$ 10)

const result = await cs.api.get("/v1/onboarding/first-receive");

This path is in the published OpenAPI document but @codespar/sdk 0.16.27 (the version these docs compile against) does not type it, so this one example is not compiled. The call works over HTTP today.

Parameters, body and every documented response: GET /v1/onboarding/first-receive in the HTTP reference.

POST /v1/onboarding/first-receive

POST/v1/onboarding/first-receive
Moves money

has the Test payer pay the open attempt (one payment per charge)

Take the project's first test receipt one step further

const result = await cs.api.post("/v1/onboarding/first-receive");

This path is in the published OpenAPI document but @codespar/sdk 0.16.27 (the version these docs compile against) does not type it, so this one example is not compiled. The call works over HTTP today.

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

Onboarding | CodeSpar