YooMoney Wallet API

https://yoomoney.ru/docs/wallet
Admin
YooMoney Wallet API enables individuals to send and receive money transfers, make payments from bank...
Tokens:43,530
Snippets:327
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### HTTP Request Example

Source: https://yoomoney.ru/docs/wallet/using-api/format/protocol-request

A complete example of a POST request formatted with the required headers and body parameters.

```http
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer 410012345678901.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123

param1=value1&param2=value2&param3=value3
```

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

### Full Authorization Request Example

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/request-access-token

A complete HTTP POST request example with URL-encoded parameters.

```http
POST /oauth/authorize HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 191

client_id=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ01&response_type=code&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb&scope=account%2Dinfo%20operation%2Dhistory
```

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

### Request-payment P2P transfer examples

Source: https://yoomoney.ru/docs/wallet/process-payments/request-payment

Examples of POST requests to initiate a P2P transfer to a user account or a linked phone number.

```HTTP
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer 410012345678901.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123
Content-Type: application/x-www-form-urlencoded
Content-Length: 234

pattern_id=p2p&to=41001101140&amount=1000.00&message=%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B0&comment=%D0%A1%D0%BE%D0%BE%D0%B1%D1%89%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B0%D1%82%D0%B5%D0%BB%D1%8E
```

```HTTP
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer 410012345678901.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123
Content-Type: application/x-www-form-urlencoded
Content-Length: 256

pattern_id=p2p&to=79219990099&identifier_type=phone&amount=1000.00&message=%d0%97%d0%b0+%d0%b2%d0%ba%d1%83%d1%81%d0%bd%d1%8b%d0%b9+%d0%b1%d1%83%d0%b1%d0%bb%d0%b8%d0%ba&comment=%d0%ba%d1%83%d0%bf%d0%b8%d1%82%d0%b5+%d0%b1%d1%83%d0%b1%d0%bb%d0%b8%d0%ba%d0%b8!
```

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

### Authorization Request Parameters Example

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/request-access-token

A sample set of parameters formatted for the authorization request.

```text
client_id=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ01
response_type=code
redirect_uri=https://client.example.com/cb
scope=account-info operation-history
```

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

### Error response examples

Source: https://yoomoney.ru/docs/wallet/using-api/format/protocol-response

Examples of HTTP error responses for missing headers, expired tokens, and insufficient permissions.

```http
HTTP/1.1 400 Bad Request
WWW-Authenticate: Bearer error="invalid_request"
```

```http
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer error="invalid_token", error_description="The access token has expired"
```

```http
HTTP/1.1 403 Forbidden
WWW-Authenticate: Bearer error="insufficient_scope", error_description="Payment forbidden by application authorization parameters"
```

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

### Account information response

Source: https://yoomoney.ru/docs/wallet/user-account/account-info

Example JSON response containing account status, balance, and linked card information.

```JSON
{
  "account": "4100123456789",
  "balance": 1000.00,
  "currency": "643",
  "account_status": "anonymous",
  "account_type": "personal",
  "cards_linked": [
    {
      "pan_fragment": "510000******9999",
      "type": "MasterCard"
    }
  ]
}
```

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

### Search API response example

Source: https://yoomoney.ru/docs/wallet/showcase/search

A successful response containing a list of payment forms matching the search query.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 454

{
  "result":
  [
    {
      "id":5670,"title":"PetroElectric"
    },
    {
      "id":5551,
      "title":"PETROELECTRIC CJSC",
      "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params": {
        "supplierInn":""
      },
      "format":"json"
    },
    {
      "id":5551,
      "title":"PetroElectric CJSC",
      "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params":{
        "supplierInn":"7812013775"
      },
      "format":"json"
    }
  ],
  "nextPage":"false"
}
```

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

### Submit form data via POST

Source: https://yoomoney.ru/docs/wallet/showcase/submit

Example of a POST request to submit form data to a specific showcase step.

```http
POST /api/showcase/validate/5551/step_INN_3038 HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 115
Accept-Language: ru
Accept-Encoding: gzip

