Общая информация

Payout API позволяет проводить операции массовых выплат в сторону любых получателей.

Любой запрос к API возвращается :

1. Возвращается в виде результирующей структуры Response.
2. Поддерживает два варианта Content-Type: application/json и application/x-www-form-urlencoded.

Схема использования методов

Image RemovedImage Added

1. Запрос ключа доступа клиента через PersonalAPI.
2. Вызов метода создания операции выплаты (напр. CreateBankCardRussiaOperation или CreateQiwiWalletOperation CreateOperation).
3. Получить успешный ответ и достать из PayoutOperationData идентификатор созданной операции.
4. Вызвать метод ExecuteOperation и передать ему ранее полученный идентификатор чтобы отправить ранее созданную операцию на обработку.
5. Проверять статус операции посредством вызова GetOperationState.

Метод CreateOperation

Позволяет создать операцию выплаты на карту.

Доступ к методу

URL: https://api.intellectmoney.ru/personal/payout/CreateBankCardRussiaOperationCreateOperation

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый, PCI DSS

Правило формирования заголовка Sign: UserToken::Pan::Account::Amount::Currency::RecipientName::signSecretKey

Передаваемые параметры

Возвращаемый ответ

В ответ возвращается структура Response.

Код операции 0 - в поле Result структуры будет находится информация о созданной операции в виде PayoutOperationData.

Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.

Пример

POST /personal/payout/CreateQiwiWalletOperationCreateOperation 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=RUBjson

{
    "UserToken": "Obhv/VwGegZjbLobTJAYrAKqyAGN8U7HuLrplb+gjftR9wU3zWdomj6HN/aGKRj2", 
    "Pan": "4111111111111111", 
    "Amount": "50.00", 
    "Currency": "RUB", 
    "RecipientName": "Иванов Иван Иванович", 
    "ProviderType": 0  
}

{
    "OperationState": {
        "Code": 0,
        "Desc": "Успешно обработана"
    },
  "OperationId": "4d7f6669-fc7a-48fa-b761-1500e1930441",
  "Result": {
        "State": {
            "Code": 0,
            "Desc": "Успешно обработан."
        },
        "PayoutOperationId": "81fa52652cf4b4bc-de0b56cf-498d4ab6-be37bf4f-5d48f4aa3ba11b2aa9743154",
        "PayoutOperationState": "Created"
    }
}

Метод ExecuteOperation

Отправить

Метод CreateQiwiWalletOperation

Позволяет создать операцию выплаты на Qiwi кошелекобработку.

Доступ к методу

URL: https://api.intellectmoney.ru/personal/payout/CreateQiwiWalletOperationExecuteOperation

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: UserToken::PayoutOperationId::::::::::::signSecretKey

Передаваемые параметры

Возвращаемый ответ

В ответ возвращается структура Response.

Код операции 0 - в поле Result структуры будет находится информация о созданной об операции в виде PayoutOperationData.

Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.

Пример

POST /personal/payout/CreateQiwiWalletOperationExecuteOperation 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=RUBjson

{
    "UserToken": "4t+5WKHtcey4Ch7P2jodi3s2B4a36wnEX4pi+xCbimJlYgRpQa4QXJ202MiT4LxG",
    "PayoutOperationId" : "81fa5265-de0b-498d-be37-5d48f4aa3ba1"
}

{
  "OperationState": {
    "Code": 0,
    "Desc": "Успешно обработана"
  },
  "OperationId": "4d7f6669a654fe39-fc7a42eb-48fa4ac3-b761a3ec-1500e193044176d148b2ba3a",
  "Result": {
    "State": {
      "Code": 0,
      "Desc": "Успешно обработан."
    },
    "PayoutOperationId": "81fa5265-de0b-498d-be37-5d48f4aa3ba1",
    "PayoutOperationState": "CreatedInProcess"
  }
}

Метод GetOperationState

Получить статус операции выплаты

Метод ExecuteOperation

Отправить операцию выплаты на обработку.

Доступ к методу

URL: https://api.intellectmoney.ru/personal/payout/ExecuteOperationGetOperationState

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: UserToken::PayoutOperationId::::::::::::signSecretKey

Передаваемые параметры

Возвращаемый ответ

В ответ возвращается структура Response.

Код операции 0 - в поле Result структуры будет находится информация об операции в виде PayoutOperationData.

Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.

Пример

POST /personal/payout/ExecuteOperationGetOperationState 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-5D48F4AA3BA1json

{
    "UserToken": "Obhv/VwGegZjbLobTJAYrOzJxmECG2ixyR9AoS5SK6JpPK36hnFW4JxGZpAg/45y", 
    "PayoutOperationId": "ad22e55f-7e54-4e3a-b04b-0142a0314376"
}

{
    "OperationState": {
        "Code": 0,
        "Desc": "Успешно обработана"
    },
  "OperationId": "a654fe39-42eb-4ac3-a3ec-76d148b2ba3a",
  "Result": {
        "State": {
            "Code": 0,
            "Desc": "Успешно обработан."
        },
        "PayoutOperationId": "81fa5265ad22e55f-de0b7e54-498d4e3a-be37b04b-5d48f4aa3ba10142a0314376",
        "PayoutOperationState": "InProcess"
    }
}

Метод DeleteOperation

Удалить операцию массовых выплат (Разрешено удалять только операции в статусе MassPaymentOperationState.Created)

Метод GetOperationState

Получить статус операции выплаты.

Доступ к методу

URL: https://api.intellectmoney.ru/personal/payout/GetOperationStateDeleteOperation

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: UserToken::PayoutOperationId::::::::::::signSecretKey

Передаваемые параметры

Возвращаемый ответ

В ответ возвращается структура Response.

Код операции 0 - в поле Result структуры будет находится информация об результат выполнения операции в виде PayoutOperationData Boolean.

Код операции 2 - ошибка, причина ошибки будет содержаться в параметре Desc.

Пример

POST /personal/payout/GetOperationStateDeleteOperation 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": json

{
    "CodeUserToken": 0,
    "Desc": "Успешно обработана"Obhv/VwGegZjbLobTJAYrOzJxmECG2ixyR9AoS5SK6JpPK36hnFW4JxGZpAg/45y", 
  },
  "OperationIdPayoutOperationId": "a654fe3981fa5265-42ebde0b-4ac3498d-a3ecbe37-76d148b2ba3a5d48f4aa3ba1"
}

,
  "Result": {
    "StateOperationState": {
        "Code": 0,
        "Desc": "Успешно обработан.обработана"
    },
    "PayoutOperationIdResult": "81fa5265-de0b-498d-be37-5d48f4aa3ba1",
    "PayoutOperationState": "Completed"
  }
true
}

Структуры PayoutAPI

Anchor
PayoutOperationData PayoutOperationData

PayoutOperationData

Структура с данными операции выплат.

Anchor
MassPaymentOperationState MassPaymentOperationState

MassPaymentOperationState

Перечисление возможных статусов операции выплат.

Anchor
ProviderType ProviderType

ProviderType