SHKeeper API

https://shkeeper.io/api
Admin
SHKeeper is an open-source, self-hosted cryptocurrency payment processor that functions as both a...
Tokens:11,819
Snippets:36
Trust Score:7.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get Metrics (CLI)

Source: https://shkeeper.io/api/index

Fetches Shkeeper metrics, providing insights into wallet status and other system operational data. Requires Basic Authentication with provided credentials.

```bash
curl --location --request GET 'https://demo.shkeeper.io/metrics' \
--user shkeeper:shkeeper
```

--------------------------------

### GET /api/v1/crypto - Get cryptocurrencies

Source: https://shkeeper.io/api/index

Retrieves a list of cryptocurrencies that are currently online and enabled for operations within SHKeeper.

```APIDOC
## GET /api/v1/crypto

### Description
Get a list of cryptocurrencies available for operation from SHKeeper (these are the ones that are online and not disabled in the admin panel).

### Method
GET

### Endpoint
/api/v1/crypto

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```sh
curl --location --request GET 'https://demo.shkeeper.io/api/v1/crypto'
```

### Response
#### Success Response (200)
- **crypto** (array) - A list of cryptocurrency symbols available for transactions.
- **crypto_list** (array) - A detailed list of cryptocurrencies with display names.
  - **display_name** (string) - The human-readable name of the cryptocurrency.
  - **name** (string) - The internal name or symbol of the cryptocurrency.
- **status** (string) - The status of the request, typically 'success'.

#### Response Example
```json
{
  "crypto": [
    "BNB",
    "BNB-USDT",
    "ETH-USDT",
    "BTC",
    "ETH",
    "BNB-USDC",
    "ETH-USDC"
  ],
  "crypto_list": [
    {
      "display_name": "BNB",
      "name": "BNB"
    },
    {
      "display_name": "BEP20 USDT",
      "name": "BNB-USDT"
    },
    {
      "display_name": "ERC20 USDT",
      "name": "ETH-USDT"
    },
    {
      "display_name": "Bitcoin",
      "name": "BTC"
    },
    {
      "display_name": "Ethereum",
      "name": "ETH"
    },
    {
      "display_name": "BEP20 USDC",
      "name": "BNB-USDC"
    },
    {
      "display_name": "ERC20 USDC",
      "name": "ETH-USDC"
    }
  ],
  "status": "success"
}
```
```

--------------------------------

### Get Available Cryptocurrencies using cURL

Source: https://shkeeper.io/api/index

This snippet demonstrates how to retrieve a list of cryptocurrencies supported by SHKeeper using a cURL command. It shows the basic GET request to the /api/v1/crypto endpoint.

```curl
curl --location --request GET 'https://demo.shkeeper.io/api/v1/crypto'
```

--------------------------------

### GET /metrics

Source: https://shkeeper.io/api/index

Retrieves Shkeeper metrics related to wallet status.

```APIDOC
## GET /metrics

### Description
Retrieves Shkeeper metrics related to wallet status.

### Method
GET

### Endpoint
`/metrics`

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/metrics' \
--user shkeeper:shkeeper
```

### Response
#### Success Response (200)
- **Content-Type**: text/plain
- **Body**: Metrics data in Prometheus exposition format.

#### Response Example
```text
# HELP geth_last_release_info Version of the latest release from https://github.com/bnb-chain/bsc/releases
# TYPE geth_last_release_info gauge
geth_last_release_info{name="v1.4.12",published_at="2024-07-24T04:18:53Z",tag_name="v1.4.12",version="1.4.12"} 1.0
# HELP geth_fullnode_version_info Current geth version in use
# TYPE geth_fullnode_version_info gauge
geth_fullnode_version_info{version="1.4.11"} 1.0
# HELP bnb_fullnode_status Connection status to bnb fullnode
# TYPE bnb_fullnode_status gauge
bnb_fullnode_status 1.0
# HELP bnb_fullnode_last_block Last block loaded to the fullnode
# TYPE bnb_fullnode_last_block gauge
bnb_fullnode_last_block 4.2715492e+07
# HELP bnb_wallet_last_block Last checked block
# TYPE bnb_wallet_last_block gauge
bnb_wallet_last_block 4.271549e+07
# HELP bnb_fullnode_last_block_timestamp Last block timestamp loaded to the fullnode
# TYPE bnb_fullnode_last_block_timestamp gauge
bnb_fullnode_last_block_timestamp 1.722866516e+09
# HELP bnb_wallet_last_block_timestamp Last checked block timestamp
```
```

--------------------------------

### CLI Request Sample to Get SHKeeper Invoice Information

Source: https://shkeeper.io/api/index

This sample demonstrates how to retrieve detailed invoice information from SHKeeper using the `curl` command-line tool. It requires the invoice's external ID and an API key for authorization.

```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/invoices/233822' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

