Plisio

https://plisio.net/documentation
Admin
Plisio is a cryptocurrency payment gateway and wallet platform providing solutions for businesses...
Tokens:14,607
Snippets:110
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### cURL Request for Invoice Creation

Source: https://plisio.net/documentation/endpoints/create-an-invoice

Example of a GET request to create an invoice with required parameters.

```bash
curl --location --request GET https://api.plisio.net/api/v1/invoices/new
  ?source_currency=USD
  &source_amount=2
  &order_number=1
  &currency=BTC
  &email=customer@plisio.net
  &order_name=btc1
  &callback_url=http://test.com/callback
  &api_key=SECRET_KEY
```

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

### Execute a transaction list request via cURL

Source: https://plisio.net/documentation/getting-started/introduction

Example of a GET request using query parameters for pagination and content-type headers.

```bash
curl -v -X GET https://api.plisio.net/api/v1/operations
  ?api_key=<SECRET_KEY>
  &page=3
  &page_size=4 \
  -H "Content-Type: application/json"
```

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

### cURL Request for USD Rates

Source: https://plisio.net/documentation/endpoints/crypto-coins

Example of a GET request to fetch currency data specifically for USD.

```bash
curl --location --request GET https://api.plisio.net/api/v1/currencies/USD?api_key=SECRET_KEY
```

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

### cURL Request for Fee Estimation

Source: https://plisio.net/documentation/endpoints/fee-estimation

Example of a GET request to retrieve fee estimates for a specific cryptocurrency, address, and amount.

```bash
curl --location --request GET https://api.plisio.net/api/v1/operations/fee/BTC
    ?addresses=2N2m6XRwR8shANBwFTgCGwYtkkf6uFi6XJW
    &amounts=0.002
    &api_key=SECRET_KEY
```

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

### Success response examples

Source: https://plisio.net/documentation/endpoints/fee-plans

JSON response structures for successful fee plan queries.

```json
 
/operations/fee-plan/XMR?api_key=SECRET_KEY

  {
    "status": "success",
    "data": {
      "normal": {
          "conf_target": 0,
          "value": 0.000222
      },
      "priority": {
          "conf_target": 2,
          "value": 0.000444
      }
    }
  }
```

```json
 
/operations/fee-plan/ETH?api_key=SECRET_KEY

  {
    "status": "success",
    "data": {
      "normal": {
          "gasLimit": "21000",
          "gasPrice": "44000000000"
          "value": "0.000924000000000000"
      },
      "priority": {
          "gasLimit": "21000",
          "gasPrice": "44000000000"
          "value": "0.000924000000000000"
      }
    }
  }
```

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

### cURL request for fee plans

Source: https://plisio.net/documentation/endpoints/fee-plans

Example request to retrieve fee plans for Bitcoin (BTC).

```bash
curl --location --request GET https://api.plisio.net/api/v1/operations/fee-plan/BTC
  ?api_key=SECRET_KEY
```

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

### Success Response Example

Source: https://plisio.net/documentation/endpoints/balance

The JSON structure returned upon a successful balance query.

```json
 {
    "status": "success",
    "data": {
	     "psys_cid": "BTC",
      "currency": "BTC",
      "balance": "0.00110995"
    }
  }
```

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

### Retrieve Transaction Details via cURL

Source: https://plisio.net/documentation/endpoints/transaction-details

Example request to fetch transaction details using a GET request with an API key.

```bash
curl --location --request GET https://api.plisio.net/api/v1/operations/5ee210133f5a5e30771f0283
    ?api_key=SECRET_KEY
```

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

### Create Deposit Requests

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Examples for requesting single or multiple cryptocurrency addresses for a specific user.

```bash
curl "https://plisio.net/api/v1/shops/deposit/new?api_key=YOUR_API_KEY&psys_cid=BTC&uid=USER-12345"
```

```bash
curl "https://plisio.net/api/v1/shops/deposit/new?api_key=YOUR_API_KEY&psys_cid=BTC,ETH,USDT&uid=USER-12345"
```

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

### API Response Examples

Source: https://plisio.net/documentation/endpoints/withdrawal-mass-withdrawal

JSON structures for successful withdrawal operations and error handling.

