Python Plisio

https://python-plisio.readthedocs.io
Admin
Python Plisio is an unofficial SDK for integrating with the Plisio cryptocurrency payment gateway,...
Tokens:30,964
Snippets:132
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### Client Initiation

Source: https://python-plisio.readthedocs.io/en/latest/examples

Examples of how to initiate the Plisio client, both synchronously and asynchronously, with and without request parameters.

```APIDOC
## Initiate Client

### Description
Initiate the Plisio client with or without request parameters.

### Method
N/A (Client Initialization)

### Endpoint
N/A (Client Initialization)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
#### Synchronous Client
```python
from plisio import Client

client = Client("<API_KEY>")
```

#### Asynchronous Client
```python
import asyncio
from plisio import AsyncClient

client = AsyncClient("<API_KEY>")
```

#### Synchronous Client with Request Params
```python
from plisio import Client

client = Client("<API_KEY>", requests_params={
    "timeout": 10
})
```

#### Asynchronous Client with Request Params
```python
import asyncio
from plisio import AsyncClient

client = AsyncClient("<API_KEY>", requests_params={
    "timeout": 10
})
```

### Response
N/A (Client Initialization)

### Response Example
N/A (Client Initialization)
```

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

### Create Plisio Invoice

Source: https://python-plisio.readthedocs.io/en/latest/examples

Provides examples for creating an invoice using the Plisio client. Both synchronous and asynchronous methods are demonstrated, requiring order details, amount, and currency. The output includes the invoice URL.

```python
def main():
    invoice = client.invoice(
        order_name="test",
        order_number="test",
        amount=1,
        currency="BTC",
    )

    print(invoice)


main()
```

```python
async def main():
    invoice = await client.invoice(
        order_name="test",
        order_number="test",
        amount=1,
        currency="BTC",
    )

    print(invoice)


asyncio.run(main())
```

```json
{"status": "success", "data": {"txn_id": "6470c20600b6719c3f063d59", "invoice_url": "https://plisio.net/invoice/6470c20600b6719c3f063d59", "invoice_total_sum": "1.00000000"}}
```

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

### GET /crypto-coins

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Retrieves a list of supported cryptocurrencies.

```APIDOC
## GET /crypto-coins

### Description
Retrieves a list of supported cryptocurrencies.

### Method
GET

### Endpoint
/crypto-coins

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **coins** (list) - A list of cryptocurrency objects, each containing details like name, symbol, and CID.

#### Response Example
```json
{
  "coins": [
    {
      "name": "Bitcoin",
      "symbol": "BTC",
      "cid": "btc"
    },
    {
      "name": "Ethereum",
      "symbol": "ETH",
      "cid": "eth"
    }
  ]
}
```
```

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

### Create Invoice API

Source: https://python-plisio.readthedocs.io/en/latest/examples

Documentation for creating an invoice using the Plisio client, both synchronously and asynchronously.

```APIDOC
## Create Invoice API

### Description
Create an invoice using the Plisio client.

### Method
N/A (Method Call)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
#### Synchronous Invoice Creation
```python
def main():
    invoice = client.invoice(
        order_name="test",
        order_number="test",
        amount=1,
        currency="BTC",
    )
    print(invoice)
main()
```

#### Asynchronous Invoice Creation
```python
async def main():
    invoice = await client.invoice(
        order_name="test",
        order_number="test",
        amount=1,
        currency="BTC",
    )
    print(invoice)
asyncio.run(main())
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request.
- **data** (object) - Contains the invoice data.
  - **txn_id** (string) - The transaction ID of the invoice.
  - **invoice_url** (string) - The URL of the created invoice.
  - **invoice_total_sum** (string) - The total amount of the invoice.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "txn_id": "6470c20600b6719c3f063d59",
    "invoice_url": "https://plisio.net/invoice/6470c20600b6719c3f063d59",
    "invoice_total_sum": "1.00000000"
  }
}
```
```

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

### Transactions API

Source: https://python-plisio.readthedocs.io/en/latest/examples

Documentation for querying transactions using the Plisio client, both synchronously and asynchronously.

```APIDOC
## Transactions API

### Description
Query transactions using the Plisio client.

### Method
N/A (Method Call)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
#### Synchronous Transaction Query
```python
def main():
    transactions = client.transactions()
    print(transactions)
main()
```

#### Asynchronous Transaction Query
```python
async def main():
    transactions = await client.transactions()
    print(transactions)