--------------------------------

### GET /api/v1/{crypto_name}/balance

Source: https://shkeeper.io/api/index

Retrieves the cryptocurrency balance for the fee deposit account.

```APIDOC
## GET /api/v1/{crypto_name}/balance

### Description
Retrieves the cryptocurrency balance for the fee deposit account.

### Method
GET

### Endpoint
`/api/v1/{crypto_name}/balance`

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list. Enum: "BTC", "LTC", "DOGE", "XMR", "XRP", "ETH", "ETH-USDT", "ETH-USDC", "TRX", "USDT", "USDC", "AVAX", "AVALANCHE-USDT", "AVALANCHE-USDC", "BNB", "BNB-USDT", "BNB-USDC", "MATIC", "POLYGON-USDT", "POLYGON-USDC"

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH/balance' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

### Response
#### Success Response (200)
- **amount_crypto** (string) - The balance in cryptocurrency units
- **amount_fiat** (string) - The balance in fiat currency units
- **display_name** (string) - The display name of the cryptocurrency
- **fiat** (string) - The fiat currency used for conversion
- **name** (string) - The name of the cryptocurrency
- **rate** (string) - The current exchange rate
- **server_status** (string) - The status of the server synchronization

#### Response Example
```json
{
  "amount_crypto": "0.0213590094",
  "amount_fiat": "88.8201590493",
  "display_name": "Ethereum",
  "fiat": "USD",
  "name": "ETH",
  "rate": "4158.44000000",
  "server_status": "Synced"
}
```
```

--------------------------------

### GET /api/v1/transactions/{crypto_name}/{addr}

Source: https://shkeeper.io/api/index

Retrieves a list of transactions for a specific cryptocurrency and address.

```APIDOC
## GET /api/v1/transactions/{crypto_name}/{addr}

### Description
Retrieves a list of transactions for a specific cryptocurrency and address.

### Method
GET

### Endpoint
`/api/v1/transactions/{crypto_name}/{addr}`

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list. Enum: "BTC", "LTC", "DOGE", "XMR", "XRP", "ETH", "ETH-USDT", "ETH-USDC", "TRX", "USDT", "USDC", "AVAX", "AVALANCHE-USDT", "AVALANCHE-USDC", "BNB", "BNB-USDT", "BNB-USDC", "MATIC", "POLYGON-USDT", "POLYGON-USDC"
- **addr** (string) - Required - Cryptocurrency address

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH-USDC/addresses' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

### Response
#### Success Response (200)
- **transactions** (array) - List of transactions
  - **addr** (string) - The cryptocurrency address
  - **amount** (string) - The transaction amount
  - **crypto** (string) - The cryptocurrency name
  - **status** (string) - The transaction status (e.g., "CONFIRMED")
  - **txid** (string) - The transaction ID
- **status** (string) - The overall status of the request (e.g., "success")

#### Response Example
```json
{
  "transactions": [
    {
      "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
      "amount": "3.0000000000",
      "crypto": "ETH-USDC",
      "status": "CONFIRMED",
      "txid": "0xdaae319a0bee00f362f40ae725932c25a9b33bd33f3346ec22464361a56fcd1d"
    }
  ],
  "status": "success"
}
```
```

--------------------------------

### GET /api/v1/{crypto_name}/addresses

Source: https://shkeeper.io/api/index

Retrieves all generated cryptocurrency addresses for a specified cryptocurrency.

