Получение информации о выводе

Запрос

URL

https://api.mivion.com/payoff/info

Метод отправки

GET

Параметры запроса:

nametypedescription
user_id*uuidИдентификатор пользователя (используется для авторизации)
id **uuidID вывода
order_id **string|max:255Уникальный идентификатор платежа в системе мерча
type
uuid
description
Идентификатор пользователя (используется для авторизации)
type
uuid
description
ID вывода
type
string|max:255
description
Уникальный идентификатор платежа в системе мерча

* Поля обязательные для заполнения

** Поля обязательные в случае отсутствия другого такого же поля

Ответ после запроса:

Формат ответа

JSON

nametypedescription
payoff_iduuidID вывода
statusstringСтатус вывода.
Варианты:
 wait - в процессе
 fail - вывод отклонен
 success - успешно
order_id *stringУникальный идентификатор платежа в системе мерча
servicestringСервис вывода (полный код) ****
walletstring|nullНомер карты/телефона/кошелька для вывода
typestringТип вывода
Варианты:
 api - вывод созданный через api;
 payoff - вывод созданный через личный кабинет
subtractstringС кого списывать комиссию, с баланса или с суммы.
Варианты:
 balance - с баланса;
 amount - с суммы
amountnumberСумма вывода (в рублях)
amount_withdraw_rubnumberСумма списания с баланса (в рублях)
commission_rubnumberКомиссия (в рублях)
receive_currencystringВалюта вывода
amount_receivestringСумма вывода в валюте
commentstring|nullКомментарий указанный при создании выплаты
created_atdatetime 2023-03-21 14:00Время создания вывода
paid_at **datetime 2023-03-21 14:00Время вывода
error_message **stringПричина отклонения
type
uuid
description
ID вывода
type
string
description
Статус вывода.
Варианты:
 wait - в процессе
 fail - вывод отклонен
 success - успешно
type
string
description
Уникальный идентификатор платежа в системе мерча
type
string
description
Сервис вывода (полный код) ****
type
string|null
description
Номер карты/телефона/кошелька для вывода
type
string
description
Тип вывода
Варианты:
 api - вывод созданный через api;
 payoff - вывод созданный через личный кабинет
type
string
description
С кого списывать комиссию, с баланса или с суммы.
Варианты:
 balance - с баланса;
 amount - с суммы
type
number
description
Сумма вывода (в рублях)
type
number
description
Сумма списания с баланса (в рублях)
type
number
description
Комиссия (в рублях)
type
string
description
Валюта вывода
type
string
description
Сумма вывода в валюте
type
string|null
description
Комментарий указанный при создании выплаты
type
datetime 2023-03-21 14:00
description
Время создания вывода
type
datetime 2023-03-21 14:00
description
Время вывода
type
string
description
Причина отклонения

* Order_id отсутствует в выводах через Личный кабинет

** Поле только при успешном выводе

*** Поле только при отключенном выводе

**** Системы вывода указаны ниже

Возможные статусы ответа:

  • 200 : Успех
  • 401 : Ошибка авторизации (неверный user_id или секретный ключ)
  • 404 : Вывод не найден
  • 422 : Ошибка валидации
  • 500 : Внутренняя ошибка системы

Пример запроса:

URL

https://api.mivion.com/payoff/info?user_id=a6f112da-7c3f-4323-ad99-ec3630e7c8ff&order_id=1

Метод отправки

GET

Curl

  1. 1.curl -X 'GET' \
  2. 2.'https://api.mivion.com/payoff/info?user_id=a6f112da-7c3f-4323-ad99-ec3630e7c8ff&order_id=1' \
  3. 3.-H 'accept: application/json' \
  4. 4.-H 'x-api-signature-sha256: d6be996241deef230e9a0ca9dc60679da8720d14'

Responses

