Play Wallet API

https://docs.playwallet.bot/ru/api
Admin
Play Wallet API is a cryptocurrency-based payment solution for Steam account top-ups, enabling...
Tokens:6,041
Snippets:33
Trust Score:5.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Retrieve Merchant Balance and Services

Source: https://docs.playwallet.bot/ru/api

Example response for the GET /get-balance endpoint, which returns the current merchant balance, frozen funds, fee ratio, and available services.

```json
{
    "status": "success",
    "message": "",
    "data": {
        "balance": "0.00",
        "frozenBalance": "0.00",
        "feeRatio": "0.0600",
        "services": [
            {
                "id": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
                "name": "test",
                "minAmount": "0.25",
                "maxAmount": "200.00"
            }
        ]
    }
}
```

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

### Get Order Status Response

Source: https://docs.playwallet.bot/ru/api

Example response containing the current status of a specific order.

```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
        "status": "completed",
        "externalId": "7",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "1.00",
        "amountFee": "0.03",
        "feeRatio": "0.03",
        "createdDateTime": "2024-04-18T17:36:55.453116",
        "expiredDateTime": "2024-04-18T17:46:55.453069",
        "completedDateTime": "2024-04-18T17:44:31.974430"
    }
}
```

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

### Create Order Response

Source: https://docs.playwallet.bot/ru/api

Example response returned after successfully creating an order.

```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
        "status": "queued",
        "externalId": "7",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "1.00",
        "amountFee": "0.03",
        "feeRatio": "0.03",
        "createdDateTime": "2024-04-18T17:36:55.453116",
        "expiredDateTime": "2024-04-18T17:46:55.453069",
        "completedDateTime": null
    }
}
```

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

### Pay Order Response

Source: https://docs.playwallet.bot/ru/api

Example response returned after processing an order payment.

```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "b8509f61-17fd-4578-8529-7bfb29f14d39",
        "status": "queued",
        "externalId": "ext-12345",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "150.00",
        "amountFee": "0.00",
        "feeRatio": "0.00",
        "createdDateTime": "2024-04-16T03:07:16.739351",
        "expiredDateTime": "2024-04-16T03:34:14",
        "completedDateTime": null
    }
}
```

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

### GET /get-order-list/

Source: https://docs.playwallet.bot/ru/api

Retrieves a list of merchant orders with pagination support.

```APIDOC
## GET /get-order-list/

### Description
Retrieves the merchant's order history.

### Method
GET

### Endpoint
/get-order-list/

### Parameters
#### Headers
- **pw_api_key** (string) - Required - API key of the merchant.

#### Query Parameters
- **offset** (integer) - Optional - The starting point for the list of orders. Defaults to 0.
- **limit** (integer) - Optional - The number of orders to return. Defaults to 10.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success' or 'error').
- **message** (string) - Contains an error message if the status is 'error'.
- **data** (array) - An array of order objects.
  - **id** (string) - The unique identifier for the order.
  - **status** (string) - The current status of the order (e.g., 'active', 'completed', 'error').
  - **externalId** (string) - The external identifier for the order.
  - **serviceId** (string) - The identifier for the service associated with the order.
  - **amount** (string) - The amount of the order.
  - **amountFee** (string) - The fee amount for the order.
  - **feeRatio** (string) - The fee ratio for the order.
  - **createdDateTime** (string) - The date and time when the order was created.
  - **expiredDateTime** (string) - The date and time when the order expires.
  - **completedDateTime** (string) - The date and time when the order was completed (null if not completed).

### Response Example
```json
{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": "8ca9e0bf-b45b-43c4-acb2-93f467b1760e",
            "status": "active",
            "externalId": "6",
            "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
            "amount": "1.00",
            "amountFee": "0.03",
            "feeRatio": "0.03",
            "createdDateTime": "2024-04-18T17:33:13.510839",
            "expiredDateTime": "2024-04-18T17:43:13.510798",
            "completedDateTime": null
        },
        {
            "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
            "status": "completed",
            "externalId": "7",
            "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
            "amount": "1.00",
            "amountFee": "0.03",
            "feeRatio": "0.03",
            "createdDateTime": "2024-04-18T17:36:55.453116",
            "expiredDateTime": "2024-04-18T17:46:55.453069",
            "completedDateTime": "2024-04-18T17:44:31.974430"
        }
    ]
}
```
```

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

### GET /get-balance

Source: https://docs.playwallet.bot/ru/api

Retrieves the merchant's balance and a list of available services for payment.