asyncio.run(main())
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request.
- **data** (object) - Contains the transaction data.
  - **operations** (array) - List of transaction operations.
  - **_links** (object) - Links for pagination.
  - **_meta** (object) - Metadata about the transactions.
    - **totalCount** (integer) - Total number of transactions.
    - **pageCount** (integer) - Total number of pages.
    - **currentPage** (integer) - The current page number.
    - **perPage** (integer) - Number of transactions per page.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "operations": [],
    "_links": {
      "self": {
        "href": "https://plisio.net/api/v1/operations?api_key=...&page=1&per-page=10"
      }
    },
    "_meta": {
      "totalCount": 0,
      "pageCount": 0,
      "currentPage": 1,
      "perPage": 10
    }
  }
}
```
```

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

### GET /crypto-coins

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves a list of supported cryptocurrencies.

```APIDOC
## GET /crypto-coins

### Description
Retrieves a list of supported cryptocurrencies.

### Method
GET

### Endpoint
/crypto-coins

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **data** (list) - A list of cryptocurrency objects, each containing details like name, symbol, and network.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "name": "Bitcoin",
      "symbol": "BTC",
      "network": "mainnet"
    },
    {
      "name": "Ethereum",
      "symbol": "ETH",
      "network": "mainnet"
    }
  ]
}
```
```

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

### Initialize Plisio Client

Source: https://python-plisio.readthedocs.io/en/latest/examples

Demonstrates how to initialize the Plisio client for both synchronous and asynchronous operations. The client can be initialized with or without custom request parameters like timeouts.

```python
from plisio import Client

client = Client("<API_KEY>")
```

```python
import asyncio
from plisio import AsyncClient

client = AsyncClient("<API_KEY>")
```

```python
from plisio import Client

client = Client("<API_KEY>", requests_params={
    "timeout": 10
})
```

```python
import asyncio
from plisio import AsyncClient

client = AsyncClient("<API_KEY>", requests_params={
    "timeout": 10
})
```

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

### GET /operations/fee-plan

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Retrieves available fee plans for a given payment system CID.

```APIDOC
## GET /operations/fee-plan

### Description
Retrieves available fee plans for a given payment system CID.

### Method
GET

### Endpoint
/operations/fee-plan

### Parameters
#### Query Parameters
- **psys_cid** (str) - Required - The payment system CID for which to retrieve fee plans.

### Request Example
```json
{
  "psys_cid": "eth"
}
```

### Response
#### Success Response (200)
- **fee_plans** (list) - A list of available fee plans.

#### Response Example
```json
{
  "fee_plans": [
    "standard",
    "express"
  ]
}
```
```

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

### Query Plisio Transactions

Source: https://python-plisio.readthedocs.io/en/latest/examples

Shows how to query transactions using the Plisio client. This includes both synchronous and asynchronous methods. The output displays the transaction status and data.

```python
def main():
    transactions = client.transactions()

    print(transactions)


main()
```

```python
async def main():
    transactions = await client.transactions()

    print(transactions)


asyncio.run(main())
```

```json
{"status": "success", "data": {"operations": [], "_links": {"self": {"href": "https://plisio.net/api/v1/operations?api_key=By3QOfFqVu3w8mH7BZm5QO3T-Gq4fVnAaaCz790zFoLVamWWsR24ON_HlGUbjScd&page=1&per-page=10"}}, "_meta": {"totalCount": 0, "pageCount": 0, "currentPage": 1, "perPage": 10}}}
```

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

### Make GET Request to Plisio API (Python)

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Performs a GET request to a specified path on the Plisio API. It constructs the full URI using the provided path and API version, then calls the generic request method.

```python
def _get(  # type: ignore[no-untyped-def]
        self, path: _t.Text, version: _t.Text = _BaseClient.API_VERSION_V1, **kwargs
    ) -> _t.Result:
        """
        Make GET request.

        Args:
            path (str): Path.
            version (str): API version.
            **kwargs: Arguments.

        Returns:
            dict: Response data.

        Raises:
            PlisioRequestException: If request failed.
            PlisioAPIException: If API returned error.
        """
        uri = self._get_uri(path, version)
        return self._request(_Methods.GET, uri, **kwargs)
