- Created by IntellectMoney, last modified on Jun 22, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Общая информация
Payout API позволяет проводить операции массовых выплат в сторону любых получателей.
Все запросы PayoutAPI используют ключ доступа клиента для идентификации пользователя. Чтобы получить такой ключ необходимо воспользоваться методом getUserToken
из PersonalAPI.
Любой запрос к API возвращается в виде результирующей структуры Response
.
Схема использования методов
- Запрос ключа доступа клиента через PersonalAPI.
- Вызов метода создания операции выплаты (напр.
CreateBankCardRussiaOperation
илиCreateQiwiWalletOperation
). - Получить успешный ответ и достать из
PayoutOperationData
идентификатор созданной операции. - Вызвать метод
ExecuteOperation
и передать ему ранее полученный идентификатор чтобы отправить ранее созданную операцию на обработку. - Проверять статус операции посредством вызова
GetOperationState
.
Метод CreateBankCardRussiaOperation
Позволяет создать операцию выплаты на карту.
Доступ к методу
URL: https://api.intellectmoney.ru/personal/payout/CreateBankCardRussiaOperation
Доступные HTTP-методы: POST
Требуемый уровень доступа: PCI DSS
Передаваемые параметры
Название | Имя параметра | Обязательный | Тип | Описание |
---|---|---|---|---|
Ключ доступа клиента | UserToken | Да | string | Токен пользователя, по которому проводится его идентификация в системе IntellectMoney. |
Номер карты | Pan | Да | string(12,20) | Номер банковской карты, на которую производится зачисление средств. |
Сумма операции | Amount | Да | decimal | Сумма, которая будет зачислена получателю. |
Валюта операции | Currency | Да | string(3) | Строковый ISO-код валюты. |
ФИО получателя | RecipientName | Нет | string(2,50) | ФИО получателя операции. |
Возвращаемый ответ
В ответ возвращается структура Response
.
Код операции 0 - в поле Result структуры будет находится информация о созданной операции в виде PayoutOperationData
.
Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.
Пример
POST /personal/payout/CreateQiwiWalletOperation HTTP/1.1 Host: api.intellectmoney.ru Accept: application/json Content-Type: application/x-www-form-urlencoded UserToken=4t%2B5WKHtcey4Ch7P2jodi%2F3RyaG74giGEooE5HXngVt%2F32VV8amsmdClb8fx6hj%2B&Pan=4111111111111111&Amount=50&Currency=RUB
{ "OperationState": { "Code": 0, "Desc": "Успешно обработана" }, "OperationId": "4d7f6669-fc7a-48fa-b761-1500e1930441", "Result": { "State": { "Code": 0, "Desc": "Успешно обработан." }, "PayoutOperationId": "81fa5265-de0b-498d-be37-5d48f4aa3ba1", "PayoutOperationState": "Created" } }
Метод CreateQiwiWalletOperation
Позволяет создать операцию выплаты на Qiwi кошелек.
Доступ к методу
URL: https://api.intellectmoney.ru/personal/payout/CreateQiwiWalletOperation
Доступные HTTP-методы: POST
Требуемый уровень доступа: Базовый
Передаваемые параметры
Название | Имя параметра | Обязательный | Тип | Описание |
---|---|---|---|---|
Ключ доступа клиента | UserToken | Да | string | Токен пользователя, по которому проводится его идентификация в системе IntellectMoney. |
Номер Qiwi кошелька | Account | Да | string | Номер Qiwi кошелька, на который производится зачисление средств. |
Сумма операции | Amount | Да | decimal | Сумма, которая будет зачислена получателю. |
Валюта операции | Currency | Да | string(3) | Строковый ISO-код валюты. |
ФИО получателя | RecipientName | Нет | string(2,50) | ФИО получателя операции. |
Возвращаемый ответ
В ответ возвращается структура Response
.
Код операции 0 - в поле Result структуры будет находится информация о созданной операции в виде PayoutOperationData
.
Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.
Пример
POST /personal/payout/CreateQiwiWalletOperation HTTP/1.1 Host: api.intellectmoney.ru Accept: application/json Content-Type: application/x-www-form-urlencoded UserToken=4t%2B5WKHtcey4Ch7P2jodizfGVmkSBn3Xf6QScTqHx6ATMwsqVEaCF%2B8zU2M8w7LW&Account=70000000000&Amount=50&Currency=RUB
{ "OperationState": { "Code": 0, "Desc": "Успешно обработана" }, "OperationId": "4d7f6669-fc7a-48fa-b761-1500e1930441", "Result": { "State": { "Code": 0, "Desc": "Успешно обработан." }, "PayoutOperationId": "81fa5265-de0b-498d-be37-5d48f4aa3ba1", "PayoutOperationState": "Created" } }
Метод ExecuteOperation
Отправить операцию выплаты на обработку.
Доступ к методу
URL: https://api.intellectmoney.ru/personal/payout/ExecuteOperation
Доступные HTTP-методы: POST
Требуемый уровень доступа: Базовый
Передаваемые параметры
Название | Имя параметра | Обязательный | Тип | Описание |
---|---|---|---|---|
Ключ доступа клиента | UserToken | Да | string | Токен пользователя, по которому проводится его идентификация в системе IntellectMoney. |
Идентификатор операции выплат | PayoutOperationId | Да | Guid | Идентификатор ранее созданной операции выплат. |
Возвращаемый ответ
В ответ возвращается структура Response
.
Код операции 0 - в поле Result структуры будет находится информация об операции в виде PayoutOperationData
.
Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.
Пример
POST /personal/payout/ExecuteOperation HTTP/1.1 Host: api.intellectmoney.ru Accept: application/json Content-Type: application/x-www-form-urlencoded UserToken=4t%2B5WKHtcey4Ch7P2jodi3s2B4a36wnEX4pi%2BxCbimJlYgRpQa4QXJ202MiT4LxG&PayoutOperationId=81FA5265-DE0B-498D-BE37-5D48F4AA3BA1
{ "OperationState": { "Code": 0, "Desc": "Успешно обработана" }, "OperationId": "a654fe39-42eb-4ac3-a3ec-76d148b2ba3a", "Result": { "State": { "Code": 0, "Desc": "Успешно обработан." }, "PayoutOperationId": "81fa5265-de0b-498d-be37-5d48f4aa3ba1", "PayoutOperationState": "InProcess" } }
Метод GetOperationState
Получить статус операции выплаты.
Доступ к методу
URL: https://api.intellectmoney.ru/personal/payout/GetOperationState
Доступные HTTP-методы: POST
Требуемый уровень доступа: Базовый
Передаваемые параметры
Название | Имя параметра | Обязательный | Тип | Описание |
---|---|---|---|---|
Ключ доступа клиента | UserToken | Да | string | Токен пользователя, по которому проводится его идентификация в системе IntellectMoney. |
Идентификатор операции выплат | PayoutOperationId | Да | Guid | Идентификатор ранее созданной операции выплат. |
Возвращаемый ответ
В ответ возвращается структура Response
.
Код операции 0 - в поле Result структуры будет находится информация об операции в виде PayoutOperationData
.
Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.
Пример
POST /personal/payout/GetOperationState HTTP/1.1 Host: api.intellectmoney.ru Accept: application/json Content-Type: application/x-www-form-urlencoded UserToken=4t%2B5WKHtcey4Ch7P2jodi3s2B4a36wnEX4pi%2BxCbimJlYgRpQa4QXJ202MiT4LxG&PayoutOperationId=81FA5265-DE0B-498D-BE37-5D48F4AA3BA1
{ "OperationState": { "Code": 0, "Desc": "Успешно обработана" }, "OperationId": "a654fe39-42eb-4ac3-a3ec-76d148b2ba3a", "Result": { "State": { "Code": 0, "Desc": "Успешно обработан." }, "PayoutOperationId": "81fa5265-de0b-498d-be37-5d48f4aa3ba1", "PayoutOperationState": "Completed" } }
Структуры PayoutAPI
PayoutOperationData
Структура с данными операции выплат.
Название | Тип | Описание |
---|---|---|
PayoutOperationId | Guid | Идентификатор операции выплаты в системе IntellectMoney. |
PayoutOperationState | MassPaymentOperationState | Текущий статус операции. |
MassPaymentOperationState
Перечисление возможных статусов операции выплат.
Значение | Описание |
---|---|
Created | Операция создана. |
SentToBank | Запрос на проведение операции отправлен в банк. |
InProcess | Заявка принята банком и исполняется. |
Completed | Операция завершена. |
Failed | Операция завершилась с ошибкой. |
NotEnoughMoney | У пользователя недостаточно средств, для совершения операции. |
Canceled | Операция отменена. |
Error | Ошибка обработки. |
Deleted | Операция удалена. |
- No labels