Методы API
Метод makeOrder
Метод для создания заказа. Возможнные параметры:
project
* обязательно |
ID проекта |
innerID
* обязательно |
Строка которая вернется в коллбеке (ID заказа в вашей системе, логин или ID пользователя и т.п.) - любая строка UTF-8, до 500 символов |
sum
* обязательно |
Сумма заказа, разделитель - точка ( напр 1.22 или целое: 228) |
currency
* обязательно |
Валюта для выставления счета, может быть нативной валютой канала приема (например RUB для p2p_RUB) или USD. |
email
* обязательно |
e-mail плательщика - отобразится у вас в личном кабинете и вернется в коллбеке. Необязательно передавать реальный e-mail человека: достаточно передать строку вида user@site.com, где user - индивидуальный идентификатор пользователя. Используется только для пресечения непомерного создания заказов одним пользователем. |
order_type | Тип заказа, по умолчанию: card_p2p_RUB. Список доступных вам типов заказов уточните у тех-поддержки; |
comment | Комментарий к заказу, строка до 70 симоволов. Отобразится плательщику на странице оплаты; |
success_url fail_url |
Для создаваемого заказа можно указать свои собственные success_url (куда будет переход после оплаты) и/или fail_url (переход при неудаче оплаты). Если параметры не указаны - URL`ы будут взяты из настроек проекта; |
lang | Изменить язык страницы оплаты, передайте параметр "EN" для отображения формы оплаты на английском языке. |
Метод makeDispute
Сообщить о проблеме (создать диспут) по оплате, применимо для p2p платежей, если по каким-либо причинам оплата не была засчитана. Параметры:
project
* обязательно |
ID проекта |
orderID
* обязательно |
ID заказа |
email
* обязательно |
E-mail адрес куда поступит ответ (ваш или плательщика) |
receipt
* обязательно |
Ссылка на файл, чек или скриншот об оплате. Принимаются файлы jpg, png, pdf размером до 15 МБ. |
Метод getOrderInfo
Получить информацию о заказе. Параметры:
project
* обязательно |
ID проекта |
orderID
* обязательно |
ID заказа |
Метод makePayout
Создать запрос на выплату. Параметры:
project
* обязательно |
ID проекта |
direction
* обязательно |
направление (доступные направления отображены в тарифах вашего проекта) |
sum
* обязательно |
сумма выплаты |
purse
* обязательно |
номер кошелька или карты, куда нужно сделать выплату |
innerID | Ваш ID выплаты, на уникальность не проверяется. Любая строка, до 500 символов. Будет отправлен в коллбеке, также доступен поиск по ним. |
e-mail получателя - отобразится у вас в личном кабинете. Если вы передадите невалидный e-mail то API выдаст ошибку | |
comment | Любой комментарий для вашего удобства, отобразится у вас в личном кабинете |
Метод getPayoutInfo
Получить информацию о выплате. Параметры:
project
* обязательно |
ID проекта |
payoutID или innerID
* обязательно |
Можно запросить информацию о выплате, передав параметр payoutID - это ID выплаты в системе Spicy-Cash, который вы получаете при создании выплаты. Также доступен запрос статуса выплаты используя параметр innerID - если вы передаете свои ID при создании выплат, есть возможность искать по ним. ВАЖНО! Для корректного поиска по innerID вам нужно передавать уникальные innerID при создании выплаты. Если у вас есть несколько выплат с одинаковыми innerID - метод getPayoutInfo вернет информацию по одной, последней из них! |
Метод getProjectBalance
Получить баланс проекта. Параметры:
project
* обязательно |
ID проекта |