```APIDOC
## GET /get-balance

### Description
Retrieves the merchant's balance and a list of available services for payment.

### Method
GET

### Endpoint
/get-balance

### Headers
- **pw-api-key** (string) - Required - The API key of the merchant.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request (e.g., "success").
- **message** (string) - An optional message related to the request.
- **data** (object) - Contains balance and service information.
  - **balance** (string) - The current balance of the merchant.
  - **frozenBalance** (string) - The amount of frozen balance.
  - **feeRatio** (string) - The fee ratio for transactions.
  - **services** (array) - A list of available services.
    - **id** (string) - The unique identifier for the service.
    - **name** (string) - The name of the service.
    - **minAmount** (string) - The minimum amount for the service.
    - **maxAmount** (string) - The maximum amount for the service.

### Response Example
```json
{
    "status": "success",
    "message": "",
    "data": {
        "balance": "0.00",
        "frozenBalance": "0.00",
        "feeRatio": "0.0600",
        "services": [
            {
                "id": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
                "name": "test",
                "minAmount": "0.25",
                "maxAmount": "200.00"
            }
        ]
    }
}
```
```

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

### GET /get-order/{id}

Source: https://docs.playwallet.bot/ru/api

Retrieves the current status of a specific order using its ID.

```APIDOC
## GET /get-order/{id}

### Description
Retrieves the current status of a specific order using its ID.

### Method
GET

### Endpoint
/get-order/{id}

### Headers
- **pw_api_key** (string) - Required - API-ключ мерчанта.

### Path Parameters
- **id** (string) - Required - Идентификатор заказа.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request.
- **message** (string) - Any additional messages.
- **data** (object) - Contains details of the order.
  - **id** (string) - Unique identifier for the order.
  - **status** (string) - Current status of the order.
  - **externalId** (string) - The external ID of the order.
  - **serviceId** (string) - The ID of the service ordered.
  - **amount** (string) - The amount of the order.
  - **amountFee** (string) - The fee amount for the order.
  - **feeRatio** (string) - The fee ratio for the order.
  - **createdDateTime** (string) - The date and time the order was created.
  - **expiredDateTime** (string) - The date and time the order expires.
  - **completedDateTime** (string | null) - The date and time the order was completed, or null if not completed.

#### Response Example
```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
        "status": "completed",
        "externalId": "7",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "1.00",
        "amountFee": "0.03",
        "feeRatio": "0.03",
        "createdDateTime": "2024-04-18T17:36:55.453116",
        "expiredDateTime": "2024-04-18T17:46:55.453069",
        "completedDateTime": "2024-04-18T17:44:31.974430"
    }
}
```
```

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

### Get Merchant Order List

Source: https://docs.playwallet.bot/ru/api

Retrieves a merchant's order history. Requires 'pw_api_key' in headers. Supports 'offset' and 'limit' query parameters for pagination.

```json
{
    "status": "success",
    "message": "",
    "data": [
       
        {
            "id": "8ca9e0bf-b45b-43c4-acb2-93f467b1760e",
            "status": "active",
            "externalId": "6",
            "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
            "amount": "1.00",
            "amountFee": "0.03",
            "feeRatio": "0.03",
            "createdDateTime": "2024-04-18T17:33:13.510839",
            "expiredDateTime": "2024-04-18T17:43:13.510798",
            "completedDateTime": null
        },
        {
            "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
            "status": "completed",
            "externalId": "7",
            "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
            "amount": "1.00",
            "amountFee": "0.03",
            "feeRatio": "0.03",
            "createdDateTime": "2024-04-18T17:36:55.453116",
            "expiredDateTime": "2024-04-18T17:46:55.453069",
            "completedDateTime": "2024-04-18T17:44:31.974430"
        }
    ]
}
```

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

### POST /create-order/

Source: https://docs.playwallet.bot/ru/api

Creates a new order in the PlayWallet system. Requires merchant API key in headers and order details in the request body.

```APIDOC
## POST /create-order/

### Description
Creates a new order in the PlayWallet system. Requires merchant API key in headers and order details in the request body.

### Method
POST

### Endpoint
/create-order/

### Headers
- **pw-api-key** (string) - Required - API-ключ мерчанта

### Request Body
- **externalId** (string) - Required - Уникальный идентификатор заказа, предоставленный клиентом. Используется для связи заказа с внешней системой клиента.
- **serviceId** (string) - Required - Идентификатор услуги, которую клиент хочет заказать. Должен соответствовать одной из услуг, доступных в системе.
- **amount** (string) - Required - Сумма заказа в валюте, установленной для мерчанта. Должна быть представлена в виде строки с двумя десятичными знаками.
- **login** (string) - Required - Логин пользователя, для которого создается заказ.

### Request Example
```json
{
  "externalId": "ext-12345",
  "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
  "amount": "150.00",
  "login": "user123"
}
```

### Response
#### Success Response (200)
- **status** (string) - Description of the order status.
- **message** (string) - Any additional messages.
- **data** (object) - Contains order details.
  - **id** (string) - Unique identifier for the created order.
  - **status** (string) - Current status of the order.
  - **externalId** (string) - The external ID provided during creation.
  - **serviceId** (string) - The ID of the service ordered.
  - **amount** (string) - The amount of the order.
  - **amountFee** (string) - The fee amount for the order.
  - **feeRatio** (string) - The fee ratio for the order.
  - **createdDateTime** (string) - The date and time the order was created.
  - **expiredDateTime** (string) - The date and time the order expires.
  - **completedDateTime** (string | null) - The date and time the order was completed, or null if not completed.

#### Response Example
```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
        "status": "queued",
        "externalId": "7",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "1.00",
        "amountFee": "0.03",
        "feeRatio": "0.03",
        "createdDateTime": "2024-04-18T17:36:55.453116",
        "expiredDateTime": "2024-04-18T17:46:55.453069",
        "completedDateTime": null
    }
}
```
```

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

