YooMoney

https://yookassa.ru/developers/api
Admin
YooMoney is an electronic payment service that provides an API for developers to integrate payment...
Tokens:144,666
Snippets:752
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### List deals request via cURL

Source: https://yookassa.ru/developers/api?lang=en

Example of a GET request to retrieve a list of deals using cURL.

```bash
curl https://api.yookassa.ru/v3/deals \
  -X GET
  -u <Идентификатор магазина>:<Секретный ключ>
```

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

### Me object structure example

Source: https://yookassa.ru/developers/api

Example of the JSON object returned when requesting store or gateway settings.

```json
{
  "account_id": "123",
  "test": true,
  "fiscalization": {
    "provider": "atol",
    "enabled": true
  },
  "fiscalization_enabled": true,
  "payment_methods": [
    "bank_card",
    "yoo_money"
  ],
  "status": "enabled"
}
```

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

### Webhook Object Example

Source: https://yookassa.ru/developers/api

Example of the Webhook object structure containing event subscription information.

```json
{
  "id": "e44e8088-bd73-43b1-959a-954f3a7d0c54",
  "event": "payment.succeeded",
  "url": "https://www.example.com/notification_url"
}
```

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

### Payout Search Response Example

Source: https://yookassa.ru/developers/api

Example JSON response structure for a payout search request.

```JSON
{
    "type": "list",
    "items": [
        {
            "id": "po-285c0ab7-0003-5000-9000-0e1166498fda",
            "amount": {
                "value": "400.00",
                "currency": "RUB"
            },
            "status": "canceled",
            "payout_destination": {
                "type": "bank_card",
                "card": {
                    "first6": "444444",
                    "last4": "4448",
                    "card_type": "Visa",
                    "issuer_country": "PL",
                    "issuer_name": "Krakowski Bank Spoldzielczy"
                }
            },
            "description": "Payment for order No. 37",
            "created_at": "2021-06-16T13:04:55.633Z",
            "metadata": {
                "order_id": "37"
            },
            "cancellation_details": {
                "party": "yoo_money",
                "reason": "general_decline"
            },
            "test": false
        }
    ],
    "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}
```

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

### Get deal information request via cURL

Source: https://yookassa.ru/developers/api?lang=en

Example of a request to retrieve information about a specific deal using its unique identifier.

```bash
curl https://api.yookassa.ru/v3/deals/{deal_id} \
  -u <Идентификатор магазина>:<Секретный ключ>
```

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

### Safe Deal Request Body Example

Source: https://yookassa.ru/developers/api

Example structure of a safe deal request body.

```json
{
  "type": "safe_deal",
  "fee_moment": "deal_closed",
  "id": "dl-285e5ee7-0022-5000-8000-01516a44b147",
  "balance": {
    "value": "-45.00",
    "currency": "RUB"
  },
  "payout_balance": {
    "value": "0.00",
    "currency": "RUB"
  },
  "status": "closed",
  "created_at": "2021-06-18T07:28:39.390Z",
  "expires_at": "2021-09-16T07:28:39.390Z",
  "metadata": {
    "order_id": "37"
  },
  "description": "SAFE_DEAL 123554642-2432FF344R",
  "test": false
}
```

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

### GET /deals

Source: https://yookassa.ru/developers/api?lang=ru

Получение списка сделок.

```APIDOC
## GET /deals

### Description
Получение списка созданных сделок.

### Method
GET

### Endpoint
/deals
```

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

### GET /deals

Source: https://yookassa.ru/developers/api?lang=en

Retrieves a list of existing deals.

```APIDOC
## GET /deals

### Description
Retrieves a list of deals.

### Method
GET

### Endpoint
/deals
```

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

### SbpParticipantBank Object Example

Source: https://yookassa.ru/developers/api?lang=en

Example of the SbpParticipantBank object, which contains the bank_id, name, and BIC of an SBP participant.

```json
{
  "bank_id": "100000000111",
  "name": "Сбербанк",
  "bic": "044525225"
}
```

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

### GET /payments/{payment_id}

Source: https://yookassa.ru/developers/api

Get detailed information about a specific payment.

```APIDOC
## GET /payments/{payment_id}

### Description
Retrieves information about a specific payment by its ID.

### Method
GET

### Endpoint
/payments/{payment_id}

### Parameters
#### Path Parameters
- **payment_id** (string) - Required - Payment ID in YooMoney.
```

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

### GET /me

Source: https://yookassa.ru/developers/api

