Разработчикам
Документация по подключению и API
API
API SecureBox.money (далее Сервис) предназначен для выявления подозрительных финансовых транзакций. Сервис выполняет проверку финансовой операции, результатом которой является рекомендация по дальнейшей обработке операции.
Авторизация
Сервис может возвращать одну из трех рекомендаций:
  • Pass - продолжить обработку транзакции;
  • 3DS or block - отправить транзакцию на прохождение 3D Secure. Если невозможно принудительно отправить транзакцию на прохождение 3D Secure, то следует заблокировать её дальнейшую обработку;
  • Block - следует заблокировать дальнейшую обработку транзакции.
Для авторизации используется HTTP Bearer Authentification
В заголовке запроса Authorization передается JWT
Authorization: Bearer <JWT>

Пример JWT можно посмотреть по ссылке jwt.io
Токены можно создать в личном кабинете самостоятельно. На данный момент функционал находится в разработке, и выдача токена производится менеджером SecureBox.money.
Проверка операции
https://api.securebox.money/v1/check
Запрос (Request)
Заголовки запроса (дополнительный заголовок):
POST
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJndWVzdCIsImV4cCI6MjAyMDEyMzEyMzU5NTl9.VWOyfgzj-UzLMB7c_v4PDfMpS_YtVF7mZaIcyuoUoQS6buBnmKfLcVQZb6TJEHV9XN3rojFVRXYG0tm58mdBGw 
Request body (application/json)
{
	"Customer": "Customer name",
	"Operation": "in",
	"Order": "ID0984328734",
	"Amount": 100,
	"Currency": 398,
	"Description": "Payment description",
	"Datetime": "2020-03-11 13:11:03",
	"Client": {
		"IP": "192.168.1.1",
		"Email": email@example.com,
		"Phone": "+77773332211"
	},
	 "Card": {
		"Holder": "TURING ALAN",
		"PanFirst": 440546,
		"PanLast": 6371,
		"ExpMonth": 9,
		"ExpYear": 25
	 }
}
Параметры:
Параметры
Тип
Обязательный
Описание
Customer
string
да
Нименование мерчанта. Создается в Системе SecureBox
Customer
string
да
Нименование мерчанта. Создается в Системе SecureBox
Operation
string
да
Определение операции зачисление/списание. Выбирается одно из двух значений: "in" или "out".
Order
string
да
ID финансовой опреации в системе мерчанта
Amount
numeric
да
Сумма операции
Currency
numeric
да
Код валюты в Системе Securebox
Description
string
да
Описание финансовой операции
Datetime
string
да
Дата финансовой операции в формате "Y-m-d H:i:s"
Client.IP
string
нет
IP адрес с которого производится финансовая операция
Client.Email
string
нет
Email плательщика/получателя
Client.Phone
string
нет
Номер телефона плательщика/получателя
Card.Holder
string
да
Владелец карты
Card.PanFirst
int
да
Первые 6 цифр номера карты (PAN)
Card.PanLast
int
да
Последние 4 цифры номера карты (PAN)
Card.ExpMonth
int
да
Месяц срока действия карты
Card.ExpYear
int
да
Год срока действия карты
В ответ на запрос возвращается JSON объект с описанием ответа.
Ответ (Response)
{
	"message": "Успешно пройдено",
	"result": 10
}
Параметры ответа:
Параметры
Тип
Описание
message
string
Строка описания состояния ответа. Возможные варианты представлены ниже
result
int
Код результата анализа финансовой операции. Возвращается только в случае успешного выполнения запроса. Возможные варианты представлены ниже.
Код результата анализа операции:
Код
Рекомендованное действие
Описание рекомендации
10
pass
продолжить обработку транзакции
20
block
следует заблокировать её дальнейшую обработку
30
3ds_or_block
отправить транзакцию на прохождение 3D Secure. Если невозможно принудительно отправить транзакцию на прохождение 3D Secure, то следует заблокировать её дальнейшую обработку
Коды ответа:
Код
Сообщение
Описание
200
Успешно пройдено
Запрос выполнен успешно
403
Доступ запрещен
Возникла ошибка авторизации
422
Ошибка валидации
Неверно переданы данные в сегменте payload
500
Серверная ошибка
Во время выполнения запрос произошла серверная ошибка
999
Неизвестная ошибка
Во время выполнения запрос произошла неизвестная ошибка


Made on
Tilda