Skip to main content
REST client

Sandbox money

The 5 operations under test, 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.23. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.23, 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/test/charges/{chargeId}/pay

POST/v1/test/charges/{chargeId}/pay
Moves money

ledger `fund()` with the `pending -> settled` claim

Pay a charge in the sandbox

const  = await ..("post", "/v1/test/charges/{chargeId}/pay", {
  : {
    : "charge_0000000000000000"
  },
  : {
    : 1000
  }
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

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

POST /v1/test/charges/{chargeId}/scenarios

Run a controlled provider-event scenario on a test charge

const  = await ..("post", "/v1/test/charges/{chargeId}/scenarios", {
  : {
    : "charge_0000000000000000"
  },
  : {
    : "late_after_cancel"
  }
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

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

POST /v1/test/fund

POST/v1/test/fund
Moves money

Credits the consumer's sandbox account directly, without going through a Pix.

Credit a consumer in the sandbox

const  = await ..("post", "/v1/test/fund", {
  : {
    : "csm_0000000000000000",
    : 1000,
    : "string",
    : "string"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

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

POST /v1/test/pix-in

Mint a sandbox Pix charge to fund a consumer

const  = await ..("post", "/v1/test/pix-in", {
  : {
    : "csm_0000000000000000",
    : 1000,
    : "string"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

Parameters, body and every documented response: POST /v1/test/pix-in in the HTTP reference.

POST /v1/test/settle-pix-in

POST/v1/test/settle-pix-in
Moves money

Settles the charge the mint produced and credits the consumer.

Settle a sandbox Pix charge and credit the consumer

const  = await ..("post", "/v1/test/settle-pix-in", {
  : {
    : "csm_0000000000000000",
    : 1000,
    : "transaction_0000000000000000"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

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

Sandbox money | CodeSpar