+7(495)774-78-17 Обратный звонок

CYPIX API V 2.5

Общие принципы взаимодействия с Системой

API платежной системы осуществляет прием платежей для web-сервисов.

Инициализация платежа производится через отправку запроса на сервер Cypix.

По факту выполнения или не выполнения платежа на URL оплачиваемого сервиса платформа Cypix отправляет уведомление.

Исходные данные

Для начала работы с платформой партнеру необходимо предоставить следующие данные:

URL для отправки уведомлений о статусе запросов на проведение платежей.

Со стороны Cypix партнеру выдаются:

- Идентификатор сервиса партнера.

- Секретный ключ

Инициализация платежа без переадресации Покупателя на платежную форму

Для некоторых платежных систем, таких как QIWI или Мобильная коммерция, партнер может не перенаправлять пользователя на платежную форму, что позволяет легко интегрировать механизм оплаты в интерфейс любого сайта или приложения.

Для совершения платежа пользователем, партнёру необходимо послать запрос на оплату методом GET на адрес https://api.cypix.ru/transaction/ с передачей следующих параметров:

Параметр Описание
service_id Идентификатор сервиса партнера. Создается на стороне Cypix и выдается вашим менеджером перед началом работы.

Пример: 5432

order_id Уникальный идентификатор платежа, сгенерированный на стороне Партнера (до 64 символов)

Пример: 12345678asdfgh

payment_method_id Идентификатор метода оплаты (таблица методов оплаты в Приложении 3)

Пример: 2

summ Сумма платежа, число с 2-мя знаками в дробной части, разделитель целой и дробной части - точка.

Пример: 120.20

currency Валюта, трехбуквенный код валюты по ISO 4217 (рубль: RUB)

Пример: RUB

msisdn Необязателен; указывается только в случае оплаты через систему Мобильной коммерции, представляет из себя номер мобильного телефона в международном формате, то есть без +

Пример: 79031234567

description Необязателен; используется в тексте SMS-сообщений или в описании услуги на форме

Пример: Оплата заказа №123

hash Контрольная сумма. Высчитывается как md5(service_id+order_id+summ+currency +payment_method_id+ description+msisdn+secret), где “+”- знак конкатенации, “secret” - секретный ключ, выдаваемый при регистрации сервиса. Если необязательный параметр не передается, то он не участвует в расчете хеша.

Пример: 7373d616ba14400a7d2a6f4876dd7182

Пример запроса на инициализацию платежа

http://api.cypix.ru/transaction/?service_id=2&order_id=test_1456858950&summ=10&currency=RUB&payment_method_id=1&msisdn=79121234567&hash=6409d9e491ef8116ad0901dad7a9778b

Где строка для генерации хеша (если секретный ключ имеет значение «7373d616ba14400a7d2a6f4876dd7182»):

2test_145685895010RUB1791212345677373d616ba14400a7d2a6f4876dd7182

В ответ на запрос партнер получит ответ HTTP 200 OK с результатом принятия заявки в теле ответа в формате JSON, с следующими параметрами:

Параметр Описание
processing_status Статус обработки платежа

ACCEPTED - Заявка принята, ожидаются действия пользователя по совершению платежа;

REDIRECT - Для продолжения оформления заявки необходимо направить пользователя на указанный URL;

DENIED - Заявка не принята;

error_code В случае processing_status=DENIED в ответе указывается код ошибки, согласно Приложения 1
location В случае processing_status=REDIRECT указывается URL, на который необходимо перенаправить Покупателя.
transaction_id В случае processing_status=ACCEPTED указывается номер транзакции на стороне сервера Cypix (целое число, до 20 знаков)

Пример: 2016030

Пример тела ответа в случае успешного принятия заявки:

{
“transaction_id”: “123456”,
“processing_status”: “ACCEPTED”,
“error_code”: “0”
}

Пример тела ответа, в случае, если запрос на инициализацию платежа не принят

{
“processing_status”: “DENIED”,
“error_code”: “1”
}
Интерфейс определения оператора абонента по MSISDN

В случаях, когда партнёру необходимо узнать оператора абонента по MSISDN, он может воспользоваться данным интерфейсом
Для этого, партнёру необходимо послать запрос методом GET на адрес http://api.cypix.ru/operator/ с передачей следующих параметров:

Параметр Описание
service_id Идентификатор сервиса партнера. Создается на стороне Cypix и выдается вашим менеджером перед началом работы.

Пример: 5432

secret Секретный ключ сервиса, выдаваемый при регистрации сервиса
msisdn Номер мобильного телефона в международном формате, начинающийся с кода страны без +

Пример: 790312345678

В ответ на запрос партнер получит ответ HTTP 200 OK с результатом принятия заявки в теле ответа в формате JSON, с следующими параметрами:

