Метод info

URL: GET - /partner/invoice/{id}

Метод позволяет получить информацию по идентификатору инвойса. Строка запроса содержит идентификатор инвойса.

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

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

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

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

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

curl POST '/partner/invoice/{id}' \
    --header 'client-id: system' \
    --header 'client-secret: system123'

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

Имя	Тип	Описание
data	object	Объект данных созданного инвойса
id	string	Идентификатор инвойса
amount	integer	Сумма пополнения в тийинах, центах и т.д. (1/100 часть базовой единицы валюты)
currency	string	Валюта: «UZS» - узбекский сум
note	string	Текст примечания, заметки и т.д.
status	string	Статус инвойса Доступны следующие значения: «DRAFT» - Инвойс на стадии создания «OPEN» - Инвойс не оплачен «PAID» - Инвойс оплачен «EXPIRED» - Срок действия инвойса истек «CANCEL» - Инвойс отменен
receiver	object	Объект данных клиента
receiver.email	string	E-mail адрес клиента
receiver.phone	string	Номер телефона клиента
metadata	string	Список метаданных
accounts	object	Объект данных относительно услуг мерчанта. Параметры и их значения объекта accounts определяется в зависимости от услуги мерчанта, на которую осуществляется платеж. Например: Для оплаты услуги мобильного оператора отправляется номер телефона.
business	object	Объект данных относительно поставщика услуг
business.id	string	Идентификатор поставщика услуг
business.legalName	string	Юридическое название поставщика услуг
business.brandLogo	string	Логотип бренда поставщика услуг
business.brandName	string	Название бренда поставщика услуг
business.code	object	Массив организационно-правовой формы (ОПФ)поставщика услуг
business.code.uz	string	ОПФ на узбекском языке
business.code.ru	string	ОПФ на русском языке
business.code.en	string	ОПФ на английском языке
merchant	object	Объект данных относительно мерчанта
merchant.id	string	Идентификатор мерчанта VIA
merchant.brandName	string	Название бренда мерчанта
merchant.name	string	Наименование мерчанта
merchant.logo	string	Логотип мерчанта
callbackUrl	string	Обратная ссылка для возврата клиента в страницу партнера
redirectUrl	string	Ссылка для перенаправления клиента в другую страницу
createdDate	integer	Дата и время создания инвойса в формате Unix Timestamp
modifiedDate	integer	Дата и время обновления статуса инвойса в формате Unix Timestamp
closedAt	integer	Дата и время закрытия инвойса в формате Unix Timestamp

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

{
    "data": {
      "id": "inv_2du8459xc1AiqxRgyEyEzgogjlL"
      "amount": 100,
      "currency": "UZS",
      "note": "Invoice for car",
      "status": "OPEN", // EXPIRED, CANCEL, PAID, OPEN, DRAFT 
      "receiver": { 
        "email": "example@gmail.com", 
        "phone": "977000000" 
      }, 
      "metadata": { },
      "accounts": { },
      "business": {
          "id": "bns_2c5hswGyIMGzAsxfJJRXfD49ahY",
          "legalName": "FOR TESTING",
          "brandLogo": "",
          "brandName": "FOR TESTING (NOT EDIT)",
          "code": {
              "uz": "MChJ",
              "ru": "ООО",
              "en": "LLC"
          }
      },
      "merchant": {
          "id": "mrt_2c5i9Fh4keM6BLhSGANYR48GNHW",
          "brandName": "",
          "name": "FOR TESTING MERCHANT (NOT EDIT)",
          "logo": ""
      },
     "callbackUrl": null, 
     "redirectUrl": "https://business.via.uz/invoice/inv_2du8459xc1AiqxRgyEyEzgogjlL", 
     "createdDate": 1710846408822, 
     "modifiedDate": 1710846408822, 
     "closedAt": null 
    }
}

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

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