supplierInn=4704020508&ShopID=13423&ShopArticleID=35241&ShowCaseID=3005&ContractTemplateID=524867&budgetDocNumber=0
```

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

### HTTP 400 error response example

Source: https://yoomoney.ru/docs/wallet/showcase/submit

A concrete example of an HTTP 400 Bad Request response indicating validation errors for specific form fields.

```http
HTTP/1.1 400 Bad Request
Location: https://yoomoney.ru/api/showcase/validate/5506/
Content-Type: application/json
Content-Length: 733
Cache-Control: no-cache                                                           

{"title":"Skype","form":[{"type":"group","layout":"VBox","items":[{"type":"text","name":"FormComment","value":"Skype","label":"Name","required":false,"readonly":false},{"type":"text","name":"skypename","label":"Skype login","required":true,"readonly":false},{"type":"amount","name":"netSum","value":"2","label":"Amount","required":true,"readonly":false,"min":0.01,"max":375,"currency":"EUR"}]},{"type":"submit","label":"Pay"}],"money_source":["wallet","cards","payment-card","cash"],"hidden_fields":{"ContractTemplateID":"525923","sc_param_scid":"5506","netSum":"2","ShopArticleID":"71747","sc_param_step":"","ShopID":"14061","ShowCaseID":"6101"},"error":[{"name":"skypename","alert":"Please enter the Skype login name"}]}
```

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

### GET /api/showcase/<pattern_id>

Source: https://yoomoney.ru/docs/wallet/showcase/form-description-request?lang=ru

Запрос описания формы оплаты по идентификатору шаблона.

```APIDOC
## GET /api/showcase/<pattern_id>

### Description
Запрос описания формы оплаты. Эквивалентен загрузке документа с удаленного сервера.

### Method
GET

### Endpoint
https://yoomoney.ru/api/showcase/<pattern_id>

### Parameters
#### Path Parameters
- **pattern_id** (string) - Required - Идентификатор шаблона платежа.

#### Request Headers
- **Accept-Language** (string) - Optional - Код языка (ru, en). По умолчанию: ru.
- **Accept-Encoding** (string) - Optional - Поддержка сжатия (gzip).
- **If-Modified-Since** (string) - Optional - Дата последнего изменения для кэширования.

### Response
#### Success Response (300)
- **Location** (header) - Адрес для отправки формы.
- **Cache-Control** (header) - Режим кэширования (private/no-cache).
- **Last-Modified** (header) - Дата последнего изменения.

#### Response Example
HTTP/1.1 300 Multiple Choices
Location: https://yoomoney.ru/api/showcase/5551
Content-Type: application/json

{
  "money_source": ["wallet", "cards"],
  "title": "Квитанции",
  "form": [...] 
}
```

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

### Successful API response example

Source: https://yoomoney.ru/docs/wallet/using-api/format/protocol-response

A standard successful response containing JSON data and appropriate HTTP headers.

```http
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
Expires: Thu, 01 Dec 2019 16:00:00 GMT
Cache-Control: no-cache

{
    "param1":"value1",
    "param2":"value2"
}
```

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

### Define scope permission sets

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/protocol-rights

Examples of combined scope values for account information, history, and specific payment patterns.

```text
account-info operation-history operation-details
```

```text
account-info payment.to-pattern("123").limit(7,1000)
```

```text
payment.to-account("XXXX").limit(14,500)
```

```text
payment.to-account("ZZZ","phone").limit(,500)
```

```text
payment.to-pattern("123").limit(7,1000) money-source("wallet","card")
```

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

### GET /api/showcase-search

Source: https://yoomoney.ru/docs/wallet/showcase/search?lang=ru

Поиск реквизитов организаций по поисковому запросу.

```APIDOC
## GET /api/showcase-search

### Description
Метод предназначен для поиска форм оплаты в ЮMoney по реквизитам организации.

### Method
GET

### Endpoint
/api/showcase-search

### Parameters
#### Query Parameters
- **query** (string) - Required - Поисковый запрос, слово или фраза.
- **records** (int) - Optional - Максимальное количество записей в выдаче метода.

#### Headers
- **Accept-Language** (string) - Optional - Код языка (ru, en). По умолчанию: ru.

