Информация о заявке на вывод средств

API для бизнеса

Запрос

GET / POST https://aaio.so/api/info-payoff

Заголовки

Accept: application/json * Content-Type: application/x-www-form-urlencoded * X-Api-Key: {api_key} *

Определения

{api_key} - Ключ API из раздела https://aaio.so/business/api/keys с разрешениями: Информация про вывод средств * - обязательные заголовки. Без них Вы не сможете получить корректный ответ.

Параметры (url-encoded)

name	type	description
my_id *	string	Идентификатор вывода в Вашей системе
id *	uuid	Идентификатор вывода в нашей системе
		Поиск можно выполнить с одним из выше перечисленных параметров. id в приоритете если указаны оба значения.

Обратите внимание! Параметры передаются в формате application/x-www-form-urlencoded

Примеры ответа

Формат ответа application/json

Успех - 200

{
	"type": "success",
	"id": "52a16aea-d308-11ed-afa1-0242ac120002", // ID Вывода средств в нашей системе
	"my_id": "my_id_123", // ID Вывода средств в Вашей системе
	"method": "tether_trc20", // Кодовое название платежной системы
	"bank": "", // Название банка СБП (передается только при методе sbp)
	"phone_operator": "", // Кодовое название оператора (передается только при методе mobile_ru)
	"wallet": "*********", // Номер счета/кошелька
	"amount": 485.00, // Придёт на счет (в RUB)
	"amount_down": 500.00, // Списано с баланса (в RUB)
	"commission": 15.00, // Сумма комиссии (в RUB)
	"commission_type": 0, // Тип комиссии
	"status": "success", // Статус (in_process - в процессе, cancel - отменено, success - выполнено)
	"cancel_message": "", // Причина отмены (отображается только при статусе cancel)
	"date": "2023-03-10 17:08:42", // Дата создания
	"complete_date": "2023-03-10 17:09:21" // Дата отмены либо выполнения (отображается только при статусе cancel и success)
}

Ошибка: 400, 401, 429, 500, 503

Пользовательские коды ошибок - 400, 401, 429 Серверные коды ошибок - 500, 503

{
  "type": "fail",
  "code": "400",
  "message": "message"
}

Другой код ответа

Если код ответа другой, то возможна проблема на стороне сервера API. Рекомендуем учитывать такие ситуации в коде.

Готовые примеры запроса

cURL

curl -X 'POST' \
'https://aaio.so/api/info-payoff' \
-H 'accept: application/json' \
-H 'x-api-key: API_KEY' \
-d 'my_id=my_id_123'

PHP

<?php
$api_key = ''; // Ключ API из раздела https://aaio.so/cabinet/api
$my_id = 'my_id_123'; // ID вывода средств в Вашей системе 

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://aaio.so/api/info-payoff');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    	'Accept: application/json',
	'X-Api-Key: ' . $api_key
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
	'my_id' => $my_id
]));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 15); // Таймаут подключения к нашему серверу
curl_setopt($ch, CURLOPT_TIMEOUT, 60); // Таймаут обработки запроса

$result = curl_exec($ch); // Ответ
$http_code = curl_getinfo($ch, CURLINFO_RESPONSE_CODE); // Код ответа

if (curl_errno($ch)) {
	die('Connect error:' . curl_error($ch)); // Вывод ошибки соединения
}
curl_close($ch);

if(!in_array($http_code, [200, 400, 401])) {
	die('Response code: ' . $http_code); // Вывод неизвестного кода ответа
}

$decoded = json_decode($result, true); // Парсинг результа. На выходе получаем массив данных

if(json_last_error() !== JSON_ERROR_NONE) {
	die('Не удалось пропарсить ответ');
}

if($decoded['type'] == 'success') {
	print_r($decoded); // Вывод результата
} else {
	die('Ошибка: ' . $decoded['message']); // Вывод ошибки
}

Python

import requests, sys
from requests.exceptions import ConnectTimeout, ReadTimeout

url = 'https://aaio.so/api/info-payoff'
api_key = '' # Ключ API из раздела https://aaio.so/cabinet/api
my_id = 'my_id_123' # ID вывода средств в Вашей системе 

params = {
    'my_id': my_id
}

headers = {
    'Accept': 'application/json',
    'X-Api-Key': api_key
}

try:
    response = requests.post(url, data=params, headers=headers, timeout=(15, 60))
except ConnectTimeout:
    print('ConnectTimeout') # Не хватило времени на подключение к сайту
    sys.exit()
except ReadTimeout:
    print('ReadTimeout') # Не хватило времени на выполнение запроса
    sys.exit()

if(response.status_code in [200, 400, 401]):
    try:
        response_json = response.json() # Парсинг результата
    except:
        print('Не удалось пропарсить ответ')
        sys.exit()

    if(response_json['type'] == 'success'):
        print(response_json) # Вывод результата
    else:
        print('Ошибка: ' + response_json['message']) # Вывод ошибки
else:
    print('Response code: ' + str(response.status_code)) # Вывод неизвестного кода ответа