База знаний BotVsem ⤵

< Все темы
Печать

Счета

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

Как отправить баланс пользователю в сообщении?! Смотрите ЗДЕСЬ

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

https://app.botvsem.ru/api/v1/getContactAccounts

Этот метод позволяет получить список счетов указанного контакта.

Query Parameters

contact_id
REQUIRED
integer

 

ID контакта

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://app.botvsem.ru/api/v1/addContactAccount

Этот метод позволяет создать счет для указанного контакта.

Form Data Parameters

contact_id
REQUIRED
integer

 

ID контакта.

currency
REQUIRED
integer

Трехзначный код валюты в ISO 4217. Пример: USD

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://app.botvsem.ru/api/v1/deleteContactAccount

Этот метод позволяет удалить счет контакта.

Form Data Parameters

account_id
REQUIRED
integer

 

ID счета.

204: No Content
Счет успешно удален
 


422: Unprocessable Entity
Счет не может быть удален, т.к. имеет положительный баланс.
 
{
"errors": {
"account_id": [
"You can not delete the account with a balance of 175 RUB"
]}
}
! Счет может быть удален только если имеет нулевой баланс.

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

https://app.botvsem.ru/api/v1/addFundsToContactAccount

Этот метод позволяет зачислить средства на счет контакта.

Form Data Parameters

account_id
REQUIRED
integer

 

ID счета

amount
REQUIRED
integer

Сумма в минимальной денежной единице. Например для $10 - это 1000

description
REQUIRED
integer

Описание транзакции

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://app.botvsem.ru/api/v1/withdrawFundsFromContactAccount

Этот метод позволяет списать средства со счета контакта.

Form Data Parameters

account_id
REQUIRED
integer

 

ID счета

amount
REQUIRED
integer

Сумма в минимальной денежной единице. Например для $10 - это 1000

description
REQUIRED
integer

Описание транзакции

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"
]}
}
Предыдущая Контакты
Следующая Свободные счета
Оглавление