### Request Example
GET /api/showcase-search?query=Петроэлектросбыт&records=3 HTTP/1.1
Host: yoomoney.ru
Accept: */*

### Response
#### Success Response (200)
- **error** (string) - Код ошибки (при наличии).
- **result** (array) - Список результатов запроса.
- **nextPage** (boolean) - Предикат, определяющий существование записей свыше запрашиемого лимита.

#### Response Example
{
  "result": [
    {
      "id": 5670,
      "title": "Петроэлектросбыт"
    },
    {
      "id": 5551,
      "title": "ЗАО ПЕТРОЭЛЕКТРОСБЫТ",
      "url": "https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params": {
        "supplierInn": ""
      },
      "format": "json"
    }
  ],
  "nextPage": "false"
}
```

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

### GET /api/showcase-search

Source: https://yoomoney.ru/docs/wallet/showcase/search

Searches for payment forms based on a provided query string.

```APIDOC
## GET /api/showcase-search

### Description
This method is for searching for payment forms in YooMoney using details of the business or organization.

### Method
GET

### Endpoint
/api/showcase-search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query, word or phrase.
- **records** (int) - Optional - Maximum number of records in the method output.

### Request Example
GET /api/showcase-search?query=PetroElectric&records=3 HTTP/1.1
Host: yoomoney.ru
Accept: */*

### Response
#### Success Response (200)
- **error** (string) - Error code. Passed if an error occurred when executing the request.
- **result** (array) - List of results.
- **nextPage** (boolean) - A predicate that determines whether there are records over the requested limit.

#### Response Example
{
  "result":
  [
    {
      "id":5670,"title":"PetroElectric"
    },
    {
      "id":5551,
      "title":"PETROELECTRIC CJSC",
      "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params": {
        "supplierInn":""
      },
      "format":"json"
    }
  ],
  "nextPage":"false"
}
```

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

### Successful payment verification response

Source: https://yoomoney.ru/docs/wallet/showcase/submit

Example of a 200 OK response containing payment parameters after successful data verification.

```json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197
Cache-Control: no-cache

{"params":{"pattern_id":"5506","ContractTemplateID":"525923","sc_param_scid":"5506","netSum":"2","ShopArticleID":"71747","sc_param_step":"","ShopID":"14061","ShowCaseID":"6101","skypename":"test"}}
```

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

### Outgoing transfer response example

Source: https://yoomoney.ru/docs/wallet/user-account/operation-details

Represents a successful outgoing transfer to another user account.

```json
{
  "operation_id": "1234567",
  "status": "success",
  "pattern_id": "p2p",
  "direction": "out",
  "amount": 50.25,
  "datetime": "2011-07-11T20:43:00.000+04:00",
  "title": "Transfer to account 4100123456789",
  "recipient": "4100123456789",
  "recipient_type": "account",
  "message": "Buy bagels",
  "comment": "Transfer from YooMoney user",
  "codepro": false,
  "details": "Recipient account:\n4100123456789\nAmount: 50.00 RUB",
  "type": "payment-shop"
}
```

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

### Запрос последующих страниц истории

Source: https://yoomoney.ru/docs/wallet/user-account/operation-history?lang=ru

Пример HTTP-запроса для получения конкретной страницы истории операций с использованием параметра start_record.

```http
POST /api/operation-history HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer 410012345678901.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123
Content-Type: application/x-www-form-urlencoded
Content-Length: 40

type=payment&records=20&start_record=120
```

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

### POST /api/showcase/<pattern_id>

Source: https://yoomoney.ru/docs/wallet/showcase/submit-predefined?lang=ru

Запрашивает описание формы оплаты с предварительно заполненными значениями полей.

```APIDOC
## POST /api/showcase/<pattern_id>

### Description
Запрос предназначен для получения описания формы оплаты с предварительно заполненными значениями полей для повторения операций.

### Method
POST

### Endpoint
https://yoomoney.ru/api/showcase/<pattern_id>

### Parameters
#### Path Parameters
- **pattern_id** (string) - Required - Идентификатор шаблона формы.

#### Request Headers
- **Accept-Language** (string) - Optional - Код языка (ru, en). По умолчанию: ru.
- **Accept-Encoding** (string) - Optional - Поддержка сжатия (gzip).

