Справочники

Данный раздел описывает функции и структуры статичных данных использующихся в платежной платформе Velespay.

Запросы осуществляется с помощью GET запросов в кодировке UTF-8 к URL https://api.velespay.com/v1/info/<Название функции>.

Ответ от сервера является JSON объект или массив данных.

Так как данные меняются очень редко, во избежание ненужной нагрузки на сервер, просим кэшировать результаты запросов минимум на один час и более.

Успешный ответ будет содержать поле result.
Пример:

{
	"result": [Массив]
}

Ошибка будет содержать поле error с кодом и сообщением.
Пример:

{
	"error": {
		"code": цифровой код ошибки,
		"message": текстовое сообщение об ошибке
	}
}

Коды ошибок - Code_Error

Все коды ошибок возникающие в процессе работы с API.

URL: https://api.velespay.com/v1/info/Code_Error - список

URL: https://api.velespay.com/v1/info/Code_Error/1000 - конкретная ошибка

Коды состояния HTTP - Code_HTTP

URL: https://api.velespay.com/v1/info/Code_HTTP - список

URL: https://api.velespay.com/v1/info/Code_HTTP/404 - конкретный код состояния

Статусы аккаунтов - Status_Account

URL: https://api.velespay.com/v1/info/Status_Account - список

URL: https://api.velespay.com/v1/info/Status_Account/3 - конкретный статус

Статусы транзакций - Status_Transaction

URL: https://api.velespay.com/v1/info/Status_Transaction - список

URL: https://api.velespay.com/v1/info/Status_Transaction/7 - конкретный статус

Статусы Пополнений/Вывода - Status_Exchange

Данные статусы применяются при Пополнении/Выводе/Мерчанте, если данное действие производится через стороннюю систему

URL: https://api.velespay.com/v1/info/Status_Exchange - список

URL: https://api.velespay.com/v1/info/Status_Exchange/255 - конкретный статус

Статусы верификации - Status_Verification

URL: https://api.velespay.com/v1/info/Status_Verification - список

URL: https://api.velespay.com/v1/info/Status_Verification/3 - конкретный статус

Типы транзакций - Transaction_Type

URL: https://api.velespay.com/v1/info/Transaction_Type - список

URL: https://api.velespay.com/v1/info/Transaction_Type/1 - конкретный тип

Типы адресов - Address_Type

Какие бывают типы адресов.

URL: https://api.velespay.com/v1/info/Address_Type - список

URL: https://api.velespay.com/v1/info/Address_Type/1 - конкретный тип

Типы файлов адресов - Address_File_Type

Файлы для загрузки на подтверждение адреса.

URL: https://api.velespay.com/v1/info/Address_File_Type - список

URL: https://api.velespay.com/v1/info/Address_File_Type/1 - конкретный тип файла

Банковские коды - Bank_Code_Type

Национальные банковские коды не следует путать с международным SWIFT-BIC кодом.

URL: https://api.velespay.com/v1/info/Bank_Code_Type - список

URL: https://api.velespay.com/v1/info/Bank_Code_Type/1 - конкретный банковский код

URL: https://api.velespay.com/v1/info/Bank_Code_Type?code=CZE - поиск по полю code

Методы банковских переводов - Bank_Transfer_Method

OUR, SHA, BEN.

URL: https://api.velespay.com/v1/info/Bank_Transfer_Method - список

URL: https://api.velespay.com/v1/info/Bank_Transfer_Method/1 - конкретный метод

URL: https://api.velespay.com/v1/info/Bank_Transfer_Method?code=SHA - поиск по полю code

URL: https://api.velespay.com/v1/info/Category/1 - конкретная категория

URL: https://api.velespay.com/v1/info/Category?type=1 - поиск по полю type (id - Category_Type)

Страны - Country

URL: https://api.velespay.com/v1/info/Country - список

URL: https://api.velespay.com/v1/info/Country/1 - Цифровой код страны по стандарту ISO 3166-1

Дополнительные GET параметры для поиска:
	code_2 - Alpha-2 ISO 3166-1
	code_3 - Alpha-3 ISO 3166-1
	currency - Цифровой код национальной валюты
	citizenship=true - Страны граждане которых обслуживаются в системе Velespay

Определение страны по IP - Country_Geo

URL: https://api.velespay.com/v1/info/Country_Geo/3.128.79.4

Города - City

URL: https://api.velespay.com/v1/info/City - список

URL: https://api.velespay.com/v1/info/City/1 - конкретный город

Дополнительные GET параметры для поиска:
	country - Страна
	code_geo - Геокод
	capital=true - Столица

Типы валют - Currency_Type

URL: https://api.velespay.com/v1/info/Currency_Type - список

URL: https://api.velespay.com/v1/info/Currency_Type/1 - конкретный тип

Валюты - Currency

URL: https://api.velespay.com/v1/info/Currency - список

URL: https://api.velespay.com/v1/info/Currency/0840 - Цифровой код валюты по стандарту ISO 4217