```APIDOC
## GET /api/v1/{crypto_name}/addresses

### Description
Retrieves all generated cryptocurrency addresses for a specified cryptocurrency.

### Method
GET

### Endpoint
/api/v1/{crypto_name}/addresses

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - Enum: "BTC" "LTC" "DOGE" "XMR" "XRP" "ETH" "ETH-USDT" "ETH-USDC" "TRX" "USDT" "USDC" "AVAX" "AVALANCHE-USDT" "AVALANCHE-USDC" "BNB" "BNB-USDT" "BNB-USDC" "MATIC" "POLYGON-USDT" "POLYGON-USDC" - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list.

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH-USDC/addresses' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

### Response
#### Success Response (200)
- **addresses** (array) - A list of generated cryptocurrency addresses.
- **status** (string) - The status of the request.

#### Response Example
```json
{
  "addresses": [
    "0x0A71f4741DcaD3C06AA51eE6cF0E22675507d0d0",
    "0x700b3453edfE0b1885dA9D41FE472451ceD1292d"
  ],
  "status": "success"
}
```
```

--------------------------------

### Create SHKeeper Invoice using cURL

Source: https://shkeeper.io/api/index

This example shows how to create or update a SHKeeper invoice using cURL. It includes the necessary JSON payload with external ID, fiat currency, amount, and a callback URL, sent to the payment_request endpoint.

```curl
curl --location --request POST 'https://demo.shkeeper.io/api/v1/ETH-USDC/payment_request' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_id": 107,
    "fiat": "USD",
    "amount": "7.8",
    "callback_url": "https://my-billing/callback.php"
}'
```

--------------------------------

### Get Crypto Balance by Crypto Name (CLI)

Source: https://shkeeper.io/api/index

Retrieves the balance information for a specified cryptocurrency in the fee deposit account. Requires a Shkeeper API Key. The response includes both cryptocurrency and fiat amounts, as well as exchange rates.

```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH/balance' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

--------------------------------

### Get Payment Info by Transaction ID and External ID (CLI)

Source: https://shkeeper.io/api/index

Fetches detailed payment information for a given transaction ID and an external identifier (e.g., order ID). Requires a Shkeeper API Key for authentication. This endpoint is useful for verifying payment status and details.

```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/tx-info/0xdaae319a0bee00f362f40ae725932c25a9b33bd33f3346ec22464361a56fcd1d/233822' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

--------------------------------

### GET /api/v1/tx-info/{txid}/{external_id}

Source: https://shkeeper.io/api/index

Retrieves payment information for a given transaction ID and external ID.

```APIDOC
## GET /api/v1/tx-info/{txid}/{external_id}

### Description
Retrieves payment information for a given transaction ID and external ID.

### Method
GET

### Endpoint
`/api/v1/tx-info/{txid}/{external_id}`

### Parameters
#### Path Parameters
- **txid** (string) - Required - Cryptocurrency payment transaction ID
- **external_id** (string) - Required - An identifier order_id or invoice_id from your store.

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/tx-info/0xdaae319a0bee00f362f40ae725932c25a9b33bd33f3346ec22464361a56fcd1d/233822' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

### Response
#### Success Response (200)
- **info** (object) - Payment information details
  - **addr** (string) - The cryptocurrency address
  - **amount** (string) - The transaction amount
  - **crypto** (string) - The cryptocurrency name
- **status** (string) - The overall status of the request (e.g., "success")

#### Response Example
```json
{
  "info": {
    "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
    "amount": "3.0000000000",
    "crypto": "ETH-USDC"
  },
  "status": "success"
}
```
```

--------------------------------

### Get SHKeeper Generated Addresses

Source: https://shkeeper.io/api/index

Retrieves all cryptocurrency addresses generated by SHKeeper for a specified cryptocurrency. Requires the cryptocurrency name. The response includes a list of addresses and the status.

```shell
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH-USDC/addresses' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

--------------------------------

### GET /api/v1/{crypto_name}/task/{task_id}

Source: https://shkeeper.io/api/index

Retrieves the status of a specific cryptocurrency payout task using its unique task ID and the cryptocurrency name.

```APIDOC
## GET /api/v1/{crypto_name}/task/{task_id}

### Description
Retrieves the status of a specific cryptocurrency payout task using its unique task ID and the cryptocurrency name.

### Method
GET

### Endpoint
/api/v1/{crypto_name}/task/{task_id}

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - Enum: "BTC" "LTC" "DOGE" "XMR" "XRP" "ETH" "ETH-USDT" "ETH-USDC" "TRX" "USDT" "USDC" "AVAX" "AVALANCHE-USDT" "AVALANCHE-USDC" "BNB" "BNB-USDT" "BNB-USDC" "MATIC" "POLYGON-USDT" "POLYGON-USDC" - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list.
- **task_id** (string) - Required - <uuid> - Payout task ID.

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH-USDT/task/8c618c4a-39fc-4c7a-b4f8-1661ea47fec6' \
--user admin:admin
```

### Response
#### Success Response (200)
- **result** (array) - An array of payout details, each containing amount, destination, status, and transaction IDs.
- **status** (string) - The overall status of the payout task.

#### Response Example
```json
{
  "result": [
    {
      "amount": "100",
      "dest": "TGusXhweqkJ1aJftjmAfLqA1rfEWD4hSGZ",
      "status": "success",
      "txids": [
        "da2996bae7a8a4d655a1288f8f4c79ce0aa3640e61f8ae8de08ae9c70c72d90d"
      ]
    },
    {
      "amount": "200.11",
      "dest": "TYtD9md7cHuB4P6kDd362jhcUGP7cJybF7",
      "status": "success",
      "txids": [
        "d8972ac9c964adbc25486d2cfdf2de7b61c3f0ca7510aa7cddc832a9bccdf551"
      ]
    }
  ],
  "status": "SUCCESS"
}
```
```

--------------------------------

### GET /api/v1/invoices/{external_id}

Source: https://shkeeper.io/api/index

Retrieves detailed information about the status of a created invoice in Shkeeper by its external ID.

```APIDOC
## GET /api/v1/invoices/{external_id}

### Description
Retrieves detailed information about the status of a created invoice in Shkeeper by its external ID.

### Method
GET

### Endpoint
/api/v1/invoices/{external_id}

### Parameters
#### Path Parameters
- **external_id** (string) - Required - An identifier order_id or invoice_id from your store.

### Request Example
```bash
curl --location --request GET 'https://demo.shkeeper.io/api/v1/invoices/233822' \
--header 'X-Shkeeper-Api-Key: fs9GYTyNdkjPHX36'
```

### Response
#### Success Response (200)
- **invoices** (array) - Description: An array containing invoice details.
  - **amount_fiat** (string) - Description: The amount in fiat currency.
  - **balance_fiat** (string) - Description: The current balance in fiat currency.
  - **external_id** (string) - Description: The external identifier of the invoice.
  - **fiat** (string) - Description: The fiat currency of the invoice.
  - **status** (string) - Description: The status of the invoice (e.g., OVERPAID).
  - **txs** (array) - Description: Array of transaction details associated with the invoice.
    - **addr** (string) - Description: The transaction address.
    - **amount** (string) - Description: The transaction amount.
    - **crypto** (string) - Description: The cryptocurrency used in the transaction.
    - **status** (string) - Description: The status of the transaction (e.g., CONFIRMED).
    - **txid** (string) - Description: The transaction ID.
- **status** (string) - Description: Overall status of the API request (e.g., success).

#### Response Example
```json
{
  "invoices": [
    {
      "amount_fiat": "10.0000000000",
      "balance_fiat": "23.0003000000",
      "external_id": "233822",
      "fiat": "USD",
      "status": "OVERPAID",
      "txs": [
        {
          "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
          "amount": "5.0000000000",
          "crypto": "ETH-USDT",
          "status": "CONFIRMED",
          "txid": "0x4f9df3c2255ee6f1bda50dfab1a84b87345aeaf89863afea9a2687e0e51d42dc"
        },
        {
          "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
          "amount": "3.0000000000",
          "crypto": "ETH-USDC",
          "status": "CONFIRMED",
          "txid": "0xdaae319a0bee00f362f40ae725932c25a9b33bd33f3346ec22464361a56fcd1d"
        }
      ]
    }
  ],
  "status": "success"
}
```

#### Error Responses
- **405** Method Not Allowed
- **500** Internal Server Error
```