### Request Example
POST /api/showcase/5506 HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 28
Accept-Language: ru
Accept-Encoding: gzip

skypename=username&netSum=10
```

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

### POST /api/showcase/validate/{form_id}/{step_id}

Source: https://yoomoney.ru/docs/wallet/showcase/submit?lang=ru

Отправляет данные формы или шага формы на сервер для проверки. Адрес для отправки должен быть получен из заголовка Location предыдущего ответа.

```APIDOC
## POST /api/showcase/validate/{form_id}/{step_id}

### Description
Отправляет данные формы или шага формы на сервер для проверки. Клиент должен использовать адрес, полученный из заголовка Location предыдущего ответа.

### Method
POST

### Endpoint
/api/showcase/validate/{form_id}/{step_id}

### Parameters
#### Request Body
- **form_fields** (application/x-www-form-urlencoded) - Required - Содержимое всех видимых UI-контролов формы и блока hidden_fields.

### Request Example
POST /api/showcase/validate/5551/step_INN_3038 HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded

supplierInn=4704020508&ShopID=13423&ShopArticleID=35241&ShowCaseID=3005&ContractTemplateID=524867&budgetDocNumber=0

### Response
#### Success Response (200)
- **params** (object) - Список параметров для проведения оплаты.

#### Response Example
HTTP/1.1 200 OK
Content-Type: application/json

{"params":{"pattern_id":"5506","ContractTemplateID":"525923","netSum":"2"}}
```

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

### Invalid parameter error response

Source: https://yoomoney.ru/docs/wallet/user-account/operation-history

Example JSON response returned when an invalid parameter is provided in the request.

```json
{
   "error": "illegal_param_type"
}
```

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

### Error response for token request

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/obtain-access-token

Example of a 400 Bad Request response returned when an invalid grant is provided.

```http
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 25
Cache-Control: no-store

{
  "error":"invalid_grant"
}
```

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

### POST /api/process-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/process-payment?lang=ru

Завершение платежной операции. Используется как для инициации платежа с карты, так и для подтверждения после прохождения 3-D Secure.

```APIDOC
## POST /api/process-payment

### Description
Метод для завершения платежа. При оплате картой с 3-D Secure вызывается дважды: первый раз с параметрами карты, второй раз после прохождения аутентификации только с request_id.

### Method
POST

### Endpoint
/api/process-payment

### Request Body
- **request_id** (string) - Required - Идентификатор платежа
- **money-source** (string) - Optional - Источник средств (например, "card")
- **csc** (string) - Optional - Код безопасности карты
- **ext_auth_success_uri** (string) - Optional - URL для перенаправления при успехе 3-D Secure
- **ext_auth_fail_uri** (string) - Optional - URL для перенаправления при ошибке 3-D Secure

### Response
#### Success Response (200)
- **status** (string) - Статус платежа (например, "success", "refused", "ext_auth_required")
- **acs_uri** (string) - URL для прохождения 3-D Secure (если требуется)
- **acs_params** (object) - Параметры для 3-D Secure (если требуется)
- **digital_goods** (object) - Данные о цифровых товарах (при успешном платеже)
```

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

### POST /api/showcase/validate/{id}/

Source: https://yoomoney.ru/docs/wallet/showcase/submit?lang=ru

Отправка данных формы на сервер для проверки. В случае обнаружения ошибок валидации, сервер возвращает список полей с описанием ошибок.

```APIDOC
## POST /api/showcase/validate/{id}/

### Description
Отправка данных формы на сервер для проверки. Если введенные данные содержат ошибки, возвращается JSON-объект с описанием полей и соответствующих сообщений об ошибках.

### Method
POST

### Endpoint
https://yoomoney.ru/api/showcase/validate/{id}/

### Response
#### Error Response (400)
- **error** (array) - Список объектов ошибок
  - **name** (string) - Наименование поля с ошибкой (опционально)
  - **alert** (string) - Текст сообщения об ошибке

#### Response Example
{
  "form": [...],
  "error": [
    {
      "name": "skypename",
      "alert": "Пожалуйста, укажите логин в Skype"
    }
  ]
}
```

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

### POST /oauth/authorize

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/request-access-token

Initiates the authorization process by sending a request to the YooMoney server to obtain an authorization code.

```APIDOC
## POST /oauth/authorize