Retrieves the current settings object for the authenticated store or gateway.

```APIDOC
## GET /me

### Description
Returns the settings object (Me) containing up-to-date information about the requested store or gateway. The returned parameters vary based on whether a store or a payout gateway is requested.

### Method
GET

### Endpoint
/me

### Response
#### Success Response (200)
- **account_id** (string) - Store or gateway ID in YooMoney.
- **status** (string) - Status of the store or gateway (enabled/disabled).
- **test** (boolean) - Indicates if this is a demo store or test gateway.
- **fiscalization** (object) - Store settings for sending receipts to the Tax Service.
- **payment_methods** (array) - List of payment methods available to the store.
- **itn** (string) - Store's INN (TIN).
- **payout_methods** (array) - List of payout methods available to the gateway.
- **name** (string) - Name of the gateway.
- **payout_balance** (object) - Balance of the gateway.

#### Response Example
{
  "account_id": "123",
  "test": true,
  "fiscalization": {
    "provider": "atol",
    "enabled": true
  },
  "fiscalization_enabled": true,
  "payment_methods": [
    "bank_card",
    "yoo_money"
  ],
  "status": "enabled"
}
```

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

### GET /v3/deals

Source: https://yookassa.ru/developers/api?lang=ru

Получение списка сделок, отфильтрованного по заданным критериям. Поддерживает фильтрацию по времени создания, времени закрытия, статусу, поиску по описанию, а также пагинацию.

```APIDOC
## GET /v3/deals

### Description
Получение списка сделок, отфильтрованного по заданным критериям.

### Method
GET

### Endpoint
https://api.yookassa.ru/v3/deals

### Parameters
#### Query Parameters
- **created_at.gte** (string) - Optional - Фильтр по времени создания (>= ISO 8601)
- **created_at.gt** (string) - Optional - Фильтр по времени создания (> ISO 8601)
- **created_at.lte** (string) - Optional - Фильтр по времени создания (<= ISO 8601)
- **created_at.lt** (string) - Optional - Фильтр по времени создания (< ISO 8601)
- **expires_at.gte** (string) - Optional - Фильтр по времени автоматического закрытия (>= ISO 8601)
- **expires_at.gt** (string) - Optional - Фильтр по времени автоматического закрытия (> ISO 8601)
- **expires_at.lte** (string) - Optional - Фильтр по времени автоматического закрытия (<= ISO 8601)
- **expires_at.lt** (string) - Optional - Фильтр по времени автоматического закрытия (< ISO 8601)
- **status** (string) - Optional - Фильтр по статусу сделки
- **full_text_search** (string) - Optional - Фильтр по описанию сделки (4-128 символов)
- **limit** (integer) - Optional - Размер выдачи (1-100, по умолчанию 10)
- **cursor** (string) - Optional - Указатель на следующий фрагмент списка

### Response
#### Success Response (200)
- **type** (string) - Тип объекта (list)
- **items** (array) - Список объектов сделок
- **next_cursor** (string) - Указатель на следующий фрагмент списка

#### Response Example
{
  "type": "list",
  "items": [
    {
      "type": "safe_deal",
      "id": "dl-285e5ee7-0022-5000-8000-01516a44b147",
      "status": "closed",
      "created_at": "2021-06-18T07:28:39.390Z"
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}
```

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

### Create a refund request

Source: https://yookassa.ru/developers/api?lang=en

Use this cURL command to initiate a refund for a specific payment. Replace the placeholders with your shop ID, secret key, and idempotence key.

```bash
curl https://api.yookassa.ru/v3/refunds \
  -X POST \
  -u <Идентификатор магазина>:<Секретный ключ> \
  -H 'Idempotence-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
        "amount": {
          "value": "2.00",
          "currency": "RUB"
        },
        "payment_id": "215d8da0-000f-50be-b000-0003308c89be"
      }'
```

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

### GET /v3/me

Source: https://yookassa.ru/developers/api

Retrieves the settings object for the store or gateway associated with the provided authentication credentials or OAuth token.