--------------------------------

### POST /api/v1/multipayout

Source: https://shkeeper.io/api/index

Initiates a multipayout task. Note: Multipayout is not supported for XMR, BTC, LTC, and DOGE. Use the Payout method for these cryptocurrencies.

```APIDOC
## POST /api/v1/multipayout

### Description
Initiates a multipayout task. Note: Multipayout is not supported for XMR, BTC, LTC, and DOGE. Use the Payout method for these cryptocurrencies.

### Method
POST

### Endpoint
/api/v1/multipayout

### Parameters
#### Authorizations
Basic

#### Request Body
[Details for multipayout request body would be provided here, including fields for multiple payout destinations and amounts.]

### Response
#### Success Response (200)
[Details for success response, likely including task IDs for the payouts.]

#### Error Responses
[Details for potential error responses.]
```

--------------------------------

### Response Sample for Creating a Payout Task

Source: https://shkeeper.io/api/index

This JSON response indicates the successful creation of a payout task. It includes a unique task ID that can be used for tracking the payout operation.

```json
{
  "task_id": "b2a01bb0-8abe-403b-a3fa-8124c84bcf23"
}
```

--------------------------------

### POST /api/v1/{crypto_name}/multipayout

Source: https://shkeeper.io/api/index

Initiates a multi-cryptocurrency payout to specified destinations and amounts. Requires cryptocurrency name, destination address, and payout amount.

```APIDOC
## POST /api/v1/{crypto_name}/multipayout

### Description
Initiates a multi-cryptocurrency payout to specified destinations and amounts. Requires cryptocurrency name, destination address, and payout amount.

### Method
POST

### Endpoint
/api/v1/{crypto_name}/multipayout

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - Enum: "BTC" "LTC" "DOGE" "XMR" "XRP" "ETH" "ETH-USDT" "ETH-USDC" "TRX" "USDT" "USDC" "AVAX" "AVALANCHE-USDT" "AVALANCHE-USDC" "BNB" "BNB-USDT" "BNB-USDC" "MATIC" "POLYGON-USDT" "POLYGON-USDC" - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list.

#### Request Body
- **amount** (string) - Required - Payout amount.
- **dest** (string) - Required - Payout destination.
- **dest_tag** (string) - Optional - Useful for `XRP` payout, for providing dest in a plain format, otherwise you should convert it to `X-address` format manually.

### Request Example
```json
[
  {
    "dest": "0xBD26e3512ce84F315e90E3FE75907bfbB5bD0c44",
    "amount": "100"
  },
  {
    "dest": "0xE77895BAda700d663f033510f73f1E988CF55756",
    "amount": "200.11"
  }
]
```

### Response
#### Success Response (200)
- **task_id** (string) - Identifier for the payout task.

#### Response Example
```json
{
  "task_id": "b2a01bb0-8abe-403b-a3fa-8124c84bcf23"
}
```
```

--------------------------------

### Response Sample for SHKeeper Invoice Information

Source: https://shkeeper.io/api/index

This JSON response shows the details of an invoice retrieved from SHKeeper. It includes the invoice status, payment details like balance and external ID, and a list of associated transactions with their amounts, cryptocurrencies, and status.

```json
{
  "invoices": [
    {
      "amount_fiat": "10.0000000000",
      "balance_fiat": "23.0003000000",
      "external_id": "233822",
      "fiat": "USD",
      "status": "OVERPAID",
      "txs": [
        {
          "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
          "amount": "5.0000000000",
          "crypto": "ETH-USDT",
          "status": "CONFIRMED",
          "txid": "0x4f9df3c2255ee6f1bda50dfab1a84b87345aeaf89863afea9a2687e0e51d42dc"
        },
        {
          "addr": "0xE77895BAda700d663f033510f73f1E988CF55756",
          "amount": "3.0000000000",
          "crypto": "ETH-USDC",
          "status": "CONFIRMED",
          "txid": "0xdaae319a0bee00f362f40ae725932c25a9b33bd33f3346ec22464361a56fcd1d"
        }
      ]
    }
  ],
  "status": "success"
}
```

--------------------------------

### Request Payload Sample for Creating a Payout Task

Source: https://shkeeper.io/api/index

This JSON payload defines the parameters required to create a single payout task. It includes the cryptocurrency name, the amount to be paid, the destination address, and the transaction fee.

```json
{
  "amount": 107,
  "destination": "0xBD26e3512ce84F315e90E3FE75907bfbB5bD0c44",
  "fee": "10"
}
```

--------------------------------

### POST /api/v1/{crypto_name}/payout

Source: https://shkeeper.io/api/index

Initiates a cryptocurrency payout task. This endpoint allows you to send cryptocurrency to a specified address.

```APIDOC
## POST /api/v1/{crypto_name}/payout

### Description
Initiates a cryptocurrency payout task. This endpoint allows you to send cryptocurrency to a specified address.

### Method
POST

### Endpoint
/api/v1/{crypto_name}/payout

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - Enum: "BTC" "LTC" "DOGE" "XMR" "XRP" "ETH" "ETH-USDT" "ETH-USDC" "TRX" "USDT" "USDC" "AVAX" "AVALANCHE-USDT" "AVALANCHE-USDC" "BNB" "BNB-USDT" "BNB-USDC" "MATIC" "POLYGON-USDT" "POLYGON-USDC" - An identifier for cryptocurrency. Check Get cryptocurrencies to get all available list.

#### Request Body
- **amount** (string) - Required - Payout amount.
- **destination** (string) - Required - Destination address. For `XRP`, the destination address must be provided in the `X-address` format.
- **fee** (string) - Required - Transaction fee. For `BTC`, it is specified in `sat/vByte`; for `LTC` and `DOGE`, it is in `sat/Byte`. For `XMR`, an integer (1-4) is passed to set the transaction priority: `1` - Unimportant, `2` - Normal, `3` - Elevated, `4` - Priority. For other cryptocurrencies, any value can be passed, the optimal fee is calculated and set automatically, and this field is ignored.

### Request Example
```json
{
  "amount": 107,
  "destination": "0xBD26e3512ce84F315e90E3FE75907bfbB5bD0c44",
  "fee": "10"
}
```

### Response
#### Success Response (200)
- **task_id** (string) - Description: The unique identifier for the created payout task.

#### Response Example
```json
{
  "task_id": "b2a01bb0-8abe-403b-a3fa-8124c84bcf23"
}
```

#### Error Responses
- **405** Method Not Allowed
- **500** Internal Server Error
- **default** Unexpected error
```

--------------------------------

### POST /api/v1/decryption-key

Source: https://shkeeper.io/api/index

Decrypts wallets using a provided decryption key. This is typically used on the first run of SHKeeper on demand.

```APIDOC
## POST /api/v1/decryption-key

### Description
Decrypts wallets using a provided decryption key. This is typically used on the first run of SHKeeper on demand.

### Method
POST

### Endpoint
/api/v1/decryption-key

### Parameters
#### Request Body
- **key** (string) - Required - Decryption key that was set on the first run of SHKeeper on demand.

### Request Example
```
key=sikfl5llLFt5is50dsfk4yvldti0034jfmmeJm
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the decryption process (e.g., "success").

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Submit Cryptocurrency Multipayout

Source: https://shkeeper.io/api/index

Submits a request to payout multiple cryptocurrency amounts to specified destinations. Requires cryptocurrency name, destination address, and amount. The response includes a task ID for tracking.

```json
[
  {
    "dest": "0xBD26e3512ce84F315e90E3FE75907bfbB5bD0c44",
    "amount": "100"
},
  {
    "dest": "0xE77895BAda700d663f033510f73f1E988CF55756",
    "amount": "200.11"
}
]
```

--------------------------------

### POST /api/v1/{crypto_name}/payment_request - Create/Update SHKeeper invoice

Source: https://shkeeper.io/api/index

Creates or updates an invoice for a specific cryptocurrency. This endpoint is protected by API Key authentication.