Параметр Описание
operator_name Название оператора латинскими буквами согласно Приложения 2.

Пример тела успешного ответа:

{
	“operator_name”:”beeline”
}

В случае неверно заданных параметров, будет выдан ответ HTTP – 400 В случае некорректного secret, будет выдан ответ HTTP – 401

Уведомление Партнера о совершенных платежах

После того, как транзакция прошла успешно или была отклонена, платформа Cypix отсылает HTTP запрос методом GET на URL для уведомлений, предоставленный Партнером для сервиса перед началом работы.
Запрос, отсылаемый сервису, содержит следующие параметры с информацией о транзакции:

Параметр Описание
service_id Идентификатор сервиса партнера. Создается на стороне Cypix и выдается вашим менеджером перед началом работы.

Пример: 5432

order_id Уникальный идентификатор платежа, сгенерированный на стороне Партнера (до 64 символов)

Пример: 12345678asdfgh

processing_status Статус обработки транзакции:

PROCESSED - Транзакция прошла успешно

FAILED - Транзакция была отклонена

error_code Код ошибки, в случае processing_status=FAILED, согласно Приложения 1
price Сумма транзакции в валюте поступления, число с 2-мя знаками в дробной части, разделитель целой и дробной части - точка.

Пример: 120.20

price_rub Сумма транзакции в рублях, число с 2-мя знаками в дробной части, разделитель целой и дробной части - точка.

Пример: 120.20

currency Валюта поступления на счет партнера, трехбуквенный код валюты по ISO 4217 (рубль: RUB).

Пример: RUB

share Вознаграждение Партнера в валюте платежа, число с 2-мя знаками в дробной части, разделитель целой и дробной части - точка.

Пример: 120.20

share_rub Вознаграждение Партнера в рублях, число с 2-мя знаками в дробной части, разделитель целой и дробной части - точка.

Пример: 120.20

transaction_date Дата проведения транзакции на стороне Платформы Cypix в формате YYYY-MM-DD HH:mm:ss

Пример: 2016-03-08 00:51:52

transaction_id Идентификатор транзакции на стороне платформы Cypix, целое число, до 20 знаков.

Пример: 2016030

payment_method_id Идентификатор способа оплаты. согласно Приложения 3.

Пример: 2

hash Контрольная сумма.
Высчитывается как md5:
service_id+transaction_id+order_id+processing_status+price+price_rub+currency+share+share_rub+transaction_date+payment_method_id+secret
где “+”- знак конкатенации,
“secret” - секретный ключ, выдаваемый при регистрации сервиса.
Если необязательный параметр не передается, то он не участвует в расчете хеша.

Пример: 7373d616ba14400a7d2a6f4876dd7182

Приложение 1. Список кодов ошибок
Код ошибки Описание
0 Операция успешна, ошибки отсутствуют
1 Неверное значение параметра hash
2 Неверное значение параметра service_id
3 Некорректный запрос, отсутствует один или несколько обязательных параметров
4 Внутренняя ошибка обработки запроса, необходимо обратиться в техническую поддержку Cypix
5 Запрос на инициализацию платежа не может быть принят
500 Платеж отклонен оператором (причина неизвестна)
504 Платеж отклонен оператором (ожидается подтверждение другого платежа)
505 Превышен таймаут ожидания подтверждения платежа
51 Передан некорректный идентификатор пользователя(например некорректный MSISDN при оплате через QIWI/МК)
516 Платеж отклонен оператором (абонент имеет признак - запрет возврата части аванса)
517 Платеж отклонен оператором (у абонента отсутствует разрешение на передачу персональных данных)
518 Платеж отклонен оператором (Услуга недоступна для данного источника средств)
519 Платеж отклонен оператором (Ошибка идентификации источника средств)
52 Оплата через данного оператора временно не доступна
59 Платеж отклонен оператором (причина не известна)
6 Оплату данным методом платежа невозможно провести без перенаправления пользователя на платежную форму Cypix.
7 Некорректная сумма платежа
701 Недостаточно средств для проведения платежа
71 Сумма платежа превышает допустимую сумму
72 Сумма платежа меньше минимально разрешенной
73 Некорректная валюта
8 MSISDN заблокирован
81 MSISDN внесен в черный список
82 Превышен лимит по количеству платежей за определенный период времени по данному MSISDN
9 Определение MSISDN через XBR недоступно
Приложение 2. Список идентификаторов операторов сотовой связи
Оператор Идентификатор
МТС mts
БИЛАЙН beeline
МЕГАФОН megafon
TELE2 tele2
TАТТЕЛЕКОМ tattelecom
ОПЕРАТОР НЕИЗВЕСТЕН unknown
Приложение 3. Идентификаторы платежных систем
Идентификатор Платежная система
1 Мобильная коммерция
2 Банковские карты