База знаний CleverApp ⤵

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

Свободные счета

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

Свободные счета

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

https://app.cleverapp.pro/api/v1/getContactCryptoAccounts
!Как правильно сформировать запрос?! Смотрим в основах

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

Query Parameters

contact_id
REQUIRED
integer

 

ID контакта

200: OK
Запрос успешно обработан.
{
"data": [
{
"id": 2,
"currency": "BTC",
"amount": "0.24624642624",
"created_at": "2019-12-24T11:19:42+00:00",
"updated_at": "2019-12-24T11:21:57+00:00"
}
]}

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

https://app.cleverapp.pro/api/v1/addContactCryptoAccount

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

Form Data Parameters

contact_id
REQUIRED
integer

ID контакта.

currency
REQUIRED
integer

 

Код валюты. Пример: BTC

200: OK
Счет успешно создан
 
{
"data": {
"id": 2,
"currency": "BTC",
"amount": 0,
"created_at": "2019-12-24T11:19:42+00:00",
"updated_at": "2019-12-24T11:19:42+00:00"
}
}
 
422: Unprocessable Entity
Аккаунт уже существует.
 
{
"errors": {
"currency": [
"Account with the currency already exists"
]}
}

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

https://app.cleverapp.pro/api/v1/deleteContactCryptoAccount

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

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 0.24624642624 BTC"
]}
}

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

https://app.cleverapp.pro/api/v1/addFundsToContactCryptoAccount

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

Form Data Parameters

account_id
REQUIRED
integer

 

ID счета

amount
REQUIRED
number

 

Сумма 

description
REQUIRED
string

 

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

200: OK
Счет успешно пополнен
 
{
"data": {
"id": 2,
"currency": "BTC",
"amount": 0.34624642624,
"created_at": "2019-12-24T11:19:42+00:00",
"updated_at": "2019-12-24T11:20:18+00:00"
}
}

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

https://app.cleverapp.pro/api/v1/withdrawFundsFromContactCryptoAccount

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

Form Data Parameters

account_id
REQUIRED
integer

 

ID счета

amount
REQUIRED
number

 

Сумма 

description
REQUIRED
string

 

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

200: OK
Счет успешно списана
 
{
"data": {
"id": 2,
"currency": "BTC",
"amount": 0.24624642624,
"created_at": "2019-12-24T11:19:42+00:00",
"updated_at": "2019-12-24T11:21:35+00:00"
}
}

422: Unprocessable Entity
Недостаточно средств для списания.
 
{
"errors": {
"account_id": [
"Insufficient funds. Current balance 0.24624642624 BTC"
]}
}
Оглавление