# Plisio

Plisio is a cryptocurrency payment gateway that enables businesses to accept payments in over 15 cryptocurrencies, including Bitcoin, Ethereum, and Litecoin.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `PLISIO`
- **Version:** 20260312_00

## Tools

### Create Plisio Invoice

**Slug:** `PLISIO_CREATE_INVOICE`

Tool to create a new cryptocurrency payment invoice with Plisio. Returns transaction ID and invoice URL for payment. For white-label accounts, includes additional fields like wallet hash, QR code, and commission details. Use when you need to generate a payment request for cryptocurrency transactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Auto-fill invoice email. Customer will be asked to provide email for notifications. |
| `amount` | string | No | Payment amount in cryptocurrency (float value as string). Skip this field if using source_currency and source_amount for fiat conversion. |
| `plugin` | string | No | Plisio's internal field to identify integration plugin |
| `version` | string | No | Plisio's internal field to identify integration plugin version |
| `currency` | string | Yes | Cryptocurrency code (e.g., 'BTC', 'ETH'). One of the cryptocurrencies supported by Plisio. If not set, one of the active cryptocurrencies from API settings is selected automatically. |
| `language` | string | No | Invoice language code. Currently only 'en_US' is supported. |
| `expire_min` | string | No | Invoice expiration interval in minutes |
| `order_name` | string | Yes | Merchant internal order name for identification |
| `description` | string | No | Merchant invoice description for the customer |
| `callback_url` | string | No | Full URL to receive invoice updates via POST request. If not set, uses the default Status URL from API settings. |
| `order_number` | string | Yes | Merchant internal order number. Must be unique for each new order in your store. |
| `source_amount` | string | No | Payment amount in fiat currency (float value as string). Use with source_currency for fiat-to-crypto conversion. |
| `return_existing` | integer | No | Return existing invoice instead of error if order_number already exists. Default is 0 (disabled). |
| `source_currency` | string | No | Fiat currency code for conversion (e.g., 'USD', 'EUR'). Use with source_amount instead of amount for fiat-to-crypto conversion. |
| `fail_invoice_url` | string | No | 'To the site' button link when invoice payment fails |
| `allowed_psys_cids` | string | No | Comma-separated list of allowed cryptocurrencies for payment. Customer can select one from this list. |
| `fail_callback_url` | string | No | Full URL for failed invoice callback. Add json=true to URL for JSON response format. |
| `redirect_to_invoice` | boolean | No | If true, redirects to Plisio's invoice page instead of returning JSON (not supported for white-label shops) |
| `success_invoice_url` | string | No | 'To the site' button link when invoice is paid |
| `success_callback_url` | string | No | Full URL for successful invoice callback. Add json=true to URL for JSON response format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Estimate Fee

**Slug:** `PLISIO_ESTIMATE_FEE`