```

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

### Perform Async GET Request to Plisio API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Executes an asynchronous GET request to a specified path on the Plisio API. It constructs the full URI and utilizes the generic `_request` method for execution.

```python
async def _get(
        self, path: _t.Text, version: _t.Text = _BaseClient.API_VERSION_V1, **kwargs
    ) -> _t.Result:
        """
        Make GET request.

        Args:
            path (str): Path.
            version (str): API version.
            **kwargs: Arguments.

        Returns:
            dict: Response data.

        Raises:
            PlisioRequestException: If request failed.
            PlisioAPIException: If API returned error.
        """
        uri = self._get_uri(path, version)
        return await self._request(_Methods.GET, uri, **kwargs)
```

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

### GET /operations/fee-plan

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves available fee plans for a given payment system.

```APIDOC
## GET /operations/fee-plan

### Description
Retrieves available fee plans for a given payment system.

### Method
GET

### Endpoint
/operations/fee-plan

### Parameters
#### Query Parameters
- **psys_cid** (str) - Required - The unique identifier of the payment system.

### Response
#### Success Response (200)
- **data** (dict) - Response data containing a list of available fee plans.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "id": "plan_abc123",
      "name": "Standard Fee Plan",
      "fee_percentage": "1.5"
    },
    {
      "id": "plan_def456",
      "name": "Premium Fee Plan",
      "fee_percentage": "1.0"
    }
  ]
}
```
```

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

### GET /operations

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Retrieve a list of transactions with optional filtering and pagination.

```APIDOC
## GET /operations

### Description
Retrieve a list of transactions with optional filtering and pagination.

### Method
GET

### Endpoint
/operations

### Parameters
#### Path Parameters
None

#### Query Parameters
- **page** (int) - Optional - The page number for pagination.
- **limit** (int) - Optional - The number of transactions to return per page.
- **shop_id** (int) - Optional - Filter transactions by shop ID.
- **type** (str) - Optional - Filter transactions by type (e.g., 'income', 'outcome').
- **status** (str) - Optional - Filter transactions by status (e.g., 'completed', 'pending').
- **currency** (str) - Optional - Filter transactions by currency.
- **search** (str) - Optional - Search term for transactions.

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (dict) - The response data containing a list of transactions.

#### Response Example
```json
{
  "example": "{\"status\": \"success\", \"data\": {\"operations\": [ { \"id\": \"op_123\", \"amount\": \"10.00\", \"currency\": \"USD\", \"status\": \"completed\" } ] } }"
}
```

### Raises
- PlisioRequestException: If the request fails.
- PlisioAPIException: If the API returns an error.
```

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

### GET /operations

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves a list of transactions, with options to filter by page, limit, shop ID, type, status, currency, and search query.

```APIDOC
## GET /operations

### Description
Retrieves a list of transactions, with options to filter by page, limit, shop ID, type, status, currency, and search query.

### Method
GET

### Endpoint
/operations

### Parameters
#### Query Parameters
- **page** (int) - Optional - Page number.
- **limit** (int) - Optional - Number of transactions per page.
- **shop_id** (int) - Optional - Filter by shop ID.
- **type** (str) - Optional - Filter by transaction type.
- **status** (str) - Optional - Filter by transaction status.
- **currency** (str) - Optional - Filter by currency.
- **search** (str) - Optional - Search query.

### Request Example
```json
{
  "page": 1,
  "limit": 10,
  "shop_id": 123,
  "status": "completed",
  "currency": "BTC"
}
```

### Response
#### Success Response (200)
- **dict** (_t.Result) - Response data.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "id": "txn_12345",
      "amount": "100.00",
      "currency": "USD",
      "status": "completed"
    },
    {
      "id": "txn_67890",
      "amount": "50.00",
      "currency": "BTC",
      "status": "pending"
    }
  ]
}
```

### Error Handling
- **PlisioRequestException**: If request failed.
- **PlisioAPIException**: If API returned error.
```

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

### GET /operations/fee

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Estimates fees for a transaction based on currency, addresses, amounts, and fee plan.

```APIDOC
## GET /operations/fee

### Description
Estimates fees for a transaction based on currency, addresses, amounts, and fee plan.

### Method
GET

### Endpoint
/operations/fee

### Parameters
#### Query Parameters
- **currency** (str) - Optional - The currency for the transaction.
- **addresses** (list) - Optional - A list of recipient addresses.
- **amounts** (list) - Optional - A list of amounts corresponding to the addresses.
- **fee_plan** (str) - Optional - The fee plan to use for estimation.

### Request Example
```json
{
  "currency": "BTC",
  "addresses": ["addr1", "addr2"],
  "amounts": [0.1, 0.2],
  "fee_plan": "standard"
}
```

### Response
#### Success Response (200)
- **estimated_fee** (float) - The estimated transaction fee.

#### Response Example
```json
{
  "estimated_fee": 0.0005
}
```
```

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

### GET /balance

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves the current balance, optionally filtered by a specific payment system.

```APIDOC
## GET /balance

### Description
Retrieves the current balance, optionally filtered by a specific payment system.

### Method
GET

### Endpoint
/balance

### Parameters
#### Query Parameters
- **psys_cid** (str) - Optional - The unique identifier of the payment system to filter the balance by.

### Response
#### Success Response (200)
- **data** (dict) - Response data containing the balance information.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "total_balance": "5000.00",
    "available_balance": "4800.00",
    "currency": "USD"
  }
}
```
```

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

### Get Transactions

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves a list of transactions with optional filtering and pagination.

```APIDOC
## GET /operations

### Description
Retrieves a list of transactions with optional filtering and pagination.

### Method
GET

### Endpoint
/operations

### Parameters
#### Path Parameters
None

#### Query Parameters
- **page** (int) - Optional - Page number for pagination.
- **limit** (int) - Optional - Number of transactions per page.
- **shop_id** (int) - Optional - Filter transactions by shop ID.
- **type** (str) - Optional - Filter transactions by type.
- **status** (str) - Optional - Filter transactions by status.
- **currency** (str) - Optional - Filter transactions by currency.
- **search** (str) - Optional - Search term for transactions.

#### Request Body
None

### Request Example
```json
{
  "page": 1,
  "limit": 20,
  "shop_id": 101,
  "status": "completed",
  "currency": "USD"
}
```

### Response
#### Success Response (200)
- **dict** - Response data containing a list of transactions.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "total": 100,
    "items": [
      {
        "id": "txn_abc123",
        "order_name": "Order 1",
        "currency": "USD",
        "amount": 50.00,
        "status": "completed"
      }
    ]
  }
}
```
```

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

### GET /operations/fee

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Estimates fees for a transaction based on currency, addresses, amounts, and fee plan.

```APIDOC
## GET /operations/fee

### Description
Estimates fees for a transaction based on currency, addresses, amounts, and fee plan.

### Method
GET

### Endpoint
/operations/fee

### Parameters
#### Query Parameters
- **currency** (str) - Optional - The currency for the transaction.
- **addresses** (list) - Optional - A list of recipient addresses.
- **amounts** (list) - Optional - A list of amounts corresponding to the addresses.
- **fee_plan** (str) - Optional - The specific fee plan to use for estimation.

### Response
#### Success Response (200)
- **data** (dict) - Response data containing the estimated fee details.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "estimated_fee": "0.05",
    "currency": "BTC"
  }
}
```
```

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

### Create Invoice with Python Plisio Client

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

This method creates a new invoice via the Plisio API. It accepts numerous parameters to define the order, currency, amount, and callback URLs. It formats these parameters and sends a GET request to the 'invoices/new' endpoint.

```python
params = self._get_params(locals())
return await self._get("invoices/new", data=params, force_params=True)
```

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

### Get List of Crypto Coins using Plisio API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves a list of supported cryptocurrencies available through the Plisio API. Returns a dictionary containing coin information or raises exceptions for request or API errors.

```python
async def crypto_coins(self) -> _t.Result:
    """
    Get crypto coins.

    See Also:
        https://plisio.net/documentation/endpoints/crypto-coins

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    return await self._get("crypto-coins")
```

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

### GET /balance

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Retrieves the current balance associated with a payment system. An optional payment system CID can be provided to filter the balance.

```APIDOC
## GET /balance

### Description
Retrieves the current balance associated with a payment system. An optional payment system CID can be provided to filter the balance.

### Method
GET

### Endpoint
/balance

### Parameters
#### Query Parameters
- **psys_cid** (str) - Optional - Payment system CID.

### Response
#### Success Response (200)
- **dict** (_t.Result) - Response data.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "balance": "100.50",
    "currency": "USD"
  }
}
```

### Error Handling
- **PlisioRequestException**: If request failed.
- **PlisioAPIException**: If API returned error.
```

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

### GET /operations

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieve a list of transactions. This endpoint supports filtering by various parameters such as page, limit, shop ID, type, status, currency, and search terms.

```APIDOC
## GET /operations

### Description
Retrieve a list of transactions. This endpoint supports filtering by various parameters such as page, limit, shop ID, type, status, currency, and search terms.

### Method
GET

### Endpoint
/operations

### Parameters
#### Path Parameters
None

#### Query Parameters
- **page** (int) - Optional - The page number for pagination.
- **limit** (int) - Optional - The number of transactions to return per page.
- **shop_id** (int) - Optional - Filter transactions by shop ID.
- **type** (str) - Optional - Filter transactions by type (e.g., 'income', 'outcome').
- **status** (str) - Optional - Filter transactions by status (e.g., 'completed', 'pending', 'failed').
- **currency** (str) - Optional - Filter transactions by currency.
- **search** (str) - Optional - Search term to find specific transactions.

### Request Example
```json
{
  "page": 1,
  "limit": 20,
  "shop_id": 101,
  "status": "completed",
  "currency": "USD"
}
```

### Response
#### Success Response (200)
- **result** (dict) - The response data containing a list of transactions.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "total": 150,
    "transactions": [
      {
        "id": "txn_xyz789",
        "order_id": "order_abc",
        "currency": "USD",
        "amount": 50.00,
        "status": "completed",
        "type": "income",
        "created_at": "2023-10-27T10:00:00Z"
      }
      // ... more transactions
    ]
  }
}
```
```

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

### Balance API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves the current balance. Optionally, you can specify a payment system CID to get the balance for a specific system.

```APIDOC
## GET /balance/

### Description
Get balance. Optionally specify a payment system CID.

### Method
GET

### Endpoint
/balance/

### Parameters
#### Query Parameters
- **psys_cid** (str) - Optional - Payment system CID.

### Response
#### Success Response (200)
- **dict** (_t.Result) - Response data.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "total_balance": "100.50",
    "currency": "USD"
  }
}
```

### Errors
- **PlisioRequestException**: If request failed.
- **PlisioAPIException**: If API returned error.
```

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

### Get Crypto Coins with Python Plisio Client

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Fetches a list of available cryptocurrency coins from the Plisio API. This function returns response data and may raise exceptions if the request fails or the API returns an error.

```python
def crypto_coins(self) -> _t.Result:
    """
    Get crypto coins.

    See Also:
        https://plisio.net/documentation/endpoints/crypto-coins

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    return self._get("crypto-coins")
```

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

### Create Invoice in Python

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Facilitates the creation of a new invoice through the Plisio API. It accepts numerous parameters to define the invoice details, such as currency, amount, and callback URLs. The function prepares parameters and makes a GET request to the 'invoices/new' endpoint.

```python
def invoice(self, order_name: _t.Text, currency: _t.Currencies, amount: _t.NumberLike, order_number: _t.NumberLike = str(_uuid4()), source_currency: _t.OptionalFiats = None, source_amount: _t.OptionalNumberLike = None, allowed_psys_cids: _t.OptionalPsysCids = None, description: _t.OptionalText = None, callback_url: _t.OptionalLink = None, success_callback_url: _t.OptionalLink = None, fail_callback_url: _t.OptionalLink = None, email: _t.OptionalEmail = None, language: _t.OptionalText = "en_US", plugin: _t.OptionalText = None, version: _t.OptionalText = None, redirect_to_invoice: _t.OptionalBool = None, expire_min: _t.OptionalNumberLike = None) -> _t.Result:
    """
    Create invoice.

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

    Args:
        order_name (str): Order name.
        order_number (int): Order number.
        currency (str): Currency.
        amount (float): Amount.
        source_currency (str): Source currency.
        source_amount (float): Source amount.
        allowed_psys_cids (list): Allowed payment systems.
        description (str): Description.
        callback_url (str): Callback URL.
        success_callback_url (str): Success callback URL.
        fail_callback_url (str): Fail callback URL.
        email (str): Email.
        language (str): Language.
        plugin (str): Plugin.
        version (str): Version.
        redirect_to_invoice (bool): Redirect to invoice.
        expire_min (int): Expire minutes.

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    params = self._get_params(locals())
    return self._get("invoices/new", data=params, force_params=True)
```

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

### Get Transactions List (Python)

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Fetches a list of transactions with optional filtering by page, limit, shop ID, type, status, currency, and search query. It handles potential request and API errors. The function returns a dictionary containing the transaction data.

```python
def transactions(
    self,
    page: _t.OptionalNumberLike = None,
    limit: _t.OptionalNumberLike = None,
    shop_id: _t.OptionalNumberLike = None,
    type: _t.OptionalTransactionStatus = None,  # pylint: disable=redefined-builtin
    status: _t.OptionalTransactionStatus = None,
    currency: _t.OptionalCurrencies = None,
    search: _t.OptionalText = None,
) -> _t.Result:
    """
    Get transactions.

    See Also:
        https://plisio.net/documentation/endpoints/transactions

    Args:
        page (int): Page.
        limit (int): Limit.
        shop_id (int): Shop ID.
        type (str): Type.
        status (str): Status.
        currency (str): Currency.
        search (str): Search.

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    params = self._get_params(locals())
    return self._get("operations", data=params, force_params=True)

```

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

### Get Transactions in Python

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves a list of transactions from the Plisio API. It supports filtering by page, limit, shop ID, type, status, currency, and a search query. The function prepares the parameters and makes a GET request to the 'operations' endpoint.

```python
def transactions(self, page: _t.OptionalNumberLike = None, limit: _t.OptionalNumberLike = None, shop_id: _t.OptionalNumberLike = None, type: _t.OptionalTransactionStatus = None, status: _t.OptionalTransactionStatus = None, currency: _t.OptionalCurrencies = None, search: _t.OptionalText = None) -> _t.Result:
    """
    Get transactions.

    See Also:
        https://plisio.net/documentation/endpoints/transactions

    Args:
        page (int): Page.
        limit (int): Limit.
        shop_id (int): Shop ID.
        type (str): Type.
        status (str): Status.
        currency (str): Currency.
        search (str): Search.

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    params = self._get_params(locals())
    return self._get("operations", data=params, force_params=True)
```

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

### Get Transaction Details (Python)

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves detailed information for a specific transaction using its ID. This asynchronous function makes a GET request to the Plisio API and returns the transaction data. It can raise exceptions if the request fails or the API returns an error.

```python
async def transaction_details(self, id: _t.Text) -> _t.Result:  # pylint: disable=invalid-name
    """
    Get transaction details.

    See Also:
        https://plisio.net/documentation/endpoints/transaction-details

    Args:
        id (str): Transaction ID.

    Returns:
        dict: Response data.

    Raises:
        PlisioRequestException: If request failed.
        PlisioAPIException: If API returned error.
    """

    return await self._get(f"operations/{id}")
```

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

### Client Initialization and Session Management

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Details on how the Plisio API client is initialized and manages its request sessions.

```APIDOC
## Client Class

Bases: `_BaseClient`

Async client for Plisio API.

### `_init_session()`

Initialize session.

*   **Returns**: Session: Session.

### `_handle_response(response: _t.SyncRequestResponse)`

Handle response.

*   **Args**:
    *   `response` (_t.SyncRequestResponse): Response.
*   **Returns**: _t.Result: Response.
*   **Raises**:
    *   `PlisioRequestException`: If request failed.
    *   `PlisioAPIException`: If API returned error.

### `_request(method: _t.Methods, uri: _t.Text, force_params: bool = False, **kwargs)`

Make request.

*   **Args**:
    *   `method` (_t.Methods): Method.
    *   `uri` (_t.Text): Path.
    *   `force_params` (bool): Force params.
    *   `**kwargs`: Arguments.
*   **Returns**: dict: Response data.
*   **Raises**:
    *   `PlisioRequestException`: If request failed.
    *   `PlisioAPIException`: If API returned error.
```

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

### Get Transactions with Python Plisio Client

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

This method retrieves a list of transactions from the Plisio API. It supports filtering by page, limit, shop ID, type, status, currency, and a search query. The parameters are collected and sent as a GET request to the 'operations' endpoint.

```python
params = self._get_params(locals())
return await self._get("operations", data=params, force_params=True)
```

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

### POST /invoices/new

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Creates a new invoice with specified details. This endpoint allows for detailed configuration of the invoice, including currency, amount, order information, and optional callbacks.

```APIDOC
## POST /invoices/new

### Description
Creates a new invoice with specified details. This endpoint allows for detailed configuration of the invoice, including currency, amount, order information, and optional callbacks.

### Method
POST

### Endpoint
/invoices/new

### Parameters
#### Query Parameters
- **order_name** (str) - Required - Order name.
- **order_number** (int) - Required - Order number.
- **currency** (str) - Required - Currency.
- **amount** (float) - Required - Amount.
- **source_currency** (str) - Optional - Source currency.
- **source_amount** (float) - Optional - Source amount.
- **allowed_psys_cids** (list) - Optional - Allowed payment systems.
- **description** (str) - Optional - Description.
- **callback_url** (str) - Optional - Callback URL.
- **success_callback_url** (str) - Optional - Success callback URL.
- **fail_callback_url** (str) - Optional - Fail callback URL.
- **email** (str) - Optional - Email.
- **language** (str) - Optional - Language. Defaults to 'en_US'.
- **plugin** (str) - Optional - Plugin.
- **version** (str) - Optional - Version.
- **redirect_to_invoice** (bool) - Optional - Redirect to invoice.
- **expire_min** (int) - Optional - Expire minutes.

### Request Example
```json
{
  "order_name": "Test Order",
  "order_number": 12345,
  "currency": "USD",
  "amount": 100.50,
  "description": "Example invoice for testing",
  "email": "test@example.com",
  "success_callback_url": "https://example.com/success",
  "fail_callback_url": "https://example.com/fail"
}
```

### Response
#### Success Response (200)
- **result** (dict) - Response data, typically containing invoice details and payment links.
- **status** (str) - The status of the operation.

#### Response Example
```json
{
  "status": "success",
  "result": {
    "invoice_id": "inv_12345abc",
    "order_name": "Test Order",
    "order_number": "12345",
    "currency": "USD",
    "amount": "100.50",
    "status": "new",
    "url": "https://plisio.net/pay/inv_12345abc"
  }
}
```

### Error Handling
- **PlisioRequestException**: Raised if the request to the Plisio API fails due to network issues or server errors.
- **PlisioAPIException**: Raised if the Plisio API returns an error, such as invalid parameters or insufficient funds.
```

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

### GET /operations

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients

Retrieves details for a specific transaction using its ID.

```APIDOC
## GET /operations

### Description
Retrieves details for a specific transaction using its ID.

### Method
GET

### Endpoint
/operations

### Parameters
#### Query Parameters
- **id** (str) - Required - The unique identifier of the transaction.

### Request Example
```json
{
  "id": "txn_12345"
}
```

### Response
#### Success Response (200)
- **id** (str) - The transaction ID.
- **amount** (float) - The transaction amount.
- **currency** (str) - The transaction currency.
- **status** (str) - The status of the transaction.

#### Response Example
```json
{
  "id": "txn_12345",
  "amount": 1000,
  "currency": "USD",
  "status": "completed"
}
```
```

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

### POST /invoices/new

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Create a new invoice with the specified details. This endpoint allows for detailed configuration of the invoice, including source and allowed payment currencies.

```APIDOC
## POST /invoices/new

### Description
Create a new invoice with the specified details. This endpoint allows for detailed configuration of the invoice, including source and allowed payment currencies.

### Method
POST

### Endpoint
/invoices/new

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **order_name** (str) - Required - The name of the order.
- **currency** (str) - Required - The currency for the invoice (e.g., 'USD', 'EUR').
- **amount** (float) - Required - The amount of the invoice.
- **order_number** (int) - Required - The unique order number.
- **source_currency** (str) - Optional - The source currency if a conversion is needed.
- **source_amount** (float) - Optional - The source amount if a conversion is needed.
- **allowed_psys_cids** (list) - Optional - A list of payment system IDs that are allowed for this invoice.
- **description** (str) - Optional - A description for the invoice.
- **callback_url** (str) - Optional - A URL to send notifications to upon invoice status changes.
- **success_callback_url** (str) - Optional - A URL to redirect the user to upon successful payment.
- **fail_callback_url** (str) - Optional - A URL to redirect the user to upon failed payment.
- **email** (str) - Optional - The email address of the customer.
- **language** (str) - Optional - The language for the invoice (defaults to 'en_US').
- **plugin** (str) - Optional - Identifier for a specific plugin.
- **version** (str) - Optional - The API version to use.
- **redirect_to_invoice** (bool) - Optional - Whether to redirect the user directly to the invoice page.
- **expire_min** (int) - Optional - The number of minutes until the invoice expires.

