# Welcome

## Overview

CryptoCadet is a lightweight, customizable payment processor that uses blockchain to reduce processing time from days to just seconds. It is almost 60,000 times faster than Stripe and just as easy to integrate. It’s just a button. You can add it to your Wordpress, Shopify, or any other kind of site and start receiving payments instantly. 

It is compatible with Ethereum and EVM-based chains (Binance, Polygon, Base, etc.) and Solana (SOL and SPL compatible). 

It is mobile-compatible, meaning a user can checkout via the browser and be redirected to the CryptoCadet **Liquid Processor** for a seamless checkout experience. 

The addition of the button not spoil the UX for your users either. For those who are looking for a secure payment option that won’t require them to input credit card information or risk identity theft, this option would be a no-brainer. 

\
You may find this product useful if:

1. You find your current payment processor to be slow or inefficient
2. You have an interest in adding crypto payments as an option but want to start with something simple
3. You are passionate about protecting consumer data from cyber attacks and want to offer your customers a more secure method of payment
4. You want to grow your business by launching an affiliate program
5. You have interest in web3 and would even consider launching your own token

### Purpose

These docs detail the various API commands that can be used to further customize the checkout experience. For help with basic installation (no-code option) please go to **`https://cryptocadet.app`** and search the help articles, or go to the **Help** section of **`https://ascendant.finance`.**

## Quick Links

{% content-ref url="/pages/f1hqcIJHgSkl55fUXZJy" %}
[Admin API](/admin-api/admin-gen-ref)
{% endcontent-ref %}

{% content-ref url="/pages/JB7RaLhGYEJZEy5i1ox6" %}
[User API](/user-api/user-get-user)
{% endcontent-ref %}

## Get Started

We've put together some helpful guides for you to get setup with our API quickly and easily.

{% content-ref url="/pages/9B1yMHCTiob5EdGh3nBb" %}
[/user/get-user](/user-api/user-get-user)
{% endcontent-ref %}

{% content-ref url="/pages/tTDslTV1rCG8JxgPpX8q" %}
[/admin/gen-ref](/admin-api/admin-gen-ref)
{% endcontent-ref %}

{% content-ref url="/pages/vPn5INQeKNHnPOGsydTX" %}
[/admin/update-solAddress](/admin-api/admin-update-soladdress)
{% endcontent-ref %}


# /admin/gen-ref