```APIDOC
## POST /api/v1/{crypto_name}/payment_request

### Description
Creates or updates a SHKeeper invoice for a specified cryptocurrency. This endpoint requires API Key authentication.

### Method
POST

### Endpoint
/api/v1/{crypto_name}/payment_request

### Parameters
#### Path Parameters
- **crypto_name** (string) - Required - An identifier for the cryptocurrency. Accepted values include: "BTC", "LTC", "DOGE", "XMR", "XRP", "ETH", "ETH-USDT", "ETH-USDC", "TRX", "USDT", "USDC", "AVAX", "AVALANCHE-USDT", "AVALANCHE-USDC", "BNB", "BNB-USDT", "BNB-USDC", "MATIC", "POLYGON-USDT", "POLYGON-USDC".

#### Query Parameters
None

#### Request Body
- **external_id** (string) - Required - A unique order ID or invoice ID from your store.
- **fiat** (string) - Required - Currency code in ISO 4217 format for conversion. Currently, only USD is supported.
- **amount** (string) - Required - The amount for which the invoice should be created in SHKeeper.
- **callback_url** (string) - Required - The URL to which SHKeeper will send notifications regarding transactions related to the created invoice.

### Request Example
```json
{
  "external_id": "107",
  "fiat": "USD",
  "amount": "7.8",
  "callback_url": "https://my-billing/callback.php"
}
```

### Response
#### Success Response (200)
- **amount** (string) - The amount of the invoice.
- **display_name** (string) - The display name of the cryptocurrency.
- **exchange_rate** (string) - The exchange rate used for the invoice.
- **id** (integer) - The unique identifier for the created invoice.
- **recalculate_after** (integer) - Time in seconds before the invoice needs recalculation (0 if not applicable).
- **status** (string) - The status of the invoice creation, e.g., 'success'.
- **wallet** (string) - The cryptocurrency wallet address for payment.

#### Response Example
```json
{
  "amount": "7.8",
  "display_name": "ERC20 USDT",
  "exchange_rate": "1",
  "id": 61,
  "recalculate_after": 0,
  "status": "success",
  "wallet": "0x6f2Fc9D7205B7D9037dDE45B5f9e12B18EA07e27"
}
```

#### Error Responses
- **405** - Method Not Allowed
- **500** - Internal Server Error
- **default** - Unexpected error
```

--------------------------------

### Callback Payload Sample for Received Payment Transaction

Source: https://shkeeper.io/api/index

This JSON payload represents a sample of the data received via callback when a payment transaction is processed. It includes details about the transaction, involved cryptocurrencies and fiat, amounts, fees, and status.

```json
{
  "external_id": "107",
  "crypto": "ETH-USDT",
  "addr": "0x6f2Fc9D7205B7D9037dDE45B5f9e12B18EA07e27",
  "fiat": "USD",
  "balance_fiat": "7.8",
  "balance_crypto": "7.8",
  "paid": true,
  "status": "PAID",
  "transactions": [
    {
      "txid": "0x23487a9890b80bb908cc07097d0ddd098fff0980bb098ccc098aa0addd098880",
      "date": "2024-06-25 14:45:20",
      "amount_crypto": "3.8",
      "amount_fiat": "3.8",
      "amount_fiat_without_fee": "3.7254901961",
      "fee_fiat": "0.0745098039",
      "trigger": false,
      "crypto": "ETH-USDT"
    },
    {
      "txid": "0x518a10b13a708fd11aa98db88c625dd45130db6656ba822600b01d0c53c85078",
      "date": "2024-06-25 15:45:38",
      "amount_crypto": "4",
      "amount_fiat": "4",
      "amount_fiat_without_fee": "3.9215686275",
      "fee_fiat": "0.0784313725",
      "trigger": true,
      "crypto": "ETH-USDT"
    }
  ],
  "fee_percent": "2",
  "fee_fixed": "0",
  "fee_policy": "PERCENT_FEE",
  "overpaid_fiat": "0.00"
}
```

--------------------------------

### POST /api/v1/invoices/callback

Source: https://shkeeper.io/api/index

Receives payment transaction callbacks from Shkeeper. This endpoint is used to notify your system about the status of payment transactions.

