Skip to main content
Plisio logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: PLISIO
  • Version: 20261101_00

Tools

Slug: PLISIO_CREATE_INVOICETool 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

string
Auto-fill invoice email. Customer will be asked to provide email for notifications.
string
Payment amount in cryptocurrency (float value as string). Skip this field if using source_currency and source_amount for fiat conversion.
string
Plisio’s internal field to identify integration plugin
string
Plisio’s internal field to identify integration plugin version
string
required
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.
string
Invoice language code. Currently only ‘en_US’ is supported.
string
Invoice expiration interval in minutes
string
required
Merchant internal order name for identification
string
Merchant invoice description for the customer
string
Full URL to receive invoice updates via POST request. If not set, uses the default Status URL from API settings.
string
required
Merchant internal order number. Must be unique for each new order in your store.
string
Payment amount in fiat currency (float value as string). Use with source_currency for fiat-to-crypto conversion.
integer
Return existing invoice instead of error if order_number already exists. Default is 0 (disabled).
string
Fiat currency code for conversion (e.g., ‘USD’, ‘EUR’). Use with source_amount instead of amount for fiat-to-crypto conversion.
string
‘To the site’ button link when invoice payment fails
string
Comma-separated list of allowed cryptocurrencies for payment. Customer can select one from this list.
string
Full URL for failed invoice callback. Add json=true to URL for JSON response format.
boolean
If true, redirects to Plisio’s invoice page instead of returning JSON (not supported for white-label shops)
string
‘To the site’ button link when invoice is paid
string
Full URL for successful invoice callback. Add json=true to URL for JSON response format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_ESTIMATE_FEETool to estimate network fee for a withdrawal transaction to specific address(es). Use when calculating transaction costs before creating a withdrawal.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_BALANCE_BY_CURRENCYTool 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

string
required
ID column from one of the supported cryptocurrencies supported by Plisio (e.g., ‘BTC’, ‘ETH’, ‘USDT’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_COMMISSIONEstimate the network fee and Plisio commission for a single or mass cryptocurrency withdrawal. Returns a breakdown of commission, fee, and fee plan options for the specified cryptocurrency and amounts.

Input Parameters

string ("cash_out" | "mass_cash_out")
required
Operation type: ‘cash_out’ for single withdrawal to one address, ‘mass_cash_out’ for batch withdrawal to multiple addresses.
string
required
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’).
string ("normal" | "priority")
Fee plan type for transaction processing.
string
required
Cryptocurrency identifier (e.g., ‘BTC’, ‘ETH’, ‘USDT’). Must be one of the supported cryptocurrencies by Plisio.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_CURRENCY_RATETool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_FEE_PLANSRetrieve available fee plans for a specified cryptocurrency, such as BTC or ETH. The plans provide fee details that vary by cryptocurrency.

Input Parameters

string
required
Cryptocurrency symbol, e.g., ‘BTC’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_FEE_PLANS2Tool 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

string
required
ID column from one of the supported cryptocurrencies supported by Plisio (e.g., ‘BTC’, ‘ETH’, ‘USDT’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_INVOICETool 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

string
required
Invoice ID to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_INVOICE_EMAILTool 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

string
required
Invoice unique identifier
string
required
Payer’s email address associated with the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_SHOPTool to retrieve shop information by API key. Returns details about the shop associated with the current API credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_GET_TRANSACTIONSRetrieve a paginated list of Plisio transactions and invoices for reviewing historical operations. Optional filters include transaction type, status and currency; the page size is limited to 100.

Input Parameters

integer
End date as UNIX timestamp (inclusive)
integer
Page number (0-indexed)
string ("withdraw" | "invoice" | "mass_withdraw")
Filter by operation type (withdraw, invoice, mass_withdraw)
integer
Number of results per page (max 100)
integer
Start date as UNIX timestamp (inclusive)
string ("pending" | "paid" | "cancelled" | "error" | "expired" | "processing")
Filter by operation status (pending, paid, cancelled, error, expired, processing)
string
Filter by cryptocurrency code, e.g., ‘BTC’
string
Filter by your own order ID
string
Filter by your own order name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLISIO_LIST_CURRENCIESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not