```json
 {
    "status": "success",
    "data": {
      "type": "cash_out",
      "status": "completed",
      "psys_cid": "BTC",
      "currency": "BTC",
      "source_currency": "USD",
      "source_rate": "0.00010282",
      "fee": "0.00000256",
      --- type=cash_out ---
      "wallet_hash": "2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB",
      --- type=mass_cash_out ---
      "sendmany": {
          "2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4": "0.00020000",
          "2N7cy1atVsNZhH6EuKE7HPseMSW5QbEEC6g": "0.00020000"
      },
      ---
      "params": {
        "fee": {
          "conf_target": 3,
          "plan": "normal",
          "value": "0.00000256"
        }
      },
      "created_at_utc": 1591707445,
      "amount": "0.00200000",
      "tx_url": "https://sochain.com/resolver?query=08c702dd754ef0acd29b7cc59816a71577fa0c143d6e7a784a5bab1d7813f37d",
      "id": "5edf873d9ed3a558712be543"
    }
  }
```

```json
 {
    "status": "error",
    "data": {
      "name": "Bad Request",
      "message": "{\"fee\":[\"The transaction fee cannot be estimated. Please check the balance\"]}",
      "code": 115
    }
  }
```

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

### Withdrawal and Mass Withdrawal cURL Requests

Source: https://plisio.net/documentation/endpoints/withdrawal-mass-withdrawal

Examples of GET requests for single and mass cash-out operations. Ensure the Request IP is configured for the service to function correctly.

```bash
curl --location --request GET https://api.plisio.net/api/v1/operations/withdraw
  ?currency=BTC
  &type=cash_out
  &to=2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB
  &amount=0.002
  &api_key=SECRET_KEY
```

```bash
curl --location --request GET https://api.plisio.net/api/plisio.net/api/v1/operations/withdraw
  ?currency=BTC
  &type=mass_cash_out
  &to=2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB,2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4
  &amount=0.002,0.0013
  &api_key=SECRET_KEY
```

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

### API Response Examples

Source: https://plisio.net/documentation/endpoints/create-an-invoice

JSON response structures for standard and white-label invoice creation.

```json
 {
    "status": "success",
    "data": {
      "txn_id": "5ee0e502283675293c450d0e",
      "invoice_url": "https://plisio.net/invoice/5ee0e502283675293c450d0e",
      "invoice_total_sum": "0.00002842"
    }
  }
```

```json
 {
    "status": "success",
    "data": {
      "txn_id": "5f3268bcb7a85576c50d6307",
      "invoice_url": "https://plisio.net/invoice/5f3268bcb7a85576c50d6307"
      "amount": "0.00017305"
      "pending_amount": "0.00017305"
      "wallet_hash": "2Mvt2KbPfF7SFsVrPe7wqbcWKiJx6DmXKQM"
      "psys_cid": "BTC"
      "currency": "BTC"
      "status": "new"
      "source_currency": "USD"
      "source_rate": "0.00008525"
      "expire_utc": 1597175132
      "expected_confirmations": "1"
      "qr_code": "data:image/png;base64..."
      "verify_hash": "13e34f5f9efeb5394d7ab5f432df5cc856cc38a4"
      "invoice_commission": "0.00005550"
      "invoice_sum": "0.00364490"
      "invoice_total_sum": "0.00370040"
    }
  }
```

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

### List Deposits Request and Response

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Example request to filter deposits and the corresponding JSON response.

```bash
curl "https://plisio.net/api/v1/shops/deposit?api_key=YOUR_API_KEY&uid=USER-12345&psys_cid=BTC,ETH&page=1&limit=20"
```

```json
{
  "status": "success",
  "data": [
    { "uid": "USER-12345", "hash": "bc1q...", "psys_cid": "BTC" },
    { "uid": "USER-12345", "hash": "0x...",  "psys_cid": "ETH" }
  ]
}
```

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

### Success Response Example

Source: https://plisio.net/documentation/endpoints/fee-estimation

The JSON structure returned upon a successful fee estimation request.

```json
 {
    "status": "success",
    "data": {
      "fee": "0.00000775",
      "psys_cid": "BTC",
      "currency": "BTC",
      "plan": "normal"
    }
  }
```

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

### Error response example

Source: https://plisio.net/documentation/endpoints/fee-plans

Standard JSON structure returned when a request fails.

```json
 {
    "status": "error",
    "data": {
      "name": "Unprocessable entity",
      "message": "Unsupported currency attribute value: {\"currency\":\"BTCX\"}",
      "code": 105
    }
  }
```

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

### Success Response Example

Source: https://plisio.net/documentation/endpoints/plisio-fee

JSON structure returned upon a successful commission estimation request.

```json
 {
    "status": "success",
    "data": {
        "commission": "0.003010710000000000",
        "fee": "0.001071000000000000",
        "plan": "priority",
        "useWallet": "false",
        "useWalletBalance": "null",
        "plans": {
              "normal": {
                  "gasLimit": "21000",
                  "gasPrice": "44000000000"
                  "value": "0.000924000000000000"
              },
              "priority": {
                  "gasLimit": "21000",
                  "gasPrice": "44000000000"
                  "value": "0.000924000000000000"
              }
        }
    }
  }
```

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