### Description
The application uses the OS browser to send an Authorization Request to the YooMoney server to initiate the token request flow.

### Method
POST

### Endpoint
/oauth/authorize

### Parameters
#### Request Body
- **client_id** (string) - Required - The client_id that was assigned to the application during registration.
- **response_type** (string) - Required - Constant value: `code`.
- **redirect_uri** (string) - Required - URI that the OAuth server sends the authorization result to. Must match the value specified during application registration.
- **scope** (string) - Required - A list of requested permissions, separated by a space.
- **instance_name** (string) - Optional - Identifier of the authorization instance in the application.

### Request Example
POST /oauth/authorize HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 191

client_id=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ01&response_type=code&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb&scope=account%2Dinfo%20operation%2Dhistory
```

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

### Формат запроса поиска реквизитов

Source: https://yoomoney.ru/docs/wallet/showcase/search?lang=ru

Базовая структура HTTP GET запроса для поиска форм оплаты.

```http
GET /api/showcase-search?query=<запрос>&records=<количество> HTTP/1.1
Host: yoomoney.ru
Accept-Language: <lang>
```

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

### API Request Format

Source: https://yoomoney.ru/docs/wallet/using-api/format/protocol-request

General guidelines for constructing HTTP requests to the YooMoney API.

```APIDOC
## Request Format

### Description
All API requests must be sent via HTTPS using HTTP 1.1. Requests are authorized using the OAuth 2.0 Bearer Token scheme.

### Endpoint
https://yoomoney.ru/api/<method_name>

### Headers
- **Authorization**: Bearer <access_token>
- **Content-Type**: application/x-www-form-urlencoded

### Request Format
- **Method**: POST
- **Encoding**: UTF-8
- **Parameters**: Key/value pairs packed as POST request parameters

### Request Example
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <access_token>

param1=value1&param2=value2&param3=value3
```

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

### HTTP-уведомление о входящем переводе

Source: https://yoomoney.ru/docs/wallet/using-api/notification-p2p-incoming?lang=ru

Описание формата HTTP-запроса, который отправляется на сервер пользователя при поступлении входящего перевода.

```APIDOC
## POST [URL_уведомлений]

### Description
Уведомление отправляется при поступлении перевода от другого пользователя ЮMoney или при пополнении с банковской карты через виджет/кнопку.

### Method
POST

### Request Body
- **Параметры уведомления** (key/value) - Каждый параметр передается как пара ключ/значение в теле POST-запроса.

### Content-Type
application/x-www-form-urlencoded

### Encoding
UTF-8
```

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

### Search for organization details via API

Source: https://yoomoney.ru/docs/wallet/showcase/search

The base request format for querying the showcase-search endpoint.

```http
GET /api/showcase-search?query=<request>&records=<quantity> HTTP/1.1
Host: yoomoney.ru
Accept-Language: <lang>