Tool to estimate network fee for a withdrawal transaction to specific address(es). Use when calculating transaction costs before creating a withdrawal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amounts` | string | Yes | Amount or comma-separated amounts corresponding to each address for mass withdrawal |
| `fee_plan` | string ("normal" | "priority") | Yes | Fee plan selection: 'normal' for balanced cost and speed, 'priority' for faster confirmation at higher cost |
| `psys_cid` | string | Yes | Cryptocurrency ID from Plisio supported cryptocurrencies (e.g., 'BTC', 'ETH', 'USDT') |
| `addresses` | string | Yes | Wallet address or comma-separated addresses for mass withdrawal fee estimation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Balance By Currency

**Slug:** `PLISIO_GET_BALANCE_BY_CURRENCY`

Tool to get the balance for a specific cryptocurrency in your Plisio account. Use when you need to retrieve the balance of a particular crypto asset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `psys_cid` | string | Yes | ID column from one of the supported cryptocurrencies supported by Plisio (e.g., 'BTC', 'ETH', 'USDT') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commission

**Slug:** `PLISIO_GET_COMMISSION`

Tool to estimate the total cost including network fee and Plisio commission for a transaction. Returns detailed breakdown of commission, fee, and fee plan options for the specified cryptocurrency and amounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("cash_out" | "mass_cash_out") | Yes | Operation type: 'cash_out' for single withdrawal to one address, 'mass_cash_out' for batch withdrawal to multiple addresses. |
| `amounts` | string | Yes | Amount or comma-separated amounts that will be sent. For mass withdrawal, amounts should correspond to addresses in the same order. Use decimal string format (e.g., '0.3', '1.5,2.0'). |
| `feePlan` | string ("normal" | "priority") | No | Fee plan type for transaction processing. |
| `psys_cid` | string | Yes | Cryptocurrency identifier (e.g., 'BTC', 'ETH', 'USDT'). Must be one of the supported cryptocurrencies by Plisio. |
| `addresses` | string | Yes | Wallet address or comma-separated addresses when estimating fee for mass withdrawal. For single withdrawal use one address, for mass withdrawal separate multiple addresses with commas. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Currency Rate

**Slug:** `PLISIO_GET_CURRENCY_RATE`

Tool to retrieve list of supported cryptocurrencies with current rates filtered by fiat currency. Use when you need exchange rate information for cryptocurrencies in a specific fiat currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fiat` | string | Yes | Fiat currency code for exchange rates (e.g., 'USD', 'EUR', 'GBP'). See https://plisio.net/documentation/appendices/supported-fiat-currencies for all 168 supported currencies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fee Plans

**Slug:** `PLISIO_GET_FEE_PLANS`

Tool to retrieve available fee plans for a given cryptocurrency. Specify a currency symbol like 'BTC', 'ETH' to get fee plan details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | Yes | Cryptocurrency symbol, e.g., 'BTC' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fee Plans

**Slug:** `PLISIO_GET_FEE_PLANS2`

Tool to get available fee plans for a specific cryptocurrency. Returns fee values and configuration like gas limits for Ethereum-based coins or confirmation targets for Bitcoin. Use when you need to determine transaction fee options before creating or sending a transaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `psys_cid` | string | Yes | ID column from one of the supported cryptocurrencies supported by Plisio (e.g., 'BTC', 'ETH', 'USDT') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice

**Slug:** `PLISIO_GET_INVOICE`

Tool to retrieve detailed information about a specific invoice by its ID. Use when you need to check invoice status, payment details, or transaction information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Invoice ID to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice by Email

**Slug:** `PLISIO_GET_INVOICE_EMAIL`

Tool to retrieve invoice details by email ID. Use when you need to fetch detailed information about a specific invoice using the invoice ID and payer's email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Invoice unique identifier |
| `email` | string | Yes | Payer's email address associated with the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shop Information

**Slug:** `PLISIO_GET_SHOP`

Tool to retrieve shop information by API key. Returns details about the shop associated with the current API credentials.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plisio Transactions

**Slug:** `PLISIO_GET_TRANSACTIONS`

Tool to retrieve a list of transactions and invoices. Use after authenticating with your API key to fetch historical operations with optional filters and pagination. Example: GetTransactions(status='paid', limit=20).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | integer | No | End date as UNIX timestamp (inclusive) |
| `page` | integer | No | Page number (0-indexed) |
| `type` | string ("withdraw" | "invoice" | "mass_withdraw") | No | Filter by operation type (withdraw, invoice, mass_withdraw) |
| `limit` | integer | No | Number of results per page (max 100) |
| `since` | integer | No | Start date as UNIX timestamp (inclusive) |
| `status` | string ("pending" | "paid" | "cancelled" | "error" | "expired" | "processing") | No | Filter by operation status (pending, paid, cancelled, error, expired, processing) |
| `currency` | string | No | Filter by cryptocurrency code, e.g., 'BTC' |
| `order_id` | string | No | Filter by your own order ID |
| `order_name` | string | No | Filter by your own order name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Supported Currencies

**Slug:** `PLISIO_LIST_CURRENCIES`

Tool to retrieve a list of supported cryptocurrencies with their rates and information. Use after API credentials are configured to get current exchange rates, commission percentages, and operational status for all available coins.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |