Plisio API

https://plisio.net/swagger/docs
Admin
Plisio API provides a programmatic interface for integrating with Plisio's cryptocurrency payment...
Tokens:1,615
Snippets:7
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Currencies API

Source: https://plisio.net/swagger/docs/index

List all supported cryptocurrencies for a given fiat currency.

```APIDOC
## GET /currencies/{fiat}

### Description
List of supported cryptocurrencies for a given fiat currency.

### Method
GET

### Endpoint
/currencies/{fiat}

### Parameters
#### Path Parameters
- **fiat** (string) - Required - The fiat currency code (e.g., USD, EUR).

### Response
#### Success Response (200)
- **CryptocurrencyApiResponseDto** (object) - The API response containing cryptocurrency information.
```

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

### Shop API

Source: https://plisio.net/swagger/docs/index

Manage shop-related functionalities, including deposits and shop information.

```APIDOC
## GET /shops/deposit

### Description
Returns a list of shop deposits by UID.

### Method
GET

### Endpoint
/shops/deposit

### Response
#### Success Response (200)
- **ShopDepositResponseDto** (object) - The API response containing a list of shop deposits.
```

```APIDOC
## GET /shops/deposit/new

### Description
Create a new shop deposit.

### Method
GET

### Endpoint
/shops/deposit/new

### Response
#### Success Response (200)
- **ShopDepositResponseDto** (object) - Details of the newly created shop deposit.
```

```APIDOC
## GET /shops

### Description
Get shop information using the API key.

### Method
GET

### Endpoint
/shops

### Query Parameters
- **api_key** (string) - Required - The API key for the shop.

### Response
#### Success Response (200)
- **ShopDto** (object) - Information about the shop.
```

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

### Payment Button API

Source: https://plisio.net/swagger/docs/index

Create and manage payment buttons.

```APIDOC
## GET /payment-button/new/{hash}

### Description
Create a new payment button using a provided hash.

### Method
GET

### Endpoint
/payment-button/new/{hash}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The hash identifier for creating the payment button.

### Response
#### Success Response (200)
- **PaymentButtonDto** (object) - Details of the created payment button.
```

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

### Telegram Bot API

Source: https://plisio.net/swagger/docs/index

Create webhook for a Telegram bot.

```APIDOC
## POST /telegram-bot/create

### Description
Create a Telegram bot webhook.

### Method
POST

### Endpoint
/telegram-bot/create

### Request Body
- **webhook_url** (string) - Required - The URL for the Telegram bot webhook.
- **api_key** (string) - Required - The API key for the Telegram bot.

### Request Example
```json
{
  "webhook_url": "https://your-domain.com/your-webhook-path",
  "api_key": "YOUR_TELEGRAM_BOT_API_KEY"
}
```

### Response
#### Success Response (200)
- **SuccessResponseDto** (object) - Indicates the successful creation of the webhook.
```

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

### Balance API

Source: https://plisio.net/swagger/docs/index

Retrieve cryptocurrency balance for a specific payment system currency.

```APIDOC
## GET /balances/{psys_cid}

### Description
Get cryptocurrency balance for a specific payment system currency.

### Method
GET

### Endpoint
/balances/{psys_cid}

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The unique identifier for the payment system currency.

### Response
#### Success Response (200)
- **BalanceApiResponseDto** (object) - The API response containing balance information.
- **BalanceResponseDto** (object) - Details of the balance.
```

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

### Invoice API

Source: https://plisio.net/swagger/docs/index

Manage invoices, including creation, retrieval, and updates.

```APIDOC
## GET /invoices/new

### Description
Create a new invoice.

### Method
GET

### Endpoint
/invoices/new

### Response
#### Success Response (200)
- **InvoiceResponseDto** (object) - Details of the newly created invoice.
```

```APIDOC
## GET /invoices/switch/{id}

### Description
Get details of an invoice that has been switched.

### Method
GET

### Endpoint
/invoices/switch/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the invoice.

### Response
#### Success Response (200)
- **InvoiceResponseDto** (object) - Details of the invoice.
```

```APIDOC
## GET /invoices/email/{id}

### Description
Get invoice details, intended for email notification.

### Method
GET

### Endpoint
/invoices/email/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the invoice.

### Response
#### Success Response (200)
- **InvoiceResponseDto** (object) - Details of the invoice.
```

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

### Description
Get details of a specific invoice.

### Method
GET

### Endpoint
/invoices/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the invoice.

### Response
#### Success Response (200)
- **InvoiceResponseDto** (object) - Details of the invoice.
```

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

### Transaction API

Source: https://plisio.net/swagger/docs/index

Manage and retrieve transaction information, including fees and commissions.

```APIDOC
## GET /operations/commission/{psys_cid}

### Description
Estimate the cryptocurrency fee and Plisio commission for a transaction.

### Method
GET

### Endpoint
/operations/commission/{psys_cid}

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The unique identifier for the payment system currency.

### Response
#### Success Response (200)
- **CommissionApiResponseDto** (object) - The API response containing commission information.
```

```APIDOC
## GET /operations/withdraw

### Description
Initiate a withdrawal operation. This endpoint is also used for creating new invoices.

### Method
GET

### Endpoint
/operations/withdraw

### Response
#### Success Response (200)
- **WithdrawApiResponseDto** (object) - The API response containing withdrawal information.
```

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

### Description
Estimate the transaction fee for a specific cryptocurrency.

### Method
GET

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

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The unique identifier for the payment system currency.

### Response
#### Success Response (200)
- **FeeApiResponseDto** (object) - The API response containing fee information.
```

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

### Description
Retrieve the fee plans for a specific cryptocurrency.

### Method
GET

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

### Parameters
#### Path Parameters
- **psys_cid** (string) - Required - The unique identifier for the payment system currency.

### Response
#### Success Response (200)
- **FeePlanApiResponseDto** (object) - The API response containing fee plan information.
```

```APIDOC
## GET /operations

### Description
List all user transactions.

### Method
GET

### Endpoint
/operations

### Response
#### Success Response (200)
- **OperationsApiResponseDto** (object) - The API response containing a list of transactions.
```

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

### Description
Get details of a specific transaction.

### Method
GET

### Endpoint
/operations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the transaction.

### Response
#### Success Response (200)
- **OperationApiResponseDto** (object) - The API response containing transaction details.
```
Tokens:
Raw