```APIDOC
## GET /v3/me

### Description
Retrieves information about the settings of a store or gateway. The response depends on the authentication method used (OAuth token, platform credentials, or gateway credentials).

### Method
GET

### Endpoint
https://api.yookassa.ru/v3/me

### Parameters
#### Query Parameters
- **on_behalf_of** (string) - Optional - Only for Split payments. ID of the seller's store connected to your platform.

### Request Example
curl https://api.yookassa.ru/v3/me \
  -H 'Authorization: Bearer <oauth_token>'

### Response
#### Success Response (200)
- **account_id** (string) - ID of the store or gateway.
- **test** (boolean) - Indicates if the store is in test mode.
- **fiscalization** (object) - Fiscalization provider details.
- **fiscalization_enabled** (boolean) - Status of fiscalization.
- **payment_methods** (array) - List of enabled payment methods.
- **status** (string) - Current status of the store.

#### Response Example
{
  "account_id": "123",
  "test": true,
  "fiscalization": {
    "provider": "atol",
    "enabled": true
  },
  "fiscalization_enabled": true,
  "payment_methods": [
    "bank_card",
    "yoo_money"
  ],
  "status": "enabled"
}
```

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

### Get SBP Participants Request

Source: https://yookassa.ru/developers/api?lang=en

cURL command to retrieve the list of all SBP participants using the GET method.

```bash
curl https://api.yookassa.ru/v3/sbp_banks \
  -X GET
  -u <Идентификатор шлюза>:<Секретный ключ>
```

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

### Create Webhook Request

Source: https://yookassa.ru/developers/api

Example cURL request to subscribe to a specific event notification.

```bash
curl https://api.yookassa.ru/v3/webhooks \
  -X POST \
  -H 'Authorization: Bearer <oauth_token>' \
  -H 'Idempotence-Key: <Idempotence Key>' \
  -H 'Content-Type: application/json' \
  -d '{
        "event": "payment.succeeded",
        "url": "https://www.example.com/notification_url"
      }'
```

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

### List deals response body

Source: https://yookassa.ru/developers/api?lang=en

Example of the JSON response body returned when listing deals, including the next_cursor for pagination.

```json
{
  "type": "list",
  "items": [
    {
      "type": "safe_deal",
      "fee_moment": "deal_closed",
      "id": "dl-285e5ee7-0022-5000-8000-01516a44b147",
      "balance": {
        "value": "-45.00",
        "currency": "RUB"
      },
      "payout_balance": {
        "value": "0.00",
        "currency": "RUB"
      },
      "status": "closed",
      "created_at": "2021-06-18T07:28:39.390Z",
      "expires_at": "2021-09-16T07:28:39.390Z",
      "metadata": {
        "order_id": "37"
      },
      "description": "SAFE_DEAL 123554642-2432FF344R",
      "test": false
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}
```

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

### GET /payouts

Source: https://yookassa.ru/developers/api?lang=ru

Получение списка выплат.

```APIDOC
## GET /payouts

### Description
Получение списка созданных выплат.

### Method
GET

### Endpoint
/payouts
```

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

### GET /payments

Source: https://yookassa.ru/developers/api?lang=ru

Получение списка платежей.

```APIDOC
## GET /payments

### Description
Возвращает список платежей.

### Method
GET

### Endpoint
/payments
```

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

### Create Webhook Request and Response

Source: https://yookassa.ru/developers/api?lang=ru

Example cURL request to create a webhook and the corresponding JSON response body.

```bash
curl https://api.yookassa.ru/v3/webhooks \
  -X POST \
  -H 'Authorization: Bearer <oauth_token>' \
  -H 'Idempotence-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
        "event": "payment.succeeded",
        "url": "https://www.example.com/notification_url"
      }'
```

```json
{
  "id": "e44e8088-bd73-43b1-959a-954f3a7d0c54",
  "event": "payment.succeeded",
  "url": "https://www.example.com/notification_url"
}
```

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

### GET /receipts

Source: https://yookassa.ru/developers/api?lang=en

Retrieves a list of receipts.

```APIDOC
## GET /receipts

### Description
Retrieves a list of receipts.

### Method
GET

### Endpoint
/receipts
```

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

### List Webhooks Request and Response

Source: https://yookassa.ru/developers/api?lang=ru

Example cURL request to list all webhooks and the corresponding JSON response body.

```bash
curl https://api.yookassa.ru/v3/webhooks \
  -H 'Authorization: Bearer <oauth_token>'
```

```json
{
  "type": "list",
  "items": [
    {
      "id": "e44e8088-bd73-43b1-959a-954f3a7d0c54",
      "event": "payment.succeeded",
      "url": "https://www.example.com/notification_url"
    },
    {
      "id": "8d30d343-3441-4af8-9e48-633b8e5e8c21",
      "event": "payment.canceled",
      "url": "https://www.example.com/notification_url"
    }
  ]
}
```
Tokens:
Raw