При успешном запросе: код ответа - 200.

  1. 1.{
  2. 2. "data": {
  3. 3. "payoff_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  4. 4. "status": "success",
  5. 5. "service": "card",
  6. 6. "wallet": "4000000000000000",
  7. 7. "type": "payoff",
  8. 8. "subtract": "balance",
  9. 9. "amount": 10,
  10. 10. "amount_withdraw_rub": 11,
  11. 11. "commission_rub": 1,
  12. 12. "receive_currency": "RUB",
  13. 13. "amount_receive": 10,
  14. 14. "comment": "Test payoff",
  15. 15. "created_at": "2023-03-21 12:00",
  16. 16. "order_id": "1",
  17. 17. "paid_at": "2023-03-21 14:00"
  18. 18. },
  19. 19. "status": 200,
  20. 20. "status_check": true
  21. 21.}

При ошибке: код ответа - 401, 404, 422, 500.

  1. 1.{
  2. 2. "data": null,
  3. 3. "error": "Вывод не найден.",
  4. 4. "status": 404,
  5. 5. "status_check": false
  6. 6.}

Примеры кода:

  1. 1.import requests
  2. 2.
  3. 3.
  4. 4.# Payoff info
  5. 5.def get_payoff_info(api_key, user_id, order_id):
  6. 6. session = requests.Session()
  7. 7. session.headers['Accept'] = 'application/json'
  8. 8. session.headers['x-api-signature-sha256'] = api_key
  9. 9. params = {
  10. 10. 'user_id': user_id,
  11. 11. 'order_id': order_id
  12. 12. }
  13. 13. response = session.get('https://api.mivion.com/payoff/info', params=params)
  14. 14. return response.json()
  15. 15.
  16. 16.
  17. 17.api_key = 'd6be996241deef230e9a0ca9dc60679da8720d14'
  18. 18.user_id = 'a6f112da-7c3f-4323-ad99-ec3630e7c8ff'
  19. 19.order_id = 1
  20. 20.
  21. 21.# Response full info
  22. 22.payoff = get_payoff_info(api_key, user_id, order_id)
  23. 23.
  24. 24.# Response status
  25. 25.payoff['status']
  26. 26.
  27. 27.# Payoff data
  28. 28.payoff['data']
  29. 29.
  30. 30.# Payoff info
  31. 31.payoff['data']['payoff_id']
  32. 32.payoff['data']['status']
  33. 33.payoff['data']['wallet']
  34. 34.payoff['data']['amount']
  35. 35.payoff['data']['amount_withdraw']
  36. 36.payoff['data']['created_at']
  1. 1.function getPayoffInfo(string $apiKey, string $userId, string $orderId): array
  2. 2.{
  3. 3. $url = "https://api.mivion.com/invoice/info";
  4. 4. $headers = [
  5. 5. "accept: application/json",
  6. 6. "x-api-signature-sha256: {$apiKey}"
  7. 7. ]
  8. 8.
  9. 9. $ch = curl_init();
  10. 10. curl_setopt($ch, CURLOPT_URL, "$url?user_id={$userId}&order_id={$orderId}");
  11. 11. curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  12. 12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  13. 13. $response = curl_exec($ch);
  14. 14. curl_close($ch);
  15. 15. return json_decode($response, true);
  16. 16.}
  17. 17.
  18. 18.$apiKey = "d6be996241deef230e9a0ca9dc60679da8720d14";
  19. 19.$userId = "a6f112da-7c3f-4323-ad99-ec3630e7c8ff";
  20. 20.$orderId = 1;
  21. 21.
  22. 22.# Response full info
  23. 23.$payoff = getPayoffInfo($apiKey, $userId, $orderId);
  24. 24.
  25. 25.# Response status
  26. 26.$payoff['status'];
  27. 27.
  28. 28.# Payoff data
  29. 29.$payoff['data'];
  30. 30.
  31. 31.# Payoff info
  32. 32.$payoff['data']['payoff_id'];
  33. 33.$payoff['data']['status'];
  34. 34.$payoff['data']['wallet'];
  35. 35.$payoff['data']['amount'];
  36. 36.$payoff['data']['amount_withdraw'];
  37. 37.$payoff['data']['created_at'];