For the complete documentation index, see llms.txt. This page is also available as Markdown.

Проверка состояния аккаунта

Проверка статуса аккаунта по username

POST https://agwsapi.tarlanpayments.kz/showcase-gateway/api/v1/user/check

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

username*

String

Идентификатор пользователя

agent*

String

Код витрины в системе Tarlanpayments

project*

String

Код Проекта присваиваемый Tarlanpayments

service_code*

String

Идентификатор услуги на стороне витрины

info

Object

Дополнительные параметры зависящие от категории услуг

{
    "username": "1234AAA05",
    "agent": "agent1",
    "project": "project1",
    "service_code": "123",
    "info": {
        "parking": {
            "in_date": "2024-08-02T12:24:07+05:00",
            "left_free_time_minutes": 0,
            "sum": 118,
            "current_balance": -1,
            "zone": "1223-123",
            "duration":1,
            "coordinates": {
                "latitude": 123.12,
                "longitude": 123.0212
            },
            "phone": "77077777777"
        }
    }
}

Response

Name
Type
Description

status

bool

Статус обработки запроса

status_code

uint

Код ошибки

message

string

Описание ошибки

result

Object

Результат запроса, в котором содержится информация

-error_code

Integer

Код ошибки

-message

String

Описание ошибки

-account_status

Integer

Состояние аккаунта. Подробнее см. в справочнике состояния аккаунта

-amount

Float

Фиксированная сумма платежа

-upper_commission

Float

Верхняя коммиссия

-fail_reason

Object

Причина неуспеха проведения платежа

-info

Object

Дополнительные параметры зависящие от категории услуг

Дополнительные параметры (info)

В теле ответа приходят дополнительные параметры зависящие от категории услуги, тип услуги записывается как ключ в объекте info

param
type
Desc

in_date

timestamp

Время начала парковки

left_free_time_minutes

Float

Кол-во оставшихся минут на выезд

sum

Float

Стоимость парковки

current_balance

Float

Текущий баланс

zone

string

Зона парковки

coordinates

object

Объект с координатами

├latitude

float64

Широта

├longitude

float64

Долгота

duration

uint

Длительность в секундах

phone

string

Номер телефона

param
type
Desc

phone

string

Номер телефона

credit_days

uint

Количество дней для продления кредита

contracts

array

Массив контрактов

├contract_id

string

ID договора

├contract_name

string

Название контракта

├contract_date

string

Дата контракта

├client

string

Имя клиента

├amount

float

Сумма ежемесячного погашения

├total_amount

float

Остаток суммы по кредиту

├min

float

Минимальная сумма погашения

├max

float

Максимальная сумма погашения

param
type
Desc

customer

object

Объяект с информацией о клиенте

├address

string

Адрес клиента

invoice

object

Объект с данными о счете

├invoice_id

string

Уникальный идентификатор счета

├period_date

string

Период счета

├formed_date

string

Дата формирования счета

├expire_date

string

Дата окончания срока оплаты

service

array

Массив сервисов

├fix_sum

float

Фиксированная сумма к оплате

├service_id

string

Идентификатор услуги

├service_name

string

Название сервиса

├measure

string

Единица измерения услуги

├fix_count

float

Фиксированное показание счетчика

├prev_count

float

Предыдущие показания счетчика

├last_count

float

Последние показания счетчика

├debt_sum

float

Сумма задолженности

├debt_info

string

Информация о задолженности

├prev_count_date

string

Дата предыдущих показаний

├last_count_date

string

Дата текущих показаний

├sum

float

Общая сумма

├pay_sum

float

Сумма которую платит клиент

├is_counter_service

bool

Является ли услуга счетчиком (true – да, false – нет)

Примеры ответов об ошибках до внесения изменений

Примеры ответов об ошибках после внесения изменений

Проверка аккаунта

Last updated

Was this helpful?