```APIDOC
## POST /api/v1/invoices/callback

### Description
Receives payment transaction callbacks from Shkeeper. This endpoint is used to notify your system about the status of payment transactions.

### Method
POST

### Endpoint
/api/v1/invoices/callback

### Parameters
#### Request Body
- **external_id** (string) - Description: Unique identifier for the transaction.
- **crypto** (string) - Description: The cryptocurrency pair (e.g., ETH-USDT).
- **addr** (string) - Description: The recipient's address.
- **fiat** (string) - Description: The fiat currency.
- **balance_fiat** (string) - Description: The balance in fiat currency.
- **balance_crypto** (string) - Description: The balance in cryptocurrency.
- **paid** (boolean) - Description: Indicates if the payment is completed.
- **status** (string) - Description: The status of the payment (e.g., PAID).
- **transactions** (array) - Description: Array of transaction details.
  - **txid** (string) - Description: Transaction ID.
  - **date** (string) - Description: Transaction date and time.
  - **amount_crypto** (string) - Description: Amount in cryptocurrency.
  - **amount_fiat** (string) - Description: Amount in fiat currency.
  - **amount_fiat_without_fee** (string) - Description: Amount in fiat currency excluding fees.
  - **fee_fiat** (string) - Description: Fee in fiat currency.
  - **trigger** (boolean) - Description: Indicates if this transaction triggered an event.
  - **crypto** (string) - Description: The cryptocurrency pair for the transaction.
- **fee_percent** (string) - Description: Percentage fee.
- **fee_fixed** (string) - Description: Fixed fee amount.
- **fee_policy** (string) - Description: Policy for fee calculation (e.g., PERCENT_FEE).
- **overpaid_fiat** (string) - Description: Overpaid amount in fiat currency.

### Request Example
```json
{
  "external_id": "107",
  "crypto": "ETH-USDT",
  "addr": "0x6f2Fc9D7205B7D9037dDE45B5f9e12B18EA07e27",
  "fiat": "USD",
  "balance_fiat": "7.8",
  "balance_crypto": "7.8",
  "paid": true,
  "status": "PAID",
  "transactions": [
    {
      "txid": "0x23487a9890b80bb908cc07097d0ddd098fff0980bb098ccc098aa0addd098880",
      "date": "2024-06-25 14:45:20",
      "amount_crypto": "3.8",
      "amount_fiat": "3.8",
      "amount_fiat_without_fee": "3.7254901961",
      "fee_fiat": "0.0745098039",
      "trigger": false,
      "crypto": "ETH-USDT"
    },
    {
      "txid": "0x518a10b13a708fd11aa98db88c625dd45130db6656ba822600b01d0c53c85078",
      "date": "2024-06-25 15:45:38",
      "amount_crypto": "4",
      "amount_fiat": "4",
      "amount_fiat_without_fee": "3.9215686275",
      "fee_fiat": "0.0784313725",
      "trigger": true,
      "crypto": "ETH-USDT"
    }
  ],
  "fee_percent": "2",
  "fee_fixed": "0",
  "fee_policy": "PERCENT_FEE",
  "overpaid_fiat": "0.00"
}
```

### Response
#### Success Response (200)
This endpoint typically acknowledges receipt of the callback. Specific response details may vary.

#### Response Example
```json
{
  "message": "Callback received successfully"
}
```
```

--------------------------------

### Retrieve Payout Task Status

Source: https://shkeeper.io/api/index

Fetches the status of a previously initiated cryptocurrency payout task using its unique task ID. Requires the cryptocurrency name and the task ID. Returns the status of each transaction within the task.

```shell
curl --location --request GET 'https://demo.shkeeper.io/api/v1/ETH-USDT/task/8c618c4a-39fc-4c7a-b4f8-1661ea47fec6' \
--user admin:admin
```

--------------------------------

### Decrypt Wallets

Source: https://shkeeper.io/api/index

Decrypts SHKeeper wallets using a provided decryption key. This is typically used on the first run of SHKeeper on demand. Requires a 'key' parameter in the request body.

```form-urlencoded
key=sikfl5llLFt5is50dsfk4yvldti0034jfmmeJm
```
Tokens:
Raw