Структуры данных
Данный раздел описывает структуры данных возвращаемые после успешного запроса при совершении финансовых операций в платежной платформе Velespay.
Balance
{
"result": [{
<Номер кошелька. Пример: VM123456789>: [{
"currency": {
"id": <Цифровой код валюты по стандарту ISO 4217. Пример: 0840>,
"code": <Код валюты по стандарту ISO 4217. Пример: USD>
},
"amount": <Общий баланс (десятичное число)>,
"hold": <Замороженная сумма (десятичное число)>,
"available": <Доступный баланс (десятичное число)>
}]
}]
}
CurrencyExchange
{
"result": [{
"action": <Действие. Пример: sell или buy>,
"currency_from": <Цифровой код валюты по стандарту ISO 4217. Пример: 0840>,
"currency_to": <Цифровой код валюты по стандарту ISO 4217. Пример: 0643>,
"gross": <Сумма заплаченная в валюте currency_from (десятичное число)>,
"net": <Полученная сумма в валюте currency_to (десятичное число)>,
"rate": <Курс обмена валют (десятичное число)>
}]
}
HistoryInfo
{
"result": {
"page_size": <Количество возвращенных транзакций на страницу (целое число)>,
"page_number": <Страница (целое число)>,
"total_count": <Общее количество найденных транзакций (целое число)>,
"records": [
<массив объектов TxnInfo поле result>
]
}
}
TxnInfo
{
"result": {
"id": <ID транзакции (целое число)>,
"date": <Дата в формате UTC>,
"lifetime": <Срок действия счета в формате UTC>,
"hash": <Hash для перенаправления>,
"type": <Тип транзакции (целое число)>,
"via": <Каким способом выполнена транзакция (целое число)>,
"status": [
[
<Дата в формате UTC>,
<Статус транзакции (целое число)>
]
],
"invoice": <Если указано. Номер счета-фактуры, в соответствии с системой ведения учета продавца>,
"sender": {
"wallet": <Кошелек отправителя. Пример: VM123456789>,
"account": <Аккаунт отправителя (целое число)>,
"email": <E-mail отправителя>,
"phone": <Телефон отправителя>,
"name": <Имя отправителя (Имя и Фамилия или название компании)>,
"country": <Страна отправителя (Цифровой код страны ISO 3166-1)>,
"status": <Статус аккаунта отправителя (целое число)>
},
"receiver": {
"wallet": <Кошелек получателя. Пример: VM123456789>,
"account": <Аккаунт получателя (целое число)>,
"email": <E-mail получателя>,
"phone": <Телефон получателя>,
"name": <Имя получателя (Имя и Фамилия или название компании)>,
"country": <Страна получателя (Цифровой код страны ISO 3166-1)>,
"status": <Статус аккаунта получателя (целое число)>
},
"currency": <Валюта операции. Цифровой код валюты по стандарту ISO 4217. Пример: 0840>,
"gross": <Оплаченная сумма>,
"fee": <Сумма комиссии>,
"net": <Полученная сумма>,
"balance": <Баланс у отправителя или получателя после операции>,
"period": <Если перевод с кодом протекции. Период протекции или 0>,
"code": <Если перевод с кодом протекции. Код активации перевода. Отображается только у отправителя>,
"description": <Комментарий или сообщение отправителя>,
"info": {
<Объект. Дополнительная информация о платеже. В зависимости от типа операции>,
},
"user_agent": <Браузер через который была создана операция. Браузер Отправителя или Получателя>,
"ip": <IP адрес отправителя/получателя>,
"is_incoming": <если true - входящая транзакция или false - исходящая транзакция>
}
}
TxnInfo.info - CurrencyExchange
{
"action": <Действие. Пример: sell или buy>,
"currency_from": <Цифровой код валюты по стандарту ISO 4217. Пример: 0840>,
"currency_to": <Цифровой код валюты по стандарту ISO 4217. Пример: 0643>,
"gross": <Сумма заплаченная в валюте currency_from (десятичное число)>,
"net": <Полученная сумма в валюте currency_to (десятичное число)>,
"rate": <Курс обмена валют (десятичное число)>
}
TxnInfo.info - Invoice
{
"invoice": {
"number": <Номер счета-фактуры, в соответствии с системой ведения учета продавца>,
"currency": <Валюта по счету-фактуре. Код валюты по стандарту ISO 4217. Пример: USD>,
"product": [
{
"name": <Наименование Товара или Услуги>,
"quantity": <Количество>,
"price": <Цена за единицу Товара/Услуги>
}
],
"payment_method": [
<массив с кодами электронных валют с помощью которых возможно оплатить счет-фактуру>
],
"who_fee": <кто платит комиссию>,
"email": <E-mail покупателя>
},
"payment": {
"method": {
"system": <Код платежной системы, поле code раздела "Информационные данные" -> "Платежные системы/банки">,
"code": <Код электронной валюты, поле code раздела "Информационные данные" -> "Электронные валюты">,
"currency": <Код национальной валюты, поле code раздела "Информационные данные" -> "Валюты">
},
"money": {
"gross": <Сумма которая оплачена в валюте method.currency>,
"fee": <Комиссия в валюте method.currency>,
"net": <Сумма зачисленная на внутренний кошелек>
},
"payer": {
"lang": <Код языка ISO 639-1 плательщика>,
"wallet": <Кошелек в сторонней ПС, через которую сделано пополнение>,
"email": <E-mail в сторонней ПС, через которую сделано пополнение>,
"phone": <Телефон в сторонней ПС, через которую сделано пополнение>,
"user_agent": <Браузер плательщика>,
"ip": <IP адрес плательщика>
<Если оплата через банки с помощью SWIFT/SEPA, то банковские реквизиты>
},
"status": [
[
<Дата в формате UTC>,
<Статусы Пополнений/Вывода>
]
],
"details": {
<Информация от ПС, через которую сделано пополнение>
}
},
"agent": <ID агента>
}
TxnInfo.info - Deposit
{
"payment": {
"method": {
"system": <Код платежной системы, поле code раздела "Информационные данные" -> "Платежные системы/банки">,
"code": <Код электронной валюты, поле code раздела "Информационные данные" -> "Электронные валюты">,
"currency": <Код национальной валюты, поле code раздела "Информационные данные" -> "Валюты">
},
"money": {
"gross": <Сумма которая оплачена в валюте method.currency>,
"fee": <Комиссия в валюте method.currency>,
"net": <Сумма зачисленная на внутренний кошелек>
},
"payer": {
"lang": <Код языка ISO 639-1 плательщика>,
"wallet": <Кошелек в сторонней ПС, через которую сделано пополнение>,
"email": <E-mail в сторонней ПС, через которую сделано пополнение>,
"phone": <Телефон в сторонней ПС, через которую сделано пополнение>,
"user_agent": <Браузер плательщика>,
"ip": <IP адрес плательщика>
<Если пополнение через банки с помощью SWIFT/SEPA, то банковские реквизиты>
},
"status": [
[
<Дата в формате UTC>,
<Статусы Пополнений/Вывода>
]
],
"details": {
<Информация от ПС, через которую сделано пополнение>
}
},
"agent": <ID агента>
}
TxnInfo.info - Withdraw
{
"payment": {
"method": {
"system": <Код платежной системы, поле code раздела "Информационные данные" -> "Платежные системы/банки">,
"code": <Код электронной валюты, поле code раздела "Информационные данные" -> "Электронные валюты">,
"currency": <Код национальной валюты, поле code раздела "Информационные данные" -> "Валюты">
},
"money": {
"gross": <Сумма которая оплачена в валюте транзакции>,
"fee": <Комиссия в валюте транзакции>,
"net": <Сумма отправленная в сторонней ПС>
},
"payee": {
"lang": <Код языка ISO 639-1 получателя>,
"wallet": <Кошелек в сторонней ПС, на которую сделан вывод>,
"email": <E-mail в сторонней ПС, на которую сделан вывод>,
"phone": <Телефон в сторонней ПС, на которую сделан вывод>,
"user_agent": <Браузер плательщика>,
"ip": <IP адрес плательщика>
<Если вывод в банки с помощью SWIFT/SEPA, то банковские реквизиты>
},
"status": [
[
<Дата в формате UTC>,
<Статусы Пополнений/Вывода>
]
],
"details": {
<Информация от ПС, через которую сделано пополнение>
}
},
"agent": <ID агента>
}