### GET /operations

Source: https://plisio.net/documentation/getting-started/introduction

Retrieves a list of transactions or invoices with optional pagination parameters.

```APIDOC
## GET /operations

### Description
Lists transactions or invoices associated with the account.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your personal secret key.
- **page** (integer) - Optional - The page number to retrieve.
- **page_size** (integer) - Optional - The number of items per page.

### Request Example
curl -v -X GET https://api.plisio.net/api/v1/operations?api_key=<SECRET_KEY>&page=3&page_size=4 -H "Content-Type: application/json"

### Response
#### Success Response (200)
- **status** (string) - The status of the request (success).
- **data** (object) - The requested transaction data.
```

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

### GET /api/v1/balances/<psys_cid>

Source: https://plisio.net/documentation/endpoints/balance

Retrieves the balance for a specific cryptocurrency.

```APIDOC
## GET /api/v1/balances/<psys_cid>

### Description
Retrieves the cryptocurrency balance for the specified currency ID.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/balances/<psys_cid>

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - ID of the cryptocurrency (e.g., BTC).

#### Query Parameters
- **api_key** (string) - Required - Secret key from your API settings page.

### Request Example
curl --location --request GET https://api.plisio.net/api/v1/balances/BTC?api_key=SECRET_KEY

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **data** (object) - Contains balance details including psys_cid, currency, and balance.

#### Response Example
{
  "status": "success",
  "data": {
    "psys_cid": "BTC",
    "currency": "BTC",
    "balance": "0.00110995"
  }
}

### Error Handling
- **422, 500** - Returns an error object containing status, name, message, and code.
```

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

### cURL Request for Commission Estimation

Source: https://plisio.net/documentation/endpoints/plisio-fee

Example request to estimate fees for an ETH transaction using a priority fee plan.

```bash
curl --location --request GET https://api.plisio.net/api/v1/operations/commission/ETH
    ?addresses=0x0465f093fd23fa1dbdf0f6456d8cab1dea4155ff
    &amounts=0.3
    &feePlan=priority
    &type=invoice
    &api_key=SECRET_KEY
```

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

### GET /api/v1/currencies

Source: https://plisio.net/documentation/endpoints/crypto-coins

Retrieves a list of supported crypto coins and their associated data.

```APIDOC
## GET /api/v1/currencies

### Description
Retrieves a list of supported cryptocurrencies. Note that it is necessary to set the Request IP for the service to work correctly.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/currencies?api_key=SECRET_KEY

### Query Parameters
- **api_key** (string) - Required - Your secret API key.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **data** (array) - List of currency objects.
  - **name** (string) - Currency name.
  - **cid** (string) - ID column from supported cryptocurrencies.
  - **icon** (string) - Currency icon URL.
  - **rate_usd** (string) - Rate in USD.
  - **price_usd** (string) - Price in USD.
  - **precision** (string) - Precision value.
  - **fiat** (string) - Name of fiat currency.
  - **fiat_rate** (string) - Rate in fiat.
  - **min_sum_in** (string) - Minimum sum in.
  - **invoice_commission_percentage** (string) - Invoice commission percentage.
  - **hidden** (integer) - Shows what currencies are selected in store settings.
  - **maintenance** (boolean) - Maintenance status.

#### Response Example
{
  "status": "success",
  "data": [
    {
      "name": "Ethereum",
      "cid": "ETH",
      "currency": "ETH",
      "icon": "https://plisio.net/img/psys-icon/ETH.svg",
      "rate_usd": "0.001510773470747854",
      "price_usd": "661.91",
      "precision": "18",
      "fiat": "USD",
      "fiat_rate": "0.001512062377264748",
      "min_sum_in": "0.007",
      "invoice_commission_percentage": "1",
      "hidden": 0,
      "maintenance": false
    }
  ]
}

#### Error Response (500)
- **status** (string) - Status of the request (error).
- **data.message** (string) - Error explanation.
- **data.code** (integer) - Error code.
```

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

### cURL Request for Balance

Source: https://plisio.net/documentation/endpoints/balance

Example request to retrieve the balance for a specific cryptocurrency using an API key.

```bash
curl --location --request GET https://api.plisio.net/api/v1/balances/BTC
  ?api_key=SECRET_KEY
```

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

### GET /api/v1/operations

Source: https://plisio.net/documentation/endpoints/transactions

Retrieves a paginated list of operations for the authenticated user.

