ПРИЕМ ПЛАТЕЖЕЙ ПО API
ПРОВЕРКА ПЛАТЕЖА БЕЗ ПРОВЕДЕНИЯ
Предназначена для проверки возможности совершения платежа по указанным реквизитам. Используется для проверки корректности введенного номера телефона, карты и т. д.
Не инициирует реальное проведение платежа. Не предназначена для проверки статуса проведенного платежа
Запрос
https://pays-api-2012.armax.ru/pays-api2012/api/v1/pays
Content-Type: text/plain;charset=utf-8
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <request> <auth dealer="2043" login="admin" password="qweqweqwe" terminal="1002"/> <check-payment> <payment id="31078607300" rate="1"> <extras extra_name1="extra_value1" extra_name2="extra_value2"/> <from commission="5.00" currency="643" summ="25.00"/> <to account="9539635431" provider="3"/> </payment> </check-payment> </request>
request – корневой тег запроса
auth – тег содержит информацию для авторизации пользователя, от имени которого
отправляется запрос.
login – логин пользователя,
password – пароль пользователя
dealer – ID агента
terminal – номер терминала,
check-payment – тег запроса на добавление платежа
payment – тег, содержащий информацию о платеже
id – идентификатор платежа/номер чека
rate – возвращать курс конвертации валюты (1 – возвращать, 0 – не возвращать)
from – тег содержит информацию о сумме от клиента и комиссии
summ – внесенная сумма (необязательный параметр)
commission – комиссия (необязательный параметр)
currency – код валюты (643 рубли)
to – тег содержит информацию о назначении платежа
provider – идентификатор сервиса, услуги которого оплачиваются
account – номер счета
extras – тег содержит экстра-поля. В одном теге может быть указано несколько экстра-полей.
Названия экстра-полей (extra_name1, extra_name2) должны соответствовать спецификации XML 1.0, т.е. не могут начинаться с цифры, содержать пробелы или специальные символы.
Ответ
<?xml version="1.0" encoding="utf-8"?> <response result="103" result-description="Bad credentials" > </response> <?xml version="1.0" encoding="utf-8"?> <response result="0" result-description="" > <check-payment> <payment id="1002" description="" result="0" result-description="" status="1" rate="30.05" /> </check-payment> </response>
<response result="0" > – атрибут result отражает успешность/неуспешность выполнения
запроса. Если нет ошибок, атрибут result возвращает значение "0". Атрибут result-description
содержит описание ошибки
payment – тег, содержащий информацию о платеже
id – идентификатор платежа (номер чека), назначенный агентом
result – код завершения
result-description – описание ошибки выполнения запроса
status – статус проверки платежа
description – результат проверки платежа
rate – курс конвертации из исходной валюты платежа в валюту счета в ПС
Статусы проверки платежа
0 – проверка выполняется
1 – проверка выполнена успешно
2 – проверка выполнена с ошибками
Коды завершения
0 – нет ошибок
101 – неверный запрос
102 – сервис не доступен
103 – неверный логин/пароль
104 – ошибка базы данных
105 – внутренняя ошибка
200 – неизвестная ошибка
ПРОВЕДЕНИЕ ПЛАТЕЖА
Предназначен для отправки платежа в проведение. Уникальность платежа контролируется на стороне клиента (UID транзакции) .
Сервер рассматривает связку ID терминала+UID транзакции как уникальное поле.
При попытке добавить новый платеж с уже использованным UID будет возвращен статус предыдущего платежа.
Запрос
https://pays-api-2012.armax.ru/pays-api2012/api/v1/pays
Content-Type: text/plain;charset=utf-8
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <request> <auth dealer="2043" login="admin" password="qweqweqwe" terminal="1002"/> <add-payment> <payment date="2013-03-27T19:10:31" id="31078607300"> <extras extra_name1="extra_value1" extra_name2="extra_value2"/> <from commission="5.00" currency="643" summ="25.00"/> <to account="9539635431" props="" provider="3"/> </payment> </add-payment> </request>
request – корневой тег запроса
auth – тег содержит информацию для авторизации пользователя, от имени которого
отправляется запрос.
login – логин пользователя,
password – пароль пользователя
dealer – ID агента
terminal – номер терминала,
add-payment – тег запроса на добавление платежа
payment – тег, содержащий информацию о платеже
id – идентификатор платежа/номер чека
date – дата и время печати чека
from – тег содержит информацию о сумме от клиента и комиссии
summ – внесенная сумма
commission – комиссия
currency – код валюты (643 рубли)
to – тег содержит информацию о назначении платежа
provider – идентификатор сервиса, услуги которого оплачиваются
account – номер счета
props – дополнительные параметры
extras – тег содержит экстра-поля. В одном теге может быть указано несколько экстра-полей.
Названия экстра-полей (extra_name1, extra_name2) должны соответствовать спецификации XML 1.0, т.е. не могут начинаться с цифры, содержать пробелы или специальные символы. В случае передачи платежа провайдера, содержащего более одного поля, имена полей блока extra брать из имен полей провайдера в кабинете агента agent.armax.ru (меню Провайдеры)
Ответ
<?xml version="1.0" encoding="utf-8"?> <response result="103" result-description="Bad credentials" > </response> <?xml version="1.0" encoding="utf-8"?> <response result="0" result-description="" > <add-payment> <payment date="2012-04-13T16:34:53" id="1002" description="" result="0" result-description="" status="1" transaction-id="241003477"/> </add-payment> </response>
<response result="0" > – атрибут result отражает успешность/неуспешность выполнения
запроса. Если нет ошибок, атрибут result возвращает значение "0". Атрибут result-description
содержит описание ошибки
payment – тег, содержащий информацию о платеже
id – идентификатор платежа (номер чека), назначенный агентом
result – код завершения
result-description – описание ошибки выполнения запроса
status – статус платежа
description – описание статуса платежа
transaction-id – идентификатор транзакции в arMax
Статусы платежа
0 – новый
1 – проведён
2 – ошибочный
Коды завершения
0 – нет ошибок
101 – неверный запрос
102 – сервис не доступен
103 – неверный логин/пароль
104 – ошибка базы данных
105 – внутренняя ошибка
200 – неизвестная ошибка
ПОЛУЧЕНИЕ БАЛАНСА
https://pays-api-2012.armax.ru/pays-api2012/api/v1/balance
Content-Type: text/plain;charset=utf-8
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <request> <auth dealer="2043" login="admin" password="qweqweqwe"/> </request>
request – корневой тег запроса
auth – тег содержит информацию для авторизации пользователя, от имени которого
отправляется запрос.
login – логин пользователя,
password – пароль пользователя
dealer – ID агента
Ответ
<?xml version="1.0" encoding="utf-8"?> <response result="103" result-description="Bad credentials" > <pre></response> <?xml version="1.0" encoding="utf-8"?> <response result="0" result-description="" > <accounts> <account id="1008" name="Accoun1" update-date="2013-04-08T18:53:03" external-balance="1.1200"/> <account id="1197" name="Accoun100500" update-date="2013-04-08T18:53:05" external-balance="50.0000"/> </accounts> </response>
account – тег, содержащий информацию о счете
id – идентификатор счета
name – название счета
update-date – дата последнего запроса баланса в ПС
external-balance – баланс счета в ПС