Дополнительные GET параметры для поиска:
	code - Код валюты
	prefix - Символ
	type - Тип валюты (Currency_Type)
	visible=true - Используемые валюты в системе Velespay
	default=true - Валюты которые создаются автоматически в кошельке после регистрации в системе Velespay
	decimal_places - десятичный знак

Типы электронных валют - Currency_E_Type

URL: https://api.velespay.com/v1/info/Currency_E_Type - список

URL: https://api.velespay.com/v1/info/Currency_E_Type/1 - конкретный тип

Дополнительные GET параметры для поиска:
	visible=true - Доступность типа

Платежные системы/банки - E_System

URL: https://api.velespay.com/v1/info/E_System - список

URL: https://api.velespay.com/v1/info/E_System/1 - конкретная система

Дополнительные GET параметры для поиска:
	code - Код системы
	type - Тип системы (Currency_E_Type)
	visible=true - Используемые ПС в системе Velespay

Электронные валюты - Currency_E

URL: https://api.velespay.com/v1/info/Currency_E - список

URL: https://api.velespay.com/v1/info/Currency_E/0471 - цифровой код электронной валюты

Дополнительные GET параметры для поиска:
	code - Код
	prefix - Символ начала кошелька
	system - id системы (E_System)
	type - Тип системы (Currency_E_Type)
	currency - соответствие национальной валюты цифровой код по стандарту ISO 4217
	visible=true - Используемая электронная валюта в системе Velespay

Биржевые курсы валют - Currency_Rates

URL: https://api.velespay.com/v1/info/Currency_Rates - список за текущую дату

URL: https://api.velespay.com/v1/info/Currency_Rates/2019-01-01 - поиск по определенной дате

Дополнительные GET параметры для поиска:
	currency_from - Цифровой код по стандарту ISO 4217
	currency_to - Цифровой код по стандарту ISO 4217

Сотрудников - Employees

Количество сотрудников в компании

URL: https://api.velespay.com/v1/info/Employees - список

URL: https://api.velespay.com/v1/info/Employees/1

Лет в бизнесе - Years_Business

URL: https://api.velespay.com/v1/info/Years_Business - список

URL: https://api.velespay.com/v1/info/Years_Business/1

Комиссия на обмен валюты - Exchange

URL: https://api.velespay.com/v1/info/Exchange - список

URL: https://api.velespay.com/v1/info/Exchange/1

Дополнительные GET параметры для поиска:
	from - Цифровой код по стандарту ISO 4217
	to=true - Цифровой код по стандарту ISO 4217
	visible=true - Учитывается при обмене в системе Velespay
	default=true - Если по from и to комиссия не найдена, применяется по умолчанию

Типы документов для аттестации - Identity_Person_Type

URL: https://api.velespay.com/v1/info/Identity_Person_Type - список

URL: https://api.velespay.com/v1/info/Identity_Person_Type/1 - конкретный тип

Правовые формы компаний - Incorporation_Form

URL: https://api.velespay.com/v1/info/Incorporation_Form - список

URL: https://api.velespay.com/v1/info/Incorporation_Form/1 - конкретная форма

Языки - Language

URL: https://api.velespay.com/v1/info/Language - список

URL: https://api.velespay.com/v1/info/Language/045 - цифровой код

Дополнительные GET параметры для поиска:
	code_1 - ISO 639-1
	code_2 - ISO 639-2
	code_3 - ISO 639-3
	support=true - Поддерживаются сотрудниками Velespay в "Службе поддержки"
	visible=true - Доступные в системе Velespay

Способы пополнения аккаунта - Deposit

URL: https://api.velespay.com/v1/info/Deposit - список

URL: https://api.velespay.com/v1/info/Deposit/1 - конкретный способ

Дополнительные GET параметры для поиска:
	ps_code - Код электронной валюты
	rounding - Способ округления (no, all, from, to)
	manual=true - Ручной тип пополнения
	manual=false - Автоматический тип пополнения
	visible=true - Доступный способ пополнения в системе Velespay

Способы вывода с аккаунта - Withdraw

URL: https://api.velespay.com/v1/info/Withdraw - список

URL: https://api.velespay.com/v1/info/Withdraw/1 - конкретный способ

Дополнительные GET параметры для поиска:
	ps_code - Код электронной валюты
	rounding - Способ округления (no, all, from, to)
	manual=true - Ручной тип вывода
	manual=false - Автоматический тип вывода
	visible=true - Доступный способ вывода в системе Velespay

Способы оплат в мерчанте - Merchant

URL: https://api.velespay.com/v1/info/Merchant - список

URL: https://api.velespay.com/v1/info/Merchant/1 - конкретный способ

Дополнительные GET параметры для поиска:
	ps_code - Код электронной валюты
	rounding - Способ округления (no, all, from, to)
	manual=true - Ручной тип
	manual=false - Автоматический тип
	visible=true - Доступный способ в системе Velespay
	permission=true - Требуется одобрение сотрудниками Velespay