Перейти к основному содержимому

Метод info

URL: POST - /partner/hold/info

Метод позволяет получит статус холдирования.

Параметры Заголовков

СвойствоТипОписание
client-id *авторизацияУникальный идентификатор партнера
client-secret *авторизацияУникальный ключ аутентификации к API VIA

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

ИмяТипОписание
holdId *stringИдентификатор холдирования

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

curl POST '/partner/hold/info?holdId=phl_2RW4uL2eTpbCqyUjw9mZEOUgVYY' \
--header 'client-id: system' \
--header 'client-secret: system123'

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

ИмяТипОписание
holdIdstringИдентификатор холдирования
statusstringСтатус выполнения запроса на холдирование
Доступны следующие значения:
«NEW» - Запрос на холдирование принят
«CREATE_SUCCESS» - Холдирование успешно
«CREATE_PENDING» - Холдирование в ожидании
«CREATE_ERROR» - Ошибка при холдировании
«CONFIRM_SUCCESS» - Снятие средств выполнено успешно
«CONFIRM_PENDING» - Процесс снятия средств в ожидании
«CONFIRM_ERROR» - Ошибка при снятии средств
«CANCEL_SUCCESS» - Отмена средств выполнено успешно
«CANCEL_PENDING» - Процесс отмены средств в ожидании
«CANCEL_ERROR» - Ошибка при отмене средств
«EXPIRED» - срок холдирования истек

Пример ответа в случае успеха

{
"data": {
"holdId": "phl_2RW4uL2eTpbCqyUjw9mZEOUgVYY",
"status": "CONFIRM_SUCCESS"
}
}

Пример ответа в случае ошибки

{
"status": {
"code": "1234",
"message": "Ошибка при выполнении запроса"
},
"error": {
"path": "URL Path",
"message": {
"uz": "Error message in Uzbek",
"ru": "Error message in Russian",
"en": "Error message in English"
}
}
}