### Create Order Request

Source: https://docs.playwallet.bot/ru/api

JSON body required to create a new order in the system.

```json
{
  "externalId": "ext-12345",
  "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
  "amount": "150.00",
  "login": "user123"
}
```

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

### POST /pay-order/

Source: https://docs.playwallet.bot/ru/api

Processes the payment for a previously created order. Requires merchant API key and a generated token based on order details.

```APIDOC
## POST /pay-order/

### Description
Processes the payment for a previously created order. Requires merchant API key and a generated token based on order details.

### Method
POST

### Endpoint
/pay-order/

### Headers
- **pw_api_key** (string) - Required - API-ключ мерчанта.

### Request Body
- **id** (string) - Required - Идентификатор заказа.
- **createdDateTime** (string) - Required - Время создания заказа.
- **token** (string) - Required - Хеш-строка, представляющая токен, сгенерированный путем применения SHA-512 к конкатенации `id` и `createdDateTime`.

### Request Example
```json
{
  "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
  "externalId": "ext-12345",
  "token": "db8e5992e47c48b46f59ecdd1789cc525f4061a52fbf8200dbdab4bc0929de9cf2f61bd8725314440c498a694176b06a2faec22776be4dc8123fffee14b027a5"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the payment processing.
- **message** (string) - Any additional messages.
- **data** (object) - Contains details of the processed order.
  - **id** (string) - Unique identifier for the order.
  - **status** (string) - Current status of the order.
  - **externalId** (string) - The external ID of the order.
  - **serviceId** (string) - The ID of the service ordered.
  - **amount** (string) - The amount of the order.
  - **amountFee** (string) - The fee amount for the order.
  - **feeRatio** (string) - The fee ratio for the order.
  - **createdDateTime** (string) - The date and time the order was created.
  - **expiredDateTime** (string) - The date and time the order expires.
  - **completedDateTime** (string | null) - The date and time the order was completed, or null if not completed.

#### Response Example
```json
{
    "status": "success",
    "message": "",
    "data": {
        "id": "b8509f61-17fd-4578-8529-7bfb29f14d39",
        "status": "queued",
        "externalId": "ext-12345",
        "serviceId": "ff71c998-14be-4e3d-8ad3-0ffc8357265b",
        "amount": "150.00",
        "amountFee": "0.00",
        "feeRatio": "0.00",
        "createdDateTime": "2024-04-16T03:07:16.739351",
        "expiredDateTime": "2024-04-16T03:34:14",
        "completedDateTime": null
    }
}
```
```

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

### Authentication

Source: https://docs.playwallet.bot/ru/api

All API requests must be authorized using an API key, which is passed via the `pw-api-key` header. The client IP must also be on the allowed IP list for the merchant.

```APIDOC
## Authorization

All requests to the API must be authorized using an API key, which is passed via the `pw-api-key` header. The client IP must be on the list of allowed IPs for this merchant.

Base URL: `https://dev.merchant.playwallet.bot/api/merchant/`
```

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

### Order Statuses

Source: https://docs.playwallet.bot/ru/api

Explanation of the possible statuses for an order.

```APIDOC
## Order Statuses

### Description
Provides a description of the different statuses an order can have.

### Statuses
- **active** - Awaiting payment confirmation.
- **queued** - Currently in the processing queue.
- **completed** - Successfully processed.
- **error** - Processing failed, meaning the order was not paid and no charges were incurred.
```

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

### Pay Order Request

Source: https://docs.playwallet.bot/ru/api

JSON body required to pay for an existing order, including the merchant-generated SHA-512 token.

```json
{
  "id": "72cf5503-ae6a-45af-97b8-aae3a0731687",
  "externalId": "ext-12345",
  "token": "db8e5992e47c48b46f59ecdd1789cc525f4061a52fbf8200dbdab4bc0929de9cf2f61bd8725314440c498a694176b06a2faec22776be4dc8123fffee14b027a5"
}
```
Tokens:
Raw