```APIDOC
## GET /api/v1/operations

### Description
Retrieves a list of user operations including invoices, cash-ins, and cash-outs. The response is paginated.

### Method
GET

### Endpoint
/api/v1/operations

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API key for authentication
- **page** (integer) - Optional - The page number to retrieve
- **per-page** (integer) - Optional - Number of items per page

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **data** (object) - Contains the list of operations and pagination metadata

#### Response Example
{
  "status": "success",
  "data": {
    "operations": [
      {
        "id": "1000000",
        "user_id": 1,
        "type": "invoice",
        "status": "completed"
      }
    ],
    "_meta": {
      "totalCount": 156,
      "pageCount": 15,
      "currentPage": 1,
      "perPage": 10
    }
  }
}
```

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

### Invoice Creation Endpoint

Source: https://plisio.net/documentation/endpoints/create-an-invoice

The base URL for sending GET requests to create a new invoice.

```text
https://api.plisio.net/api/v1/invoices/new
```

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

### Success Response Example

Source: https://plisio.net/documentation/endpoints/crypto-coins

The JSON structure returned upon a successful request, containing an array of currency objects.

```json
 {
    "status": "success",
    "data": [
        {
            "name": "Ethereum",
            "cid": "ETH",
            "currency": "ETH",
            "icon": "https://plisio.net/img/psys-icon/ETH.svg",
            "rate_usd": "0.001510773470747854",
            "price_usd": "661.91",
            "precision": "18",
            "fiat": "USD",
            "fiat_rate": "0.001512062377264748",
            "min_sum_in": "0.007",
            "invoice_commission_percentage": "1"
            "hidden": 0
            "maintenance": false
        },
        {
            "name": "Bitcoin",
            "cid": "BTC",
            "currency": "BTC",
            "icon": "https://plisio.net/img/psys-icon/BTC.svg",
            "rate_usd": "0.00004404",
            "price_usd": "22701.97",
            "precision": "8",
            "fiat": "USD",
            "fiat_rate": "0.00004399",
            "min_sum_in": "0.0000001",
            "invoice_commission_percentage": "1"
            "hidden": 0
            "maintenance": false
        },
     ]
    }
```

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

### GET /api/v1/operations/withdraw

Source: https://plisio.net/documentation/endpoints/withdrawal-mass-withdrawal

Initiates a single or mass cryptocurrency withdrawal operation.

```APIDOC
## GET /api/v1/operations/withdraw

### Description
Creates a withdrawal or mass withdrawal of cryptocurrency to specified destination addresses.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/withdraw

### Parameters
#### Query Parameters
- **currency** (string) - Required - One of the cryptocurrencies supported by Plisio.
- **type** (string) - Required - "cash_out" or "mass_cash_out".
- **to** (string) - Required - Hash or multiple comma separated hashes for mass withdrawal.
- **amount** (string) - Required - Float value or comma separated float values corresponding to hashes.
- **feePlan** (string) - Optional - Fee plan name: "normal" or "priority".
- **api_key** (string) - Required - Secret key from your API settings page.

### Request Example
```
curl --location --request GET https://api.plisio.net/api/v1/operations/withdraw?currency=BTC&type=cash_out&to=2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB&amount=0.002&api_key=SECRET_KEY
```

### Response
#### Success Response (201)
- **status** (string) - Success status.
- **type** (string) - Operation type.
- **status** (string) - Completion status.
- **psys_cid** (string) - Cryptocurrency ID.
- **currency** (string) - Cryptocurrency code.
- **source_currency** (string) - Fiat currency name.
- **source_rate** (string) - Exchange rate.
- **fee** (string) - Transaction fee.
- **wallet_hash** (string) - Destination hash (if cash_out).
- **sendmany** (object) - Pairs of hashes and values (if mass_cash_out).
- **params.fee** (object) - Fee details including plan and value.
- **created_at_utc** (integer) - Creation timestamp.
- **amount** (string) - Transfer amount.
- **tx_url** (string) - Block explorer link.
- **id** (string) - Internal operation ID.

#### Response Example
{
  "status": "success",
  "data": {
    "type": "cash_out",
    "status": "completed",
    "psys_cid": "BTC",
    "currency": "BTC",
    "source_currency": "USD",
    "source_rate": "0.00010282",
    "fee": "0.00000256",
    "wallet_hash": "2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB",
    "params": {
      "fee": {
        "conf_target": 3,
        "plan": "normal",
        "value": "0.00000256"
      }
    },
    "created_at_utc": 1591707445,
    "amount": "0.00200000",
    "tx_url": "https://sochain.com/resolver?query=08c702dd754ef0acd29b7cc59816a71577fa0c143d6e7a784a5bab1d7813f37d",
    "id": "5edf873d9ed3a558712be543"
  }
}
```

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