### Request Example
```json
{
  "order_name": "Example Product",
  "currency": "USD",
  "amount": 100.50,
  "order_number": 12345,
  "source_currency": "BTC",
  "source_amount": 0.002,
  "allowed_psys_cids": [1, 5],
  "description": "Payment for order #12345",
  "callback_url": "https://example.com/callback",
  "success_callback_url": "https://example.com/success",
  "fail_callback_url": "https://example.com/fail",
  "email": "customer@example.com",
  "language": "en",
  "expire_min": 60
}
```

### Response
#### Success Response (200)
- **result** (dict) - The response data containing invoice details.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "invoice_id": "inv_abc123",
    "url": "https://plisio.net/pay/inv_abc123",
    "status": "new"
  }
}
```
```

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

### Crypto Coins API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves a list of supported cryptocurrencies.

```APIDOC
## GET /crypto-coins

### Description
Retrieves a list of supported cryptocurrencies.

### Method
GET

### Endpoint
/crypto-coins

### Response
#### Success Response (200)
- **coins** (list) - A list of supported cryptocurrency objects, each containing details like name, symbol, and network.

#### Response Example
```json
{
  "coins": [
    {
      "name": "Bitcoin",
      "symbol": "BTC",
      "network": "mainnet"
    },
    {
      "name": "Ethereum",
      "symbol": "ETH",
      "network": "mainnet"
    }
  ]
}
```
```

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

### GET /operations

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/client

Retrieves details for a specific transaction using its ID.

```APIDOC
## GET /operations

### Description
Retrieves details for a specific transaction using its ID.

### Method
GET

### Endpoint
/operations

### Parameters
#### Query Parameters
- **id** (str) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **data** (dict) - Response data containing the transaction details.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "id": "txn_12345abcde",
    "amount": "100.00",
    "currency": "USD",
    "status": "completed"
  }
}
```
```

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

### Fee Plans API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves available fee plans for a given payment system CID.

```APIDOC
## GET /operations/fee-plan/{psys_cid}

### Description
Get available fee plans for a specific payment system.

### Method
GET

### Endpoint
/operations/fee-plan/{psys_cid}

### Parameters
#### Path Parameters
- **psys_cid** (str) - Required - Payment system CID.

### Response
#### Success Response (200)
- **dict** (_t.Result) - Response data containing a list of fee plans.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "name": "Standard Fee",
      "fee_percentage": "1.0"
    },
    {
      "name": "Low Fee",
      "fee_percentage": "0.5"
    }
  ]
}
```

### Errors
- **PlisioRequestException**: If request failed.
- **PlisioAPIException**: If API returned error.
```

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

### Fee Plans API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves available fee plans for a given payment system.

```APIDOC
## GET /operations/fee-plan/{psys_cid}

### Description
Retrieves available fee plans for a given payment system.

### Method
GET

### Endpoint
/operations/fee-plan/{psys_cid}

### Parameters
#### Path Parameters
- **psys_cid** (str) - Required - The unique identifier of the payment system.

### Response
#### Success Response (200)
- **fee_plans** (list) - A list of available fee plans for the specified payment system.

#### Response Example
```json
{
  "fee_plans": [
    "standard",
    "express",
    "low_priority"
  ]
}
```
```

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

### GET /operations/{id}

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Retrieves the details of a specific transaction using its unique ID.

```APIDOC
## GET /operations/{id}

### Description
Retrieves the details of a specific transaction using its unique ID.

### Method
GET

### Endpoint
/operations/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - Transaction ID.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **dict** (_t.Result) - Response data.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "id": "txn_12345",
    "amount": "100.00",
    "currency": "USD",
    "status": "completed"
  }
}
```

### Error Handling
- **PlisioRequestException**: If request failed.
- **PlisioAPIException**: If API returned error.
```

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

### Balance API

Source: https://python-plisio.readthedocs.io/en/latest/reference/clients/async_client

Fetches the current balance for specified payment systems.

```APIDOC
## GET /balance/

### Description
Fetches the current balance for specified payment systems.

### Method
GET

### Endpoint
/balance/

### Parameters
#### Query Parameters
- **psys_cid** (str) - Optional - The unique identifier of the payment system to get the balance for. If not provided, balances for all systems may be returned.

### Response
#### Success Response (200)
- **balances** (dict) - A dictionary where keys are payment system CIDs and values are their respective balances.

#### Response Example
```json
{
  "balances": {
    "plisio_usd": 5000.50,
    "bitcoin": 2.345
  }
}
```
```
Tokens:
Raw