```

```http
GET /api/showcase-search?query=PetroElectric&records=3 HTTP/1.1
Host: yoomoney.ru
Accept: */*

```

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

### process-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/process-payment?lang=ru

Метод для обработки и авторизации платежа. В случае длительной обработки возвращает статус in_progress, требующий повторного вызова.

```APIDOC
## process-payment

### Description
Метод выполняет авторизацию платежа. В зависимости от результата возвращает статус success, refused или in_progress.

### Response
#### Success Response (200)
- **status** (string) - Статус операции (success, refused, in_progress)
- **payment_id** (string) - Идентификатор платежа (при успехе)
- **balance** (float) - Баланс счета (при успехе)
- **invoice_id** (string) - Номер транзакции магазина
- **payer** (string) - Номер счета плательщика
- **payee** (string) - Номер счета получателя
- **credit_amount** (amount) - Сумма на счете получателя
- **account_unblock_uri** (string) - URL для разблокировки счета (при ошибке account_blocked)
- **acs_uri** (string) - URL для 3-D Secure аутентификации
- **acs_params** (object) - Параметры для 3-D Secure
- **next_retry** (long) - Рекомендуемое время повтора в мс (при in_progress)

### Response Example
{
  "status": "success",
  "payment_id": "2ABCDE123456789",
  "balance": 1000.00
}
```

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

### POST /api/operation-details

Source: https://yoomoney.ru/docs/wallet/user-account/operation-details?lang=ru

Получение детальной информации об операции из истории.

```APIDOC
## POST /api/operation-details

### Description
Позволяет получить детальную информацию об операции из истории.

### Method
POST

### Endpoint
/api/operation-details

### Parameters
#### Request Body
- **operation_id** (string) - Required - Идентификатор операции.

### Request Example
POST /api/operation-details HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer <token>
Content-Type: application/x-www-form-urlencoded

operation_id=1234567

### Response
#### Success Response (200)
- **operation_id** (string) - Идентификатор операции.
- **status** (string) - Статус платежа.
- **pattern_id** (string) - Идентификатор шаблона платежа.
- **direction** (string) - Направление движения средств (in/out).
- **amount** (amount) - Сумма операции.
- **amount_due** (amount) - Сумма к получению.
- **fee** (amount) - Сумма комиссии.
- **datetime** (datetime) - Дата и время совершения операции.
- **title** (string) - Краткое описание операции.
- **sender** (string) - Номер счета отправителя.
- **recipient** (string) - Идентификатор получателя.
- **recipient_type** (string) - Тип идентификатора получателя.
- **message** (string) - Сообщение получателю.
- **comment** (string) - Комментарий к переводу.
- **label** (string) - Метка платежа.
- **details** (string) - Детальное описание платежа.
- **type** (string) - Тип операции.
- **digital_goods** (object) - Данные о цифровом товаре.

#### Response Example
{
  "operation_id": "1234567",
  "status": "success",
  "pattern_id": "2904",
  "amount": 500.00,
  "direction": "out",
  "datetime": "2011-07-11T20:43:00.000+04:00",
  "title": "Оплата ADSL-доступа",
  "type": "payment-shop"
}
```

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

### POST /oauth/authorize

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/request-access-token?lang=ru

Отправка запроса на авторизацию приложения для получения временного кода.

```APIDOC
## POST /oauth/authorize

### Description
Отправляет запрос на сервер ЮMoney для начала процесса авторизации пользователя. Пользователь перенаправляется на страницы ЮMoney для ввода логина, пароля и подтверждения прав.

### Method
POST

### Endpoint
/oauth/authorize

### Parameters
#### Request Body
- **client_id** (string) - Required - Идентификатор приложения, полученный при регистрации.
- **response_type** (string) - Required - Фиксированное значение: `code`.
- **redirect_uri** (string) - Required - URI, на который сервер OAuth передает результат авторизации.
- **scope** (string) - Required - Список запрашиваемых прав, разделенных пробелом.
- **instance_name** (string) - Optional - Идентификатор экземпляра авторизации в приложении.

### Request Example
POST /oauth/authorize HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded

client_id=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ01&response_type=code&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb&scope=account%2Dinfo%20operation%2Dhistory

### Response
#### Success Response (302)
- **code** (string) - Временный токен (authorization code), возвращаемый в параметрах перенаправления.
- **error** (string) - Код ошибки, если авторизация не удалась.
- **error_description** (string) - Дополнительное текстовое пояснение ошибки.

#### Response Example
HTTP/1.1 302 Found
Location: https://client.example.com/cb?code=i1WsRn1uB1ehfbb37
```

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

### POST /api/showcase/<pattern_id>

Source: https://yoomoney.ru/docs/wallet/showcase/submit-predefined

Retrieves a payment form description with pre-filled field values based on the provided pattern ID and form data.

```APIDOC
## POST /api/showcase/<pattern_id>

### Description
Requests a payment form description with pre-filled field values to allow users to repeat previously completed operations easily.

### Method
POST

### Endpoint
https://yoomoney.ru/api/showcase/<pattern_id>

### Parameters
#### Path Parameters
- **pattern_id** (string) - Required - The unique identifier for the payment pattern.

#### Request Body
- **name-value pairs** (string) - Required - A list of form field values in name=value format.

### Request Example
POST /api/showcase/5506 HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 28
Accept-Language: ru
Accept-Encoding: gzip

skypename=username&netSum=10
```

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

### POST /api/process-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/process-payment?lang=ru

Подтверждение платежа, ранее созданного методом request-payment. Указание метода проведения платежа.

```APIDOC
## POST /api/process-payment

### Description
Подтверждение платежа, ранее созданного методом request-payment. Указание метода проведения платежа.

### Method
POST

### Endpoint
/api/process-payment

### Parameters
#### Request Body
- **request_id** (string) - Required - Идентификатор запроса, полученный из ответа метода request-payment.
- **money_source** (string) - Optional - Запрашиваемый метод проведения платежа: wallet (по умолчанию) или идентификатор привязанной карты.
- **csc** (string) - Optional - Card Security Code, CVV2/CVC2-код привязанной банковской карты.
- **ext_auth_success_uri** (string) - Optional - Адрес страницы возврата при успехе аутентификации 3-D Secure.
- **ext_auth_fail_uri** (string) - Optional - Адрес страницы возврата при отказе в аутентификации 3-D Secure.

### Request Example
POST /api/process-payment HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer <token>
Content-Type: application/x-www-form-urlencoded

request_id=1234567&money_source=card&csc=123

### Response
#### Success Response (200)
- **status** (string) - Код результата выполнения операции (success, refused, in_progress, ext_auth_required).
- **error** (string) - Код ошибки при проведении платежа (присутствует при ошибках).
- **payment_id** (string) - Идентификатор проведенного платежа (присутствует при успехе).
- **balance** (amount) - Баланс счета пользователя после проведения платежа (присутствует при успехе и наличии права account-info).
```

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

### request-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/request-payment?lang=ru

Метод для инициации запроса на проведение платежа. Возвращает доступные источники средств и идентификатор запроса.

```APIDOC
## request-payment

### Description
Инициализирует процесс платежа, проверяет доступные методы оплаты и возвращает информацию о счете пользователя.

### Response
- **status** (string) - Код результата: success или refused.
- **error** (string) - Код ошибки (присутствует при ошибках).
- **money_source** (object) - Доступные методы оплаты (wallet, cards).
- **request_id** (string) - Идентификатор запроса платежа.
- **contract_amount** (amount) - Сумма к списанию с учетом комиссии.
- **balance** (amount) - Текущий баланс счета.
- **recipient_account_status** (string) - Статус счета пользователя.
- **recipient_account_type** (string) - Тип счета получателя.
- **account_unblock_uri** (string) - URL для разблокировки счета (при ошибке account_blocked).
- **ext_action_uri** (string) - URL для совершения действий (при ошибке ext_action_required).
```

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

### POST /api/request-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/request-payment?lang=ru

Создание платежа, проверка параметров и возможности приема платежа магазином или перевода средств на счет пользователя ЮMoney.

```APIDOC
## POST /api/request-payment

### Description
Создание платежа, проверка параметров и возможности приема платежа магазином или перевода средств на счет пользователя ЮMoney.

### Method
POST

### Endpoint
/api/request-payment

### Parameters
#### Request Body (Перевод средств на счета других пользователей)
- **pattern_id** (string) - Required - Фиксированное значение: p2p.
- **to** (string) - Required - Идентификатор получателя перевода (номер счета, номер телефона или email).
- **amount** (amount) - Optional - Сумма к оплате (столько заплатит отправитель).
- **amount_due** (amount) - Optional - Сумма к получению (придет на счет получателя после оплаты).
- **comment** (string) - Optional - Комментарий к переводу, отображается в истории отправителя.
- **message** (string) - Optional - Комментарий к переводу, отображается получателю.
- **label** (string) - Optional - Метка платежа.

### Request Example
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer <token>
Content-Type: application/x-www-form-urlencoded

pattern_id=p2p&to=41001101140&amount=1000.00&message=Название платежа&comment=Сообщение получателю
```

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

### POST /api/request-payment

Source: https://yoomoney.ru/docs/wallet/process-payments/request-payment

Initiates a payment request. This method is used to prepare a payment to a merchant or a transfer to another user account.

```APIDOC
## POST /api/request-payment

### Description
Creates a payment, checks parameters and verifies that the merchant can accept the payment, or that funds can be transferred to a YooMoney user account.

### Method
POST

### Endpoint
/api/request-payment

### Parameters
#### Request Body
- **pattern_id** (string) - Required - Payment Pattern ID. Use 'p2p' for user-to-user transfers or the merchant's scid for merchant payments.
- **to** (string) - Optional - ID of the transfer recipient (account number, phone number, or email).
- **amount** (amount) - Optional - Amount to pay (sender's cost).
- **amount_due** (amount) - Optional - Amount to be received by the recipient.
- **comment** (string) - Optional - Payment comment, displayed in the sender’s history.
- **message** (string) - Optional - Comments on the transfer (displayed to the recipient).
- **label** (string) - Optional - The payment label.
- **identifier_type** (string) - Optional - Type of identifier (e.g., 'phone').

### Request Example
POST /api/request-payment HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer <token>
Content-Type: application/x-www-form-urlencoded

pattern_id=p2p&to=41001101140&amount=1000.00&message=Message&comment=Comment
```

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

### Define payment limits

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/protocol-rights

Configure payment restrictions using the limit parameter, specifying duration in days and the maximum sum.

```text
.limit(1,100.50)
```

```text
.limit(,1000)
```

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

### Authorization Request Format

Source: https://yoomoney.ru/docs/wallet/using-api/authorization/request-access-token

The standard HTTP POST request structure for initiating the authorization flow.

```http
POST /oauth/authorize HTTP/1.1
Host: yoomoney.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: <content-length>

client_id=<client_id>&response_type=code
&redirect_uri=<redirect_uri>&scope=<scope>&instance_name=<instance_name>
```

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

### POST /api/showcase/validate/{id}/

Source: https://yoomoney.ru/docs/wallet/showcase/submit

Validates the data entered by the buyer in a form step. If errors are found, the server returns a 400 Bad Request status with a list of field-specific or general errors.

```APIDOC
## POST /api/showcase/validate/{id}/

### Description
Validates the form data submitted by the buyer. The server checks field values and logical combinations, returning the current form state and any validation errors.

### Method
POST

### Endpoint
https://yoomoney.ru/api/showcase/validate/{id}/

### Response
#### Error Response (400)
- **form** (array) - The current step of the form with pre-filled values.
- **error** (array) - A list of errors found during validation.
  - **name** (string) - The name of the field containing an invalid value (omitted if not field-specific).
  - **alert** (string) - The error message text.

#### Response Example
HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "title": "Skype",
  "form": [...],
  "error": [
    {
      "name": "skypename",
      "alert": "Please enter the Skype login name"
    }
  ]
}
```

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

### POST /api/account-info

Source: https://yoomoney.ru/docs/wallet/user-account/account-info?lang=ru

Получение информации о состоянии счета пользователя. Требует авторизации с правами account-info.

```APIDOC
## POST /api/account-info

### Description
Получение информации о состоянии счета пользователя.

### Method
POST

### Endpoint
/api/account-info

### Parameters
Входные параметры отсутствуют.

### Request Example
POST /api/account-info HTTP/1.1
Host: yoomoney.ru
Authorization: Bearer <token>
Content-Type: application/x-www-form-urlencoded
Content-Length: 0

### Response
#### Success Response (200)
- **account** (string) - Номер счета пользователя.
- **balance** (amount) - Баланс счета пользователя.
- **currency** (string) - Код валюты счета пользователя (всегда 643).
- **account_status** (string) - Статус пользователя (anonymous, named, identified).
- **account_type** (string) - Тип счета пользователя (personal, professional).
- **balance_details** (object) - Расширенная информация о балансе (total, available, deposition_pending, blocked, debt, hold).
- **cards_linked** (array) - Информация о привязанных банковских картах (pan_fragment, type).

#### Response Example
{
  "account": "4100123456789",
  "balance": 1000.00,
  "currency": "643",
  "account_status": "anonymous",
  "account_type": "personal",
  "cards_linked": [
    {
      "pan_fragment": "510000******9999",
      "type": "MasterCard"
    }
  ]
}
```
Tokens:
Raw