### GET /api/v1/operations/

Source: https://plisio.net/documentation/endpoints/transactions

Retrieves a list of transactions based on provided filters and pagination settings.

```APIDOC
## GET /api/v1/operations/

### Description
Retrieves a list of transactions. Requires a valid API secret key.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Secret key value from your API settings page
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Number of elements on the page
- **shop_id** (string) - Optional - Filter operation by shop
- **type** (string) - Optional - Transaction type (cash_in, cash_out, mass_cash_out, invoice, pay_in)
- **status** (string) - Optional - Filter by transaction status (new, pending, pending internal, expired, completed, mismatch, error, cancelled)
- **currency** (string) - Optional - Cryptocurrency ID
- **search** (string) - Optional - Text search by txid, order number, or customer email

### Request Example
curl --location --request GET https://api.plisio.net/api/v1/operations?api_key=SECRET_KEY
```

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

### GET https://api.plisio.net/api/v1/invoices/new

Source: https://plisio.net/documentation/endpoints/create-an-invoice

Creates a new invoice for a transaction. Requires an API key and specific order details.

```APIDOC
## GET https://api.plisio.net/api/v1/invoices/new

### Description
Creates a new invoice for a transaction. Requires an API key and specific order details.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/invoices/new

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Secret key value from your API settings page
- **order_number** (string) - Required - Merchant internal order number
- **order_name** (string) - Required - Merchant internal order name
- **currency** (string) - Optional - Cryptocurrency ID
- **amount** (float) - Optional - Cryptocurrency float value
- **source_currency** (string) - Optional - Fiat currency code
- **source_amount** (float) - Optional - Fiat amount
- **allowed_psys_cids** (string) - Optional - Comma-separated list of allowed cryptocurrencies
- **description** (string) - Optional - Merchant invoice description
- **callback_url** (string) - Optional - URL to receive invoice updates
- **success_callback_url** (string) - Optional - URL to receive success updates
- **fail_callback_url** (string) - Optional - URL to receive failure updates
- **success_invoice_url** (string) - Optional - Redirect URL on success
- **fail_invoice_url** (string) - Optional - Redirect URL on failure
- **email** (string) - Optional - Customer email
- **language** (string) - Optional - Language code (en_US)
- **plugin** (string) - Optional - Integration plugin name
- **version** (string) - Optional - Integration plugin version
- **redirect_to_invoice** (boolean) - Optional - Redirect to invoice page instead of JSON response
- **expire_min** (integer) - Optional - Expiration time in minutes
- **return_existing** (boolean) - Optional - Return existing invoice if found

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **data.txn_id** (string) - Plisio internal transaction ID
- **data.invoice_url** (string) - URL to the invoice page

#### Response Example
{
  "status": "success",
  "data": {
    "txn_id": "5ee0e502283675293c450d0e",
    "invoice_url": "https://plisio.net/invoice/5ee0e502283675293c450d0e",
    "invoice_total_sum": "0.00002842"
  }
}
```

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

### Success response example for transactions

Source: https://plisio.net/documentation/endpoints/transactions

A JSON response body showing a list of operations including invoices, cash_in, and cash_out types with pagination links.

