# @koibanx/crypto-checkout-sdk

> Crypto Checkout SDK

Latest version **0.1.13** (published 2025-06-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @koibanx/crypto-checkout-sdk
pnpm add @koibanx/crypto-checkout-sdk
yarn add @koibanx/crypto-checkout-sdk
bun add @koibanx/crypto-checkout-sdk
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.13 |
| Published | 2025-06-02 |
| First published | 2022-12-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 82.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | koibanx |
| Maintainers | npm_koibanx, infra-koibanx |

## Links

- npm: https://www.npmjs.com/package/@koibanx/crypto-checkout-sdk
- Repository: https://gitlab.com/koibanx/modules/sdks/crypto-checkout-sdk
- Homepage: https://gitlab.com/koibanx/modules/sdks/crypto-checkout-sdk#readme
- Issues: https://gitlab.com/koibanx/modules/sdks/crypto-checkout-sdk/issues
- npm.io page: https://npm.io/package/@koibanx/crypto-checkout-sdk

## Dependencies (2)

- [url-join](https://npm.io/package/url-join.md) ^5.0.0
- [@koibanx/http](https://npm.io/package/@koibanx/http.md) 0.2.1

## Recent versions

- 0.1.13 (latest) — 2025-06-02
- 0.1.12 — 2024-01-10
- 0.1.11 — 2024-01-09
- 0.1.10 — 2023-12-05
- 0.1.9 — 2023-09-12
- 0.1.8 — 2023-09-12
- 0.1.7 — 2023-08-04
- 0.1.6 — 2023-07-05
- 0.1.5 — 2023-07-05
- 0.1.4 — 2023-07-05
- 0.1.3 — 2023-06-06
- 0.1.2 — 2023-06-01
- 0.1.1 — 2023-05-23
- 0.1.0 — 2023-03-31
- 0.0.4 — 2023-03-16
- … 3 more at https://npm.io/package/@koibanx/crypto-checkout-sdk/versions

## README

# Koibanx Crypto Checkout SDK

 Crypto Checkout SDK based in module Crypto Checkout

### Description

The Module Crypto Checkout handles:

## SDK Documentation

[Feast yourself](https://gitlab.com/koibanx/modules/sdks/crypto-checkout-sdk/-/wikis/Exports)

## Installation

``` bash
npm install @koibanx/crypto-checkout-sdk
```
> NOTE: you **must** have the npm token in your .npmrc file
---
## Initialization

### Node

Using ES6 `import`
```ts
import CryptoCheckoutSdk from '@koibanx/crypto-checkout-sdk';

const cryptoCheckout = CryptoCheckoutSdk({
  baseURL: 'http://your-url',
});
```

With `require`
```js
exports.__esModule = true;
const CryptoCheckoutSdk = require('@koibanx/crypto-checkout-sdk')["default"];

const cryptoCheckout = CryptoCheckoutSdk({
  baseURL: 'http://your-url',
});
```

### Types

- Typescript (`@koibanx/crypto-checkout-sdk/dist/index.d.ts`)

---

## Examples

Using ES6 `import`
```ts
import CryptoCheckoutSdk from "@koibanx/crypto-checkout-sdk";

const cryptoCheckout = CryptoCheckoutSdk({
    baseURL: 'http://your-url',
})

const catchError = (err, modulo) => {
  console.log('Modulo: ', modulo);
  console.log('details: ', err.details);
  console.log('shortMessage: ', err.message);
  console.log('errorCode: ', err.code);
}

/** 
 * Create Order
*/
cryptoCheckoutSDK.order.createOrder({
  amount: 10,
  currency: 'eth',
  network: 'ethereum',
  chargeCurrency: 'algo',
  chargesCount: 1,
  callback: 'https://webhook.site/f4754ad0-fd03-43a2-b91a-cb30c5b22034',
}).then((res) => {
  console.log('createOrder: ', res.status);
}).catch((err) => catchError(err, 'createOrder'));

/** 
 * Get Order
*/
cryptoCheckoutSDK.order.getOrder({
  id: '639b99e94edc6c3ef26ce0c5',
}).then((res) => {
  console.log('getOrder: ', res._id);
}).catch((err) => catchError(err, 'getOrder'));

/** 
 * Add Charge To Order
*/
cryptoCheckoutSDK.order.addChargeToOrder({
  id: '639b988a4edc6c3ef26ce0af',
  amount: 1,
  currency: 'algo',
  network: 'algorand',
  callback: 'https://webhook.site/c495fc10-fea0-4ace-b462-dc576c49ed1a',
  accountId: '6362c806c1c3cce181307bee',
}).then((res) => {
  console.log('addChargeToOrder: ', res.id);
}).catch((err) => catchError(err, 'addChargeToOrder'));

/** 
 * Update Order
*/
cryptoCheckoutSDK.order.updateOrder({
  callback: 'http://test',
  id: '639b988a4edc6c3ef26ce0af',
}).then((res) => {
  console.log('updateOrder: ', res.modifiedCount);
}).catch((err) => catchError(err, 'updateOrder'));

/** 
 * Delete Order
*/
cryptoCheckoutSDK.order.deleteOrder({
  id: '639b988a4edc6c3ef26ce0af',
}).then((res) => {
  console.log('deleteOrder: ', res.modifiedCount);
}).catch((err) => catchError(err, 'deleteOrder'));

/**
 * ADDRESS
 */

/**
 * List Addresses
 */
cryptoCheckoutSDK.address.listAddresses().then((res) => {
  console.log('listAddresses: ', JSON.stringify(res.results));
}).catch((err) => catchError(err, 'listAddresses'));

/**
 * Create Address
 */
cryptoCheckoutSDK.address.createAddress({
  internalCurrencyCode: 'algo',
  callback: 'https://webhook.site/f4754ad0-fd03-43a2-b91a-cb30c5b22034',
}).then((res) => {
  console.log('createAddress: ', res._id);
}).catch((err) => catchError(err, 'createAddress'));

/**
 * Get Address
 */
cryptoCheckoutSDK.address.getAddress({
  id: '639cf008ff26b3665f51c14d',
}).then((res) => {
  console.log('getAddress: ', res.address);
}).catch((err) => catchError(err, 'getAddress'));

/**
 * Update Address
 */
cryptoCheckoutSDK.address.updateAddress({
  address_label: 'test',
  id: '639cf008ff26b3665f51c14d',
}).then((res) => {
  console.log('updateAddress: ', res.address_label);
}).catch((err) => catchError(err, 'updateAddress'));

/**
 * Delete Address
 */
cryptoCheckoutSDK.address.deleteAddress({
  id: '639cf008ff26b3665f51c14d',
}).then((res) => {
  console.log('deleteAddress: ', res.matchedCount);
}).catch((err) => catchError(err, 'deleteAddress'));

```

---
_Source: https://npm.io/package/@koibanx/crypto-checkout-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._