Generates a new referral code for a given wallet address. Remember to replace parameters with your own values.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/gen-ref`, {
apiKey, 
secretKey, 
walletAddress, 
percent, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

walletAddress: 0x2jskEWGJkjd1384haah04716jx000

percent: 3

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: New referral code generated: ${refCode}\`
{% endtab %}
{% endtabs %}


# /admin/update-ref

Updates an existing referral code with either a new wallet address or commission percentage. Remember to replace parameters with your own values.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-ref`, {
apiKey, 
secretKey, 
walletAddress, 
refCode,
percent, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

walletAddress: 0x2jskEWGJkjd1384haah04716jx000

refCode: ah1j387

percent: 3

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: `New wallet address registered for referral code: ${refCode}`
{% endtab %}
{% endtabs %}


# /admin/gen-ref-sol

Generates a new referral code for a SOL wallet address. Remember to replace parameters with your own values.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/gen-ref-sol`, {
apiKey, 
secretKey, 
solAddress, 
percent, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

solAddress: SL2jskEWGJkjd1384haah04716jx000

percent: 3

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: New referral code generated: ${refCode}
{% endtab %}
{% endtabs %}


# /admin/update-ref-sol

Updates an existing referral code with either a new SOL wallet address or commission percentage. Remember to replace parameters with your own values.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/gen-ref-sol`, {
apiKey, 
secretKey, 
solAddress, 
refCode
percent, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

solAddress: SL2jskEWGJkjd1384haah04716jx000

refCode: 81xhw1

percent: 3

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: New wallet address registered for referral code: ${refCode}
{% endtab %}
{% endtabs %}


# /admin/update-watchlist

Updates the watchlist for the price tracker. Limit 5 total.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-watchlist`, {
apiKey, 
secretKey, 
symbol, 
tokenData, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

symbol: FUSDT

tokenData: {decimals: 6, network: Polygon, token: 0x2jskEWGJkjd1384haah04716jx000}

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: ${symbol} added to user watchlist successfully!
{% endtab %}
{% endtabs %}


# /admin/cancel-subscription

Cancels the premium subscription. User will be able to access features until what would have been the next billing period or after 30 days, whichever is shorter.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/cancel-subscription`, {
apiKey, 
secretKey, 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: Subscription canceled successfully. You will continue to have premium access until ${new Date( updatedUser.endDate )}
{% endtab %}
{% endtabs %}


# /admin/update-walletAddress

Updates wallet address associated with the account.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-walletAddress`, {
apiKey, 
secretKey,
walletAddress 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

walletAddress: 0x2jskEWGJkjd1384haah04716jx000

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: ${newAddress}
{% endtab %}
{% endtabs %}


# /admin/update-solAddress

Updates SOL wallet address associated with the account.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-solAddress`, {
apiKey, 
secretKey,
walletAddress 
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

walletAddress: SL2jskEWGJkjd1384haah04716jx000

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: ${newAddress}
{% endtab %}
{% endtabs %}


# /admin/update-pubKey

Updates public key associated with the account. Note: The apiKey is your current public key. The public key generated will become the new one.

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-pubKey`, {
apiKey, 
secretKey,
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: ${newKey}
{% endtab %}
{% endtabs %}


# /admin/update-secretKey

Updates secret key associated with the account. Note: The secret key should be kept secret at all times and not be shared!

```javascript
await axios.post(`https://api.cryptocadet.app/api/admin/update-secretKey`, {
apiKey, 
secretKey,
uid
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

secretKey: sk-wwh284h2ksjfshshshsjh

uid: XP27shj24190ws
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: ${newKey}
{% endtab %}
{% endtabs %}


# /user/get-user

Returns the user.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/get-user`, {
apiKey
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {user}
{% endtab %}
{% endtabs %}


# /user/get-ref

Returns the wallet address and referral percentage of the referral code.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/get-ref`, {
apiKey,
refCode
})
```

{% tabs %}
{% tab title="Parameters" %}
apiKey: Vxusewjwhjwrhkwwj181ksl

refCode: 84xh24p
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {walletAddress, percent}
{% endtab %}
{% endtabs %}


# /user/options

Returns the ABI of a given token address.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/options`, {
network,
token
})
```

{% tabs %}
{% tab title="Parameters" %}
network: Binance

token: 0x76A797A59Ba2C17726896976B7B3747BfD1d220f
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {response}
{% endtab %}
{% endtabs %}


# /user/get-proxy

If the token address belongs to a proxy contract, returns the ABI of the proxied contract.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/get-proxy`, {
network,
token
})
```

{% tabs %}
{% tab title="Parameters" %}
network: Binance

token: 0x76A797A59Ba2C17726896976B7B3747BfD1d220f
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {response}
{% endtab %}
{% endtabs %}


# /user/config

Returns router address.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/config`, {
network
})
```

{% tabs %}
{% tab title="Parameters" %}
network: 'Binance'

{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {user}
{% endtab %}
{% endtabs %}


# /user/price

Returns price of a native token (ETH, BNB, MATIC, etc.)

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/price`, {
network
})
```

{% tabs %}
{% tab title="Parameters" %}
network: 'Ethereum'

{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {response}
{% endtab %}
{% endtabs %}


# /user/customPrice

Returns price of a custom (non-native) token on a given network.

```javascript
await axios.post(`https://api.cryptocadet.app/api/user/customPrice`, {
network,
token,
decimals
})
```

{% tabs %}
{% tab title="Parameters" %}
network: 'Ethereum'

token: '0xdAC17F958D2ee523a2206206994597C13D831ec7'

decimals: 6
{% endtab %}

{% tab title="Response" %}
Status: 200

Data: {response}
{% endtab %}
{% endtabs %}