```json
{
    "status": "success",
    "data": {
        "operations": [
            {
                "user_id": 1,
                "shop_id": "607sdw35f4ee4a2b7t",
                "type": "invoice",
                "status": "completed",
                "tx_url": [
                    "https://etherscan.io/tx/0x0000000000",
                    "https://etherscan.io/tx/0x0000000000"
                ],
                "id": "1000000"
            },
            {
                "user_id": 1,
                "shop_id": null,
                "type": "cash_in",
                "status": "completed",
                "pending_sum": "0.00000000",
                "psys_cid": "BTC",
                "currency": "BTC",
                "source_currency": "USD",
                "source_rate": "0.00010216",
                "fee": null,
                "wallet_hash": "0x0000000000",
                "sendmany": null,
                "params": {
                    "value": "0.00225754",
                    "currency": "BTC"
                },
                "expire_at_utc": null,
                "created_at_utc": 1563529570,
                "amount": "0.00014243",
                "sum": 0.00014243,
                "commission": null,
                "tx_url": null,
                "tx_id": null,
                "id": "1000001"
                "actual_sum": 0.00014243,
                "actual_commission": null,
                "actual_fee": null,
                "actual_invoice_sum": null,
                "status_code": 3
            },
            {
                "user_id": 1,
                "shop_id": null,
                "type": "cash_out",
                "status": "completed",
                "pending_sum": "0.00000000",
                "psys_cid": "ETH-TESTNET",
                "currency": "TETH",
                "source_currency": "USD",
                "source_rate": "0.000216542551694120",
                "fee": "0.00952",
                "wallet_hash": "0x00000000001",
                "sendmany": null,
                "params": {
                    "fee": {
                        "gasLimit": "80000",
                        "gasPrice": "119",
                        "nonce": "",
                        "dynamicField": "gasPrice",
                        "plan": "normal",
                        "unit": "Gwai",
                        "value": "0.00952"
                    },
                    "source_currency": "USD",
                    "source_rate": "0.000216542551694120"
                },
                "expire_at_utc": null,
                "created_at_utc": 1639734963,
                "amount": "0.017948510338824132",
                "sum": "0.027468510338824132",
                "commission": "0.000000000000000000",
                "tx_url": "https://ropsten.etherscan.io/tx/0x00000000001",
                "tx_id": [
                    "0x00000000001"
                ],
                "id": "100000000000000000000002"
                "actual_sum": "0.017948510338824132",
                "actual_commission": null,
                "actual_fee": 0,
                "actual_invoice_sum": null,
                "status_code": 3,
                "tx": [
                    {
                        "url": "https://ropsten.etherscan.io/tx/0x00000000001",
                        "wallet_hash": [
                            "0x00000000001"
                        ]
                    }
                ]
            },
            .....
        ],
        "_links": {
            "self": {
                "href": "https://api.plisio.net/api/v1/operations?api_key=...&page=1&per-page=10"
            },
            "first": {
                "href": "https://plisio.net/api/v1/operations?api_key=...&page=1&per-page=10"
            },
            "last": {
                "href": "https://plisio.net/api/v1/operations?api_key=...&page=157&per-page=10"
            },
            "next": {
                "href": "https://plisio.net/api/v1/operations?api_key=...&page=2&per-page=10"
            }
        },
        "_meta": {
            "totalCount": 156,
            "pageCount": 15,
            "currentPage": 1,
            "perPage": 10
        }
    }
}
```

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

### GET /api/v1/operations/commission/<psys_cid>

Source: https://plisio.net/documentation/endpoints/plisio-fee

Estimates the cryptocurrency fee and Plisio commission for a specific transaction.

```APIDOC
## GET /api/v1/operations/commission/<psys_cid>

### Description
Estimates the cryptocurrency fee and Plisio commission for a given cryptocurrency and transaction parameters.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/commission/<psys_cid>

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The name of the cryptocurrency.

#### Query Parameters
- **addresses** (string) - Optional - Wallet address or comma-separated addresses for mass withdrawal.
- **amounts** (string) - Optional - Amount or comma-separated amounts for mass withdrawal.
- **type** (string) - Optional - Transaction type: cash_in, cash_out, mass_cash_out, invoice.
- **feePlan** (string) - Optional - Fee plan: normal or priority.
- **api_key** (string) - Required - Secret key from your API settings page.

### Request Example
curl --location --request GET https://api.plisio.net/api/v1/operations/commission/ETH?addresses=0x0465f093fd23fa1dbdf0f6456d8cab1dea4155ff&amounts=0.3&feePlan=priority&type=invoice&api_key=SECRET_KEY

### Response
#### Success Response (200)
- **commission** (string) - Plisio commission value
- **fee** (string) - Cryptocurrency fee value
- **useWallet** (string) - Pay fee from wallet
- **useWalletBalance** (string) - use_wallet_balance
- **plans** (object) - Plisio's cryptocurrency fee estimation plan

#### Response Example
{
  "status": "success",
  "data": {
    "commission": "0.003010710000000000",
    "fee": "0.001071000000000000",
    "plan": "priority",
    "useWallet": "false",
    "useWalletBalance": "null",
    "plans": {
      "normal": {
        "gasLimit": "21000",
        "gasPrice": "44000000000",
        "value": "0.000924000000000000"
      },
      "priority": {
        "gasLimit": "21000",
        "gasPrice": "44000000000",
        "value": "0.000924000000000000"
      }
    }
  }
}
```

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

### Error Response Example

Source: https://plisio.net/documentation/endpoints/crypto-coins

The JSON structure returned when an error occurs, including a message and error code.

```json
 {
    "status": "error",
    "data": {
      "message": "Internal server error. Please contact Plisio support",
      "code": 108
    }
  }
```

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

### GET https://plisio.net/api/v1/shops/deposit/new

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Generates a unique cryptocurrency address for a user, permanently associated with the provided unique user identifier (UID).

```APIDOC
## GET https://plisio.net/api/v1/shops/deposit/new

### Description
Generates a unique cryptocurrency address for your user. This address is permanently associated with the user's unique ID (UID) provided.

### Method
GET

### Endpoint
https://plisio.net/api/v1/shops/deposit/new

### Parameters
#### Query Parameters
- **psys_cid** (string) - Required - One or a comma-separated list of the cryptocurrencies supported by Plisio.
- **uid** (string) - Required - Your internal unique user identifier. Max 255 characters.
- **api_key** (string) - Required - Your secret API key.

### Request Example
curl "https://plisio.net/api/v1/shops/deposit/new?api_key=YOUR_API_KEY&psys_cid=BTC&uid=USER-12345"

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **data** (object/array) - The deposit details containing uid, hash, and psys_cid.

#### Response Example
{
  "status": "success",
  "data": {
    "uid": "USER-12345",
    "hash": "bc1q...",
    "psys_cid": "BTC"
  }
}
```

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

### GET /api/v1/operations/fee-plan/<psys_cid>

Source: https://plisio.net/documentation/endpoints/fee-plans

Retrieves the fee plan model for a selected cryptocurrency. Note that setting the Request IP is required for the service to function correctly.

```APIDOC
## GET /api/v1/operations/fee-plan/<psys_cid>

### Description
Returns the model with fee plans by selected cryptocurrency. This model includes additional fields specific to the fee plan.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/fee-plan/<psys_cid>

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - ID of the cryptocurrency supported by Plisio.

#### Query Parameters
- **api_key** (string) - Required - Secret key value from your API settings page.

### Request Example
curl --location --request GET https://api.plisio.net/api/v1/operations/fee-plan/BTC?api_key=SECRET_KEY

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **data** (object) - Fee plan details containing normal and priority tiers.

#### Response Example
{
  "status": "success",
  "data": {
    "normal": {
      "conf_target": 0,
      "value": 0.000222
    },
    "priority": {
      "conf_target": 2,
      "value": 0.000444
    }
  }
}
```

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

### GET /api/v1/operations/fee/<psys_cid>

Source: https://plisio.net/documentation/endpoints/fee-estimation

Retrieves the estimated fee for a transaction based on the provided cryptocurrency, addresses, and amounts.

```APIDOC
## GET /api/v1/operations/fee/<psys_cid>

### Description
Estimates the transaction fee for a given cryptocurrency plan. Note that setting the Request IP is required for the service to function correctly.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/fee/<psys_cid>

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The ID of the cryptocurrency (e.g., BTC).

#### Query Parameters
- **addresses** (string) - Required - Wallet address or comma-separated addresses for mass withdrawal.
- **amounts** (string) - Required - Amount or comma-separated amounts to be sent.
- **api_key** (string) - Required - The Secret Key from your API settings page.
- **feePlan** (string) - Optional - The fee plan, either 'normal' or 'priority'.
- **currency** (string) - Optional - The ID of the supported cryptocurrency.

### Request Example
curl --location --request GET https://api.plisio.net/api/v1/operations/fee/BTC?addresses=2N2m6XRwR8shANBwFTgCGwYtkkf6uFi6XJW&amounts=0.002&api_key=SECRET_KEY

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **data.fee** (string) - The estimated fee amount.
- **data.psys_cid** (string) - The cryptocurrency ID.
- **data.currency** (string) - The currency code.
- **data.plan** (string) - The selected fee plan.

#### Response Example
{
  "status": "success",
  "data": {
    "fee": "0.00000775",
    "psys_cid": "BTC",
    "currency": "BTC",
    "plan": "normal"
  }
}
```

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

### Payment Callback Payload

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Example of the JSON payload sent to your configured Status or Success URL when a payment is received.

```json
{
  "amount": "2.000000",
  "comment": "Invoice details: https://plisio.net/account/transactions/68da2...",
  "confirmations": "37",
  "currency": "USDT_TRX",
  "deposit_sum": "1.978000",
  "deposit_uid": "test8",
  "invoice_commission": "0.022000",
  "invoice_sum": "1.978000",
  "invoice_total_sum": "2.000000",
  "ipn_type": "pay_in",
  "merchant": "Test shop",
  "merchant_id": "5d09...",
  "pending_amount": "0.000000",
  "psys_cid": "USDT_TRX",
  "qr_code": "****",
  "source_amount": "1.978000",
  "source_currency": "USD",
  "source_rate": "0.999920",
  "status": "completed",
  "tx_urls": [
    "https://tronscan.org/#/transaction/571a...",
    "https://tronscan.org/#/transaction/e4f3..."
  ],
  "txn_id": "68da23e93ee47b52a808af13",
  "wallet_hash": "TH3q...",
  "verify_hash": "f935032c5f78dfc93fcd36866657ec99907e83b8"
}
```

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

### GET https://plisio.net/api/v1/shops/deposit

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Retrieves a paginated list of deposit addresses associated with a shop, with optional filtering by UID or cryptocurrency.

```APIDOC
## GET https://plisio.net/api/v1/shops/deposit

### Description
Returns a paginated list of deposit addresses associated with a shop. Results can be filtered by UID and cryptocurrency.

### Method
GET

### Endpoint
https://plisio.net/api/v1/shops/deposit

### Parameters
#### Query Parameters
- **uid** (string) - Optional - Your internal unique user identifier to filter deposits.
- **psys_cid** (string) - Optional - Comma-separated list of cryptocurrency IDs to filter the results.
- **page** (integer) - Optional - Page number for pagination (default: 1).
- **limit** (integer) - Optional - Number of items per page (default: 20).
- **api_key** (string) - Required - Your secret API key.

### Request Example
curl "https://plisio.net/api/v1/shops/deposit?api_key=YOUR_API_KEY&uid=USER-12345&psys_cid=BTC,ETH&page=1&limit=20"

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **data** (array) - An array of deposit items.

#### Response Example
{
  "status": "success",
  "data": [
    { "uid": "USER-12345", "hash": "bc1q...", "psys_cid": "BTC" },
    { "uid": "USER-12345", "hash": "0x...",  "psys_cid": "ETH" }
  ]
}
```

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

### GET https://api.plisio.net/api/v1/operations/<id>

Source: https://plisio.net/documentation/endpoints/transaction-details

Retrieves the details of a specific transaction or operation using its unique identifier.

```APIDOC
## GET https://api.plisio.net/api/v1/operations/<id>

### Description
Retrieves detailed information about a specific transaction or operation. Requires a valid secret key provided via query parameter.

### Method
GET

### Endpoint
https://api.plisio.net/api/v1/operations/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the operation.

#### Query Parameters
- **api_key** (string) - Required - The secret key from your API settings page.

### Response
#### Success Response (200)
- **status** (string) - The status of the request (success).
- **data** (object) - The transaction details object containing fields like type, status, tx_url, and id.

#### Response Example
{
  "status": "success",
  "data": {
    "type": "mass_cash_out",
    "status": "completed",
    "tx_url": "https://sochain.com/resolver?query=86b5ec4404d98b9bccaaa39630e01d49f6e5e76a97664bf18a4e0da800b9f949",
    "id": "5ee210133f5a5e30771f0283"
  }
}
```

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

### Resource not found error response

Source: https://plisio.net/documentation/endpoints/create-a-deposit

Returned when the shop associated with the provided API key cannot be located.

```json
{
  "status": "error",
  "data": {
    "message": "The specified resource does not exist",
    "code": 401
  }
}
```

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

### Construct a basic API request

Source: https://plisio.net/documentation/getting-started/introduction

The standard structure for API calls requiring an action and a secret key.

```text
https://api.plisio.net/api/v1/<action>?api_key=<SECRET_KEY>
```

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

### Retrieve Supported Currencies Endpoint

Source: https://plisio.net/documentation/endpoints/crypto-coins

The base URL for querying supported crypto coins. Ensure the API key is included as a query parameter.

```text
https://api.plisio.net/api/v1/currencies?api_key=SECRET_KEY
```

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

### Parse a sample balance response

Source: https://plisio.net/documentation/getting-started/introduction

The JSON structure returned by the API, containing status, data, and resource information.

```json
{
  "status": "success",
  "data":
    {
      "currency": "BTC",
      "balance": "0.03351057"
    }
}
```

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

### Create Deposit Responses

Source: https://plisio.net/documentation/endpoints/create-a-deposit

JSON responses for successful single and multiple deposit address creation.

```json
{
  "status": "success",
  "data": {
    "uid": "USER-12345",
    "hash": "bc1q...",
    "psys_cid": "BTC"
  }
}
```

```json
{
  "status": "success",
  "data": [
    { "uid": "USER-12345", "hash": "bc1q...", "psys_cid": "BTC" },
    { "uid": "USER-12345", "hash": "0x...",  "psys_cid": "ETH" },
    { "uid": "USER-12345", "hash": "TR...",  "psys_cid": "USDT" }
  ]
}
```

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

### Balance Endpoint URL

Source: https://plisio.net/documentation/endpoints/balance

The base URL structure for querying cryptocurrency balances.

```text
https://api.plisio.net/api/v1/balances/<psys_cid>
```

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

### Retrieve fee plan endpoint

Source: https://plisio.net/documentation/endpoints/fee-plans

The base URL structure for fetching fee plans for a specific cryptocurrency.

```text
  https://api.plisio.net/api/v1/operations/fee-plan/<psys_cid>
```
Tokens:
Raw