Счета

С помощью представленных методов вы можете создавать счета для ваших контактов в рамках ISO 4217, а так же проводить операции по ним - начисление/списание.

Внимание!

Данное API вы используете на свой страх и риск, мы не несем ответственности за сохранность данных созданных вами счетов через представленное API, но приложим все усилия для их сохранности и безопастности. Вы не должны использовать методы API представленные на этой странице, если их использование нарушает законодательство Российской Федерации, Европейского союза и США.

Все счета отображаются в карточке контакта в личном кабинете. Так же по каждому счету ведется журнал операций.

Как отправить баланс пользователю в сообщении:

https://help.watbot.ru/platezhi-v-botakh/popolnenie-balansa-vashikh-klientov-dlya-soversheniya-budushikh-pokupok-v-bote#3-otobrazhenie-balansa

get
Получить список счетов

https://watbot.ru/api/v1/getContactAccounts
Этот метод позволяет получить список счетов указанного контакта.
Request
Response
Request
Query Parameters
contact_id
required
integer
ID контакта
Response
200: OK
Запрос успешно обработан.
{
"data": [
{
"id": 1,
"currency": "USD",
"amount": 17500,
"amount_note": "175 USD",
"created_at": "2019-11-29T13:33:35+00:00",
"updated_at": "2019-11-30T07:08:57+00:00"
}
]
}

post
Создать счет

https://watbot.ru/api/v1/addContactAccount
Этот метод позволяет создать счет для указанного контакта.
Request
Response
Request
Form Data Parameters
contact_id
required
integer
ID контакта.
currency
required
string
Трехзначный код валюты в ISO 4217. Пример: USD
Response
201: Created
Счет успешно создан
{
"data": {
"id": 6,
"currency": "USD",
"amount": 0,
"amount_note": "0 USD",
"created_at": "2019-11-30T14:56:24+00:00",
"updated_at": "2019-11-30T14:56:24+00:00"
}
}
422: Unprocessable Entity
Аккаунт уже существует.
{
"errors": {
"currency": [
"Account with the currency already exists"
]
}
}

post
Удалить счет

https://watbot.ru/api/v1/deleteContactAccount
Этот метод позволяет удалить счет контакта.
Request
Response
Request
Form Data Parameters
account_id
required
integer
ID счета.
Response
204: No Content
Счет успешно удален
422: Unprocessable Entity
Счет не может быть удален, т.к. имеет положительный баланс.
{
"errors": {
"account_id": [
"You can not delete the account with a balance of 175 RUB"
]
}
}

Счет может быть удален только если имеет нулевой баланс.

post
Зачислить сумму на счет

https://watbot.ru/api/v1/addFundsToContactAccount
Этот метод позволяет зачислить средства на счет контакта.
Request
Response
Request
Form Data Parameters
account_id
required
integer
ID счета
amount
required
integer
Сумма в минимальной денежной единице. Например для $10 - это 1000
description
required
string
Описание транзакции
Response
200: OK
Счет успешно пополнен
{
"data": {
"id": 1,
"currency": "USD",
"amount": 117500,
"amount_note": "1175 USD",
"created_at": "2019-11-29T13:33:35+00:00",
"updated_at": "2019-11-30T07:08:57+00:00"
}
}

post
Списать сумму со счета

https://watbot.ru/api/v1/withdrawFundsFromContactAccount
Этот метод позволяет списать средства со счета контакта.
Request
Response
Request
Form Data Parameters
account_id
required
ID счета
amount
required
Сумма в минимальной денежной единице. Например для $10 - это 1000
description
required
Описание транзакции
Response
200: OK
Сумма успешно списана.
{
"data": {
"id": 1,
"currency": "USD",
"amount": 17500,
"amount_note": "175 USD",
"created_at": "2019-11-29T13:33:35+00:00",
"updated_at": "2019-11-30T15:13:46+00:00"
}
}
422: Unprocessable Entity
Недостаточно средств для списания.
{
"errors": {
"account_id": [
"Insufficient funds. Current balance 175 USD"
]
}
}