service-api-finance (public) (1.0)

Download OpenAPI specification:Download

Jump.Finance: support@jump.finance URL: https://jump.finance/kontakty

Публичные методы Jump.Finance для такси

Основная информация

Заголовки

В каждом запросе должны быть следующие заголовки:

Accept: application/json
Content-Type: application/json

Авторизация

Для авторизации необходимо передать ключ клиента.

Ключ можно передать двумя способами:

Заголовок (header) - Client-Key
Параметр запроса (query) - client_key

Получить значение для ключа можно в личном кабинете

Authentication

clientKeyHeader

Security Scheme Type	API Key
Header parameter name:	Client-Key

clientKeyQuery

Security Scheme Type	API Key
Query parameter name:	client_key

Справочники

Интеграции

Используется в методах:

получение списка транзакций
получение списка водителей
получение списка платежей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/integrations

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/integrations

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/integrations

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Мостакси24",
"name": "Яндекс.Про"
}
]

Типы транзакций

Используется в методах:

получение списка транзакций
создание транзакции

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/transaction-types

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/transaction-types

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/transaction-types

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Поездки – заработок"
},
{"value": 2,
"title": "Поездки – комиссия"
}
]

Группы водителей

Используется в методах:

получение списка водителей
получение списка платежей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/groups

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/groups

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "По-умолчанию"
},
{"value": 2,
"title": "Доставка 5%"
}
]

Статусы анти-фрода

Используется в методах:

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

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/anti-fraud-statuses

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/anti-fraud-statuses

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/anti-fraud-statuses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Вывод разрешен"
},
{"value": 2,
"title": "Вывод запрещен"
}
]

Юридические лица

Используется в методах:

получение списка платежей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/agents

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/agents

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/agents

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "По-умолчанию"
},
{"value": 2,
"title": "ООО ААА"
}
]

Платежные системы

Используется в методах:

получение списка платежей
обновление профиля водителя

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/payment-systems

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/payment-systems

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/payment-systems

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Банковский счет"
},
{"value": 2,
"title": "Банковская карта по номеру телефона"
}
]

Источник создания выплаты

Используется в методах:

получение списка платежей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/payment-source

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/payment-source

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/payment-source

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Заявка водителя"
},
{"value": 2,
"title": "Ручная заявка парка"
}
]

Статусы платежа

Используется в методах:

получение списка платежей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/payment-statuses

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/payment-statuses

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/payment-statuses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Оплачен"
},
{"value": 2,
"title": "Отклонен"
}
]

Банки в системе быстрых платежей

Используется в методах:

обновление профиля водителя

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Превышен лимит запросов

get/dictionaries/banks

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/banks

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/banks

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 100000000111,
"title": "Сбербанк"
},
{"value": 100000000004,
"title": "Тинькофф Банк"
}
]

Статусы заявок на регистрацию

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/application_statuses

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/application_statuses

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/application_statuses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": "draft",
"title": "Черновик"
},
{"value": "not_filled",
"title": "Не заполнена"
},
{"value": "exchange_error",
"title": "Ошибка от агрегатора"
},
{"value": "not_processed",
"title": "Не обработана"
},
{"value": "register",
"title": "Регистрируется"
},
{"value": "registered",
"title": "Зарегистрирована"
},
{"value": "rejected",
"title": "Отклонена менеджером"
},
{"value": "filled",
"title": "Регистрируется"
}
]

Статусы заданий на регистрацию заявки в агрегаторах

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/aggregator_statuses

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/aggregator_statuses

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/aggregator_statuses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": "new",
"title": "Создана"
},
{"value": "exchange_error",
"title": "Ошибка от агрегатора"
},
{"value": "register",
"title": "Регистрируется"
},
{"value": "registered",
"title": "Зарегистрирована"
},
{"value": "rejected",
"title": "Отклонена менеджером"
}
]

Профессии

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/professions

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/professions

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/professions

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Таксист"
},
{"value": 2,
"title": "Курьер авто/мото"
},
{"value": 3,
"title": "Пеший курьер"
}
]

Направления регистрации

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/directions

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/directions

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/directions

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": 1,
"title": "Такси"
},
{"value": 2,
"title": "Доставка"
},
{"value": 3,
"title": "Пешая доставка"
}
]

Загружаемые документы

1 - Водительское удостоверение
2 - СТС
3 - Разворот паспорта
4 - Страница прописки в паспорте
5 - Селфи с паспортом
6 - Водительское удостоверение (обратная сторона)
7 - СТС (обратная сторона)

Для таксистов и авто курьеров доступны все типы, для пеших курьеров только 3, 4 и 5

Доступность документов определяется по обязательному параметру profession_id

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

profession_id

required

integer

Example: profession_id=1

ID профессии

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/documents

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/documents

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/documents

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"name": 1,
"title": "Водительское удостоверение"
},
{"name": 2,
"title": "СТС"
},
{"name": 3,
"title": "Разворот паспорта"
},
{"name": 4,
"title": "Страница прописки в паспорте"
},
{"name": 5,
"title": "Селфи с паспортом"
},
{"name": 6,
"title": "Водительское удостоверение (обратная сторона)"
},
{"name": 7,
"title": "СТС (обратная сторона)"
}
]

Модули (шаги) для заполнения полной формы

Кем будете работать? - выбор направления регистрации
У вас есть авто? - наличие авто, недоступен при указании в форме регистрации только пеших курьеров
Как будете доставлять? - доступен только для курьеров, шаг определяет направление пешего или авто курьера
Агрегаторы для работы - доступны указанные в форме диспетчерские
О себе - для водителей есть поле разрешения на работу в такси, для пеших курьеров есть поле даты рождения
Водительское удостоверение - недоступен для пеших курьеров
Данные авто - недоступен для пеших курьеров и при отсутствии собственного авто

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/form_modules

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/form_modules

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/form_modules

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": "profession",
"title": "Кем будете работать?"
},
{"value": "is_car_driver",
"title": "У вас есть авто?"
},
{"value": "courier_type",
"title": "Как будете доставлять?"
},
{"value": "integrations",
"title": "Агрегаторы для работы"
},
{"value": "person_info",
"title": "О себе"
},
{"value": "driver_license",
"title": "Водительское удостоверение"
},
{"value": "car",
"title": "Данные авто"
}
]

Типы способа доставки для курьера

Тип способа доставки для курьера

1 - На автомобиле
2 - На мотоцикле
3 - На самокате, велосипеде или пешком

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/courier_types

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/courier_types

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/courier_types

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"title": "На автомобиле",
"value": 1
},
{"title": "На мотоцикле",
"value": 2
},
{"title": "На самокате, велосипеде или пешком",
"value": 3
}
]

Страны для ВУ

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/countries

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/countries

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/countries

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": "rus",
"title": "Россия"
},
{"value": "aze",
"title": "Азербайджан"
}
]

Полный список моделей автомобилей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/models

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/models

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/models

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 1,
"title": "Lada Granta",
"aliases": "гранта",
"mark": 
{"id": 1,
"title": "Lada",
"aliases": "лада"
}
},
{"id": 2,
"title": "Lada Priora",
"aliases": "приора",
"mark": 
{"id": 1,
"title": "Lada",
"aliases": "лада"
}
},
{"id": 7,
"title": "Solaris",
"aliases": "салярис;солярис;соларис;solris",
"mark": 
{"id": 3,
"title": "Hyundai",
"aliases": "хенд;хёнд;хунд;хюнд;hyndai;huyndai;хуйдай;хуедай;hyidai;hundai;solaris;солярись"
}
}
]

Поиск модели автомобилей с автокомплитом

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

required

string >= 2

Example: search=лада

Поиск по марке и модели авто

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/models_search

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/models_search

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/models_search

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 1,
"title": "Lada Granta",
"aliases": "гранта",
"mark": 
{"id": 1,
"title": "Lada",
"aliases": "лада"
}
},
{"id": 2,
"title": "Lada Priora",
"aliases": "приора",
"mark": 
{"id": 1,
"title": "Lada",
"aliases": "лада"
}
},
{"id": 7,
"title": "Solaris",
"aliases": "салярис;солярис;соларис;solris",
"mark": 
{"id": 3,
"title": "Hyundai",
"aliases": "хенд;хёнд;хунд;хюнд;hyndai;huyndai;хуйдай;хуедай;hyidai;hundai;solaris;солярись"
}
}
]

Цвета автомобилей

Authorizations:

clientKeyHeaderclientKeyQuery

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/dictionaries/autoreg/colors

Сервер, v1

https://api.jump.finance/taxi-public/v1/dictionaries/autoreg/colors

Test, v1

http://api.finance.test/taxi-public/v1/dictionaries/autoreg/colors

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 1,
"value": "Красный",
"aliases": "розовый"
},
{"id": 2,
"value": "Синий",
"aliases": "голубой"
}
]

Транзакции

Если не указан период выборки (параметры period_from и period_to), то данные будут за последние 4 недели.

Сортировка доступна по следующим полям

id - ID транзакции
date - дата создания транзакции в базе
integrations - название интеграции
amount - сумма транзакции

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

page	integer <int64> >= 1 Default: 1 Текущая страница
per_page	string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице
order	string Сортировка по полю (-desc, без префикса asc)
period_from	string <ISO8601> Example: period_from= Дата начала периода (включительно)
period_to	string <ISO8601> Example: period_to= Дата окончания периода (включительно)
integration_ids[]	Array of integers Example: integration_ids[]=1,2 Интеграции
transaction_type_ids[]	Array of integers Example: transaction_type_ids[]=1,2 Тип транзакции
driver_ids[]	Array of integers Example: driver_ids[]=1,2 ID водителей

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

422

Ошибка валидации

429

Превышен лимит запросов

get/transactions

Сервер, v1

https://api.jump.finance/taxi-public/v1/transactions

Test, v1

http://api.finance.test/taxi-public/v1/transactions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": 1536914953,
"date": "2023-06-15T07:55:20.000Z",
"description": "Поездка order_82638471 (Поездки – заработок)",
"driver": 
{"id": 1234,
"phone": 79999999999,
"last_name": "Иванов",
"first_name": "Иван",
"full_name": "Иванов Иван Иванович",
"middle_name": "Иванович"
},
"type": 
{"id": 1,
"name": "Поездки – заработок"
},
"integration": 
{"id": 1,
"name": "Мостакси24"
},
"amount": 565,
"payment_id": 1232,
"trip": 
{"date": "2023-06-15T07:55:20.000Z",
"address_from": "пр. Ленинский, 127",
"address_to": "ул. Фрунзе, 21",
"duration": 2586,
"distance": 5078,
"payment_type": 
{"id": 1,
"name": "Наличные"
},
"amount": 
{"order": 565,
"tip": 30,
"cash": 30,
"cashless": 565,
"aggregator_commission": 128.64,
"customer_commission": 22.6,
"total": 413.76
},
"comment": "Данные по поездке могут быть неточными. Обратитесь в Таксовичкоф"
}
}
],
"meta": 
{"total": 6371,
"from": 1,
"to": 20,
"per_page": 20,
"current_page": 1,
"last_page": 319
}
}

Предпросмотр списания

Получение размера комиссии при списании и проверка возможности совершить операцию

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

driver_id

required

integer

Example: 1232

ID водителя

Request Body schema: application/json

amount required	number Сумма
balance_id required	integer ID баланса
include_commission	boolean Nullable Default: false Включать комиссию в сумму заявки

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

422

Ошибка валидации

post/drivers/{driver_id}/transactions-withdraw-preview

Сервер, v1

https://api.jump.finance/taxi-public/v1/drivers/{driver_id}/transactions-withdraw-preview

Test, v1

http://api.finance.test/taxi-public/v1/drivers/{driver_id}/transactions-withdraw-preview

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"amount": 100.1,
"balance_id": 1232,
"include_commission": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"is_valid_amount": false,
"error": "Недостаточно средств на счете",
"commissions": 
{"amount": 400,
"commission": 20.05,
"total": 379.95
}
}
}

Создание транзакции

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

driver_id

required

integer

Example: 1232

ID водителя

Request Body schema: application/json

operation required	any Enum: "withdraw" "deposit" "transfer" Вид транзакции `withdraw` - списать с баланса `deposit` - зачислить на баланс `transfer` - перевести средства с баланса на баланс
amount required	number Сумма
balance_id required	integer ID баланса
target_balance_id	integer Nullable ID баланса для получения перевода (обязателен для operation=`transfer`)
transaction_type_id	integer Nullable ID типа транзакции (обязателен для operation=`withdraw`)
message	string Комментарий
create_payment	boolean Nullable Default: false Создать заявку на выплату
include_commission	boolean Nullable Default: false Включать комиссию в сумму заявки

Responses

204

Запрос выполнился успешно

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

422

Ошибка валидации

put/drivers/{driver_id}/transactions

Сервер, v1

https://api.jump.finance/taxi-public/v1/drivers/{driver_id}/transactions

Test, v1

http://api.finance.test/taxi-public/v1/drivers/{driver_id}/transactions

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"operation": "withdraw",
"transaction_type_id": 14,
"balance_id": 14095751,
"amount": 100,
"message": "Тест списания",
"create_payment": true,
"include_commission": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Водители

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

Сортировка доступна по следующим полям

id - ID водителя
group_id - ID группы
invited_by - ID пригласившего водителя
balance - по суммарному значению баланса

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

page	integer <int64> >= 1 Default: 1 Текущая страница
per_page	string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице
order	string Сортировка по полю (-desc, без префикса asc)
integration_ids[]	Array of integers Example: integration_ids[]=1,2 Интеграции
group_ids[]	Array of integers Example: group_ids[]=1,2 Группы
anti_fraud_status_ids[]	Array of integers Example: anti_fraud_status_ids[]=1,2 Статусы анти-фрода
referrer_ids[]	Array of integers Example: referrer_ids[]=1,2 ID пригласивших водителей
search	string Поиск по ID в системе, ID в агрегаторе, ФИО, номеру телефона

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

422

Ошибка валидации

429

Превышен лимит запросов

get/drivers

Сервер, v1

https://api.jump.finance/taxi-public/v1/drivers

Test, v1

http://api.finance.test/taxi-public/v1/drivers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": 1234,
"phone": 79999999999,
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"full_name": "Иванов Иван Иванович",
"tooltip": 
["У водителя есть изменения в реквизитах"
],
"balance": 100.5,
"group": 
{"id": 23,
"name": "По-умолчанию"
},
"anti_fraud_status": 
{"id": 1,
"name": "Вывод разрешен"
},
"invited_by": 
{"id": 1234,
"phone": 79999999999,
"last_name": "Иванов",
"first_name": "Иван",
"full_name": "Иванов Иван Иванович",
"middle_name": "Иванович"
},
"integrations": 
[
{"id": 1232,
"name": "Мостакси24"
}
],
"in_blacklist": false,
"created_at": "2021-01-18T11:16:59.000Z",
"first_trip_at": "2021-01-18T11:16:59.000Z",
"last_trip_at": "2021-01-18T11:16:59.000Z"
}
],
"meta": 
{"total": 6371,
"from": 1,
"to": 20,
"per_page": 20,
"current_page": 1,
"last_page": 319
}
}

Получение данных профиля

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

driver_id

required

integer

Example: 1232

ID водителя

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Превышен лимит запросов

get/drivers/{driver_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/drivers/{driver_id}

Test, v1

http://api.finance.test/taxi-public/v1/drivers/{driver_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 1232,
"last_name": "Иванов",
"first_name": "Иван",
"second_name": "Иванович",
"status": 1,
"anti_fraud_status": 
{"id": 0,
"name": "string"
},
"withdrawal_forbidden_comment": "Причина блокировки",
"withdraw_blocked_until_at": "2022-09-03T07:51:13.000Z",
"phone": 79999999999,
"agent": 
{"id": 1232,
"name": "ООО ААА"
},
"requisites": 
[
{"id": 1,
"driver_id": 1232,
"type_id": 0,
"account_number": "string",
"additional": 
{"name": "Реквизит #7",
"type_id": 7,
"is_default": true,
"account_number": "40800001111222215232",
"bik": "044525225",
"inn": "0000000000",
"contract_number": "223344",
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"bank_card_payment_type": "Visa"
},
"is_default": true,
"is_removed": false,
"name": "Основной реквизит",
"driver_change_date": "2022-09-03T07:51:13.000Z"
}
],
"allow_types": 
[
{"id": 10,
"title": "Карта банка по номеру телефона",
"slug": "bank_card_by_phone"
}
],
"group": 
{"id": 23,
"name": "По-умолчанию"
},
"park_note": "Примечание",
"park_comment": "Финансовый комментарий",
"referrer_id": 2345,
"invitation_date": "2022-09-03T07:51:13.000Z",
"inn": null,
"license": null,
"contract": 
{"agreements": 
[
{"id": 0,
"name": "string",
"date": "2022-09-03T07:51:13.000Z",
"is_archival": false,
"agent": 
{"id": 1232,
"name": "ООО ААА"
}
}
],
"contract_number": 1232,
"contract_signed_at": "2022-09-03T07:51:13.000Z",
"contract_full_name": "Иванов Иван Иванович",
"email": "ivanov@test.com",
"passport_number": 3131313131,
"passport_issue_date": "2022-09-03T07:51:13.000Z"
},
"vehicle": 
{"vehicle_id": 1232,
"car_license_number": 1231232,
"car_number": "А123АА777",
"mark": "Ford",
"model": "Focus",
"color": "Белый"
},
"cards": 
[
{"id": 1232,
"card_type_id": 123456,
"balance_type_id": 123456,
"balance_name": "Реферальные бонусы",
"card_number": "Яндекс Такси",
"balance": 111.05,
"balance_frozen": 3.15,
"balance_update_time": "2022-09-03T07:51:13.000Z",
"title": null,
"name": "YandexTaxometer",
"name_ru": "Яндекс Такси",
"color_hex": "FFFFFF",
"is_internal": true,
"is_aggregator": false,
"exchange": 
{"id": 1232,
"name": "Интеграция по-умолчанию",
"external_id": "ce9c011f9baec2",
"driver_url": null
}
}
],
"black_list": 
{"status": false,
"comment": "Вывод средств запрещен. Водитель внесен в черный список. Для удаления из списка свяжитесь с поддержкой"
},
"created_at": "2021-01-18T11:16:59.000Z",
"first_trip_at": "2021-01-18T11:16:59.000Z",
"last_trip_at": "2021-01-18T11:16:59.000Z"
}

Изменить водителя

Для создания, редактирования и удаления реквизитов используется один параметр requisites.

Возможны следующие ситуации обработки списка реквизитов:

без изменений - у пользователя нет прав на редактирование реквизитов
создание - для реквизита не передан параметр id
обновление - для существующего реквизита передан параметр id
удаление - реквизит существует в системе, но не был передан в списке параметра requisites

При обновлении существующих реквизитов обновляются только поля name и is_default (только если оно true),

type_id - заполнять обязательно всегда
account_number - не нужно передавать при редактировании

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

driver_id

required

integer

Example: 1232

ID водителя

Request Body schema: application/json

phone	string Номер телефона (со знаком +) не обязателен только если у пользователя нет прав на редактирование номера телефона
group_id required	integer ID группы
anti_fraud_status_id required	integer ID статуса анти-фрода
referrer_id	integer ID пригласившего водителя, если явно указать null, то связь оборвется
last_name required	string Фамилия
first_name required	string Имя
middle_name	string Отчество
license	string Номер водительского удостоверения
email	string E-mail
withdrawal_forbidden_comment	string Комментарий блокировки списаний
park_note	string Финансовый комментарий парка
park_comment	string Комментарий парка
inn	string <ИНН> ИНН
contract_number	string Номер архивного договора
contract_full_name	string ФИО подписанта архивного договора
contract_signed_at	string <ISO8601> Дата подписания архивного договора
passport_number	string Номер паспорта в архивном договоре
passport_issue_date	string <ISO8601> Дата выдачи паспорта в архивном договоре
enable_car_sync	boolean Разрешить синхронизацию автомобиля
car_number	string Номер автомобиля
car_license_number	string Номер разрешения на такси
requisites	Array of objects Набор реквизитов водителя

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

422

Ошибка валидации

patch/drivers/{driver_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/drivers/{driver_id}

Test, v1

http://api.finance.test/taxi-public/v1/drivers/{driver_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"phone": 79999999999,
"group_id": 1,
"anti_fraud_status_id": 1,
"referrer_id": 1233,
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"license": 1122334455,
"email": "ivanov@test.com",
"withdrawal_forbidden_comment": "",
"park_note": "",
"park_comment": "",
"inn": "",
"contract_number": 123,
"contract_full_name": "Иванов Иван Иванович",
"contract_signed_at": "2022-09-03T07:51:13.000Z",
"passport_number": 3131313131,
"passport_issue_date": "2022-09-03T07:51:13.000Z",
"enable_car_sync": false,
"car_number": "А123АА777",
"car_license_number": 1,
"requisites": 
[
{"id": 0,
"type_id": 0,
"name": "Основная карта",
"is_default": true,
"account_number": "string",
"bik": 9611925,
"payment_text": "Перевод собственных средств",
"sbp_bank_id": 100000000004,
"inn": 0,
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"contract_number": 223344
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Платежи

Если не указан период выборки (параметры period_from и period_to), то данные будут за последние 4 недели.

Сортировка доступна по следующим полям

id - ID платежа
created_at - дата создания
updated_at - дата изменения
request_type - ID типа запроса
amount - сумма платежа
amount_paid - сумма к выплате
payment_type - имя счета списания
aggregators - имя интеграции

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

page	integer <int64> >= 1 Default: 1 Текущая страница
per_page	string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице
order	string Сортировка по полю (-desc, без префикса asc)
period_from	string <ISO8601> Example: period_from= Дата начала периода (включительно)
period_to	string <ISO8601> Example: period_to= Дата окончания периода (включительно)
agent_ids	string Example: agent_ids=1,2 ID юридических лиц, строкой через запятую
driver_ids	string Example: driver_ids=1,2 ID водителей, строкой через запятую
group_ids	string Example: group_ids=1,2 ID групп водителей, строкой через запятую
integration_ids	string Example: integration_ids=1,2 ID интеграций, строкой через запятую
payment_status_id	string Example: payment_status_id=1,2 ID статусов платежа, строкой через запятую
pay_type_ids	string Example: pay_type_ids=1,2 ID способов оплаты, строкой через запятую
request_type_ids	string Example: request_type_ids=1,2 ID источника создания выплаты, строкой через запятую
search	string Поиск по ID платежа в системе, ФИО водителя, номеру телефона водителя

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

422

Ошибка валидации

429

Превышен лимит запросов

get/payments

Сервер, v1

https://api.jump.finance/taxi-public/v1/payments

Test, v1

http://api.finance.test/taxi-public/v1/payments

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": 1,
"created_at": "2021-01-18T11:16:59.000Z",
"driver": 
{"id": 1234,
"phone": 79999999999,
"last_name": "Иванов",
"first_name": "Иван",
"full_name": "Иванов Иван Иванович",
"second_name": "Иванович",
"group": 
{"id": 23,
"name": "По-умолчанию"
}
},
"status": 
{"id": 1,
"title": "Ошибка выплаты",
"theme": "danger"
},
"amount": 312.23,
"amount_paid": 312,
"paid_at": "2021-01-18T11:16:59.000Z",
"pay_type": 
{"id": 10,
"title": "Банковская карта по номеру телефона"
},
"integration": 
{"id": 1232,
"name": "Мостакси24"
},
"request_type": 
{"id": 3,
"title": "Автоматическая заявка по периоду"
},
"agent": 
{"id": 1232,
"name": "ООО ААА"
},
"aggregator": 
{"id": 1232,
"title": "Внутренний баланс"
},
"commission": 0.23,
"commission_bank": 0,
"bank_account": 
{"id": 1232,
"name": "Счет 1337",
"balance": 0,
"is_default": false,
"payment_types": 
[
{"id": 26,
"slug": "Tinkoff SBP",
"title": "Банковская карта по номеру телефона"
}
],
"agent": 
{"id": 1232,
"name": "ООО ААА"
}
},
"requisites": 
{"id": 1232,
"title": 79999999999
},
"write_off_account": 
{"id": 1233,
"title": 79998888888
},
"history": 
[
{"date_time": "2021-01-18T11:16:59.000Z",
"action": "Ошибка: Ошибка запроса: Не удалось инициализировать платежную сессию: Терминал не найден."
}
]
}
],
"meta": 
{"total": 6371,
"from": 1,
"to": 20,
"per_page": 20,
"current_page": 1,
"last_page": 319
}
}

Авторегистрация

Получить список заявок

Доступные поля для сортировки

date - по дате создания

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

direction[]	Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры)
search	string Поиск по ФИО и телефону водителя
status[]	Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию
page	integer <int64> >= 1 Default: 1 Текущая страница
per_page	string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице
order	string Сортировка по полю (-desc, без префикса asc)

Responses

200

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/autoreg/applications

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": 1,
"date": "2023-06-15T07:55:20.000Z",
"name": "Сидорова Алиса Сергеевна",
"phone": "+79000000000",
"direction": 
{"id": 1,
"slug": "taxi",
"name": "Такси"
},
"status": 
{"id": 2,
"slug": "register",
"title": "В процессе регистрации"
},
"comment": "Что-то пошло не так...",
"managers": 
["Константинопольский К.К."
]
}
],
"meta": 
{"total": 6371,
"from": 1,
"to": 20,
"per_page": 50,
"current_page": 1,
"last_page": 319
},
"links": 
{"path": "string",
"first_page_url": "string",
"last_page_url": "string",
"next_page_url": "string",
"prev_page_url": "string"
}
}

Пакетное отклонение заявок

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

direction[]	Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры)
search	string Поиск по ФИО и телефону водителя
status[]	Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию

Request Body schema: application/json

is_all required	boolean Применить ко всем заявкам с учетом фильтра если стоит галка “выделить все”, то все id заявок что передаются в ids это исключения и применять изменения нужно ко всем заявкам подходящим под условия фильтрации, кроме них если галка не стоит, то то изменения применяются только к тем id заявок, что переданы в ids
ids	Array of integers Nullable Применить только к выбранным заявкам (смотреть описание is_all)
comment required	string <= 500 characters Причина отклонения
new_status required	string Value: "reject" Новый статус заявки

Responses

204

No Content

400

Неверный запрос

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

patch/autoreg/applications

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"is_all": false,
"ids": 
[1,
2,
3
],
"comment": "Причина отклонения",
"new_status": "reject"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Неверный запрос",
"detail": "Неверный запрос.",
"fields": null,
"code": 400
}
}

Получить количество заявок по статусам

Authorizations:

clientKeyHeaderclientKeyQuery

query Parameters

direction[]	Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры)
search	string Поиск по ФИО и телефону водителя
status[]	Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию

Responses

200

Разбивка по статусам заявок

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

get/autoreg/applications/counts

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/counts

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"not_filled": 1,
"exchange_error": 2,
"not_processed": 3,
"register": 4,
"registered": 5,
"rejected": 6
}
}

Получить данные заявки на регистрацию

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id

required

integer

Example: 1

ID заявки на регистрацию

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

get/autoreg/applications/{application_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"item": 
{"id": 1,
"phone": "+79999999999",
"direction": 
{"id": 1,
"slug": "drivers",
"title": "Такси"
},
"profession": 
{"id": 1,
"name": "Курьер"
},
"person_info": 
{"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"birthdate": "2023-03-28T00:00:00.000Z",
"city": "Москва",
"driver_license_taxi": 4444444,
"files": 
[
{"type_id": 3,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 4,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
},
{"type_id": 5,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/3",
"size": 12345,
"type": "png"
}
],
"comment": "Комментарий пользователя"
},
"is_car_driver": true,
"is_moto_courier": false,
"date": "2023-03-11T13:20:30+03:00",
"driver_license": 
{"country": 
{"value": 100,
"title": "Россия"
},
"number": "1234567890",
"issue_date": "2023-03-28T00:00:00.000Z",
"expiry_date": "2033-03-28T00:00:00.000Z",
"expiry_date_unlimited": false,
"total_since_date": "2023-03-28T00:00:00.000Z",
"files": 
[
{"type_id": 1,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 1,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
}
]
},
"car": 
{"model": 
{"id": 1,
"name": "Hyundai Solaris"
},
"color": 
{"id": 1,
"name": "белый"
},
"year": 2022,
"number": "а000аа000",
"license": "00АА000000",
"vin": "А00000000А0000000",
"no_vin": false,
"files": 
[
{"type_id": 2,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 2,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
}
]
},
"status": 
{"id": 2,
"slug": "register",
"title": "В процессе регистрации"
},
"integrations": 
[
{"aggregator_id": 6,
"name": "Яндекс.Про",
"application_integrations": 
[
{"id": 2,
"integration_id": 6,
"name": "Новосибирск",
"manager": 
{"id": 123,
"name": "Константинопольский К.К."
},
"status": 
{"id": 4,
"slug": "exchange_error",
"name": "Ошибка от агрегатора"
},
"comment": "Текст причины отклонения от агрегатора",
"group": 
{"id": 23,
"name": "По умолчанию"
}
}
]
}
],
"is_editable": 
["integrations"
],
"referrer": "2222",
"history": 
[
{"id": 123,
"name": "Константинопольский К.К.",
"changes": 
[
{"integrations": 
[
{"aggregator_id": 6,
"application_integrations": 
[
{"id": 16,
"integration_id": 6,
"status": 
{"id": 4,
"name": "В процессе регистрации"
}
}
],
"comment": "Текст причины отклонения от агрегатора"
}
]
}
]
}
]
}
}

Редактирование данных заявки при модерации

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id

required

integer

Example: 1

ID заявки на регистрацию

Request Body schema: application/json

Any of

object
object
object
object
object
object
object

profession

integer

ID профессии

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

423

Заблокировано

429

Слишком много запросов

patch/autoreg/applications/{application_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"profession": 1
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"item": 
{"id": 1,
"phone": "+79999999999",
"direction": 
{"id": 1,
"slug": "drivers",
"title": "Такси"
},
"profession": 
{"id": 1,
"name": "Курьер"
},
"person_info": 
{"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"birthdate": "2023-03-28T00:00:00.000Z",
"city": "Москва",
"driver_license_taxi": 4444444,
"files": 
[
{"type_id": 3,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 4,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
},
{"type_id": 5,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/3",
"size": 12345,
"type": "png"
}
],
"comment": "Комментарий пользователя"
},
"is_car_driver": true,
"is_moto_courier": false,
"date": "2023-03-11T13:20:30+03:00",
"driver_license": 
{"country": 
{"value": 100,
"title": "Россия"
},
"number": "1234567890",
"issue_date": "2023-03-28T00:00:00.000Z",
"expiry_date": "2033-03-28T00:00:00.000Z",
"expiry_date_unlimited": false,
"total_since_date": "2023-03-28T00:00:00.000Z",
"files": 
[
{"type_id": 1,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 1,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
}
]
},
"car": 
{"model": 
{"id": 1,
"name": "Hyundai Solaris"
},
"color": 
{"id": 1,
"name": "белый"
},
"year": 2022,
"number": "а000аа000",
"license": "00АА000000",
"vin": "А00000000А0000000",
"no_vin": false,
"files": 
[
{"type_id": 2,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
},
{"type_id": 2,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/2",
"size": 12345,
"type": "png"
}
]
},
"status": 
{"id": 2,
"slug": "register",
"title": "В процессе регистрации"
},
"integrations": 
[
{"aggregator_id": 6,
"name": "Яндекс.Про",
"application_integrations": 
[
{"id": 2,
"integration_id": 6,
"name": "Новосибирск",
"manager": 
{"id": 123,
"name": "Константинопольский К.К."
},
"status": 
{"id": 4,
"slug": "exchange_error",
"name": "Ошибка от агрегатора"
},
"comment": "Текст причины отклонения от агрегатора",
"group": 
{"id": 23,
"name": "По умолчанию"
}
}
]
}
],
"is_editable": 
["integrations"
],
"referrer": "2222",
"history": 
[
{"id": 123,
"name": "Константинопольский К.К.",
"changes": 
[
{"integrations": 
[
{"aggregator_id": 6,
"application_integrations": 
[
{"id": 16,
"integration_id": 6,
"status": 
{"id": 4,
"name": "В процессе регистрации"
}
}
],
"comment": "Текст причины отклонения от агрегатора"
}
]
}
]
}
]
}
}

Отклонение заявки

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id

required

integer

Example: 1

ID заявки на регистрацию

Request Body schema: application/json

comment

string <= 500 characters

Причина отклонения

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

delete/autoreg/applications/{application_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"comment": "Причина отклонения"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Регистрация заявки через указанную интеграцию

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id

required

integer

Example: 1

ID заявки на регистрацию

Request Body schema: application/json

integration_id

integer

ID интеграции Значение id из справочника GET /dictionaries/integrations

Responses

201

Created

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

423

Заблокировано

429

Слишком много запросов

post/autoreg/applications/{application_id}/integrations

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/integrations

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/integrations

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"integration_id": 111
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"application_integration_id": 111
}
}

Получение регистрации пользователя через конкретную интеграцию

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id required	integer Example: 1 ID заявки на регистрацию
application_integration_id required	integer Example: 1 ID регистрации пользователя через конкретную интеграцию

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

get/autoreg/applications/{application_id}/integrations/{application_integration_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"item": 
{"aggregator_id": 6,
"name": "Яндекс.Про",
"application_integrations": 
[
{"id": 2,
"integration_id": 6,
"name": "Новосибирск",
"manager": 
{"id": 123,
"name": "Константинопольский К.К."
},
"status": 
{"id": 4,
"slug": "exchange_error",
"name": "Ошибка от агрегатора"
},
"comment": "Текст причины отклонения от агрегатора",
"group": 
{"id": 23,
"name": "По умолчанию"
}
}
]
}
}

Зарегистрировать пользователя через конкретную интеграцию после модерации заявки

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id required	integer Example: 1 ID заявки на регистрацию
application_integration_id required	integer Example: 1 ID регистрации пользователя через конкретную интеграцию

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

423

Заблокировано

429

Слишком много запросов

patch/autoreg/applications/{application_id}/integrations/{application_integration_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Отклонить заявку пользователя на регистрацию через конкретную интеграцию

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id required	integer Example: 1 ID заявки на регистрацию
application_integration_id required	integer Example: 1 ID регистрации пользователя через конкретную интеграцию

Request Body schema: application/json

comment

string <= 500 characters

Причина отклонения

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

423

Заблокировано

429

Слишком много запросов

delete/autoreg/applications/{application_id}/integrations/{application_integration_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/integrations/{application_integration_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"comment": "Причина отклонения"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Загрузка файла

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id

required

integer

Example: 1

ID заявки на регистрацию

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

201

Created

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

post/autoreg/applications/{application_id}/files

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/files

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/files

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"id": 1,
"url": "https://kapi.jump.finance/autoregistration/v1/applications/1/files/1",
"size": 12345,
"type": "png"
}
}

Получить содержимое файла

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

application_id required	integer Example: 1 ID заявки на регистрацию
file_id required	integer Example: 1 ID файла для скачивания

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

get/autoreg/applications/{application_id}/files/{file_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/applications/{application_id}/files/{file_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/applications/{application_id}/files/{file_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Вебхуки авторегистрации

Создать подписку на события изменения заявок

Authorizations:

clientKeyHeaderclientKeyQuery

Request Body schema: application/json

url required	string Ссылка на обработчик запроса со стороны клиента
method required	string Http метод, через который нужно отправлять запрос, по умолчанию post
token required	string API токен, с которым будут выполняться запросы

Responses

201

Created

401

Ошибка авторизации

403

Нет доступа к ресурсу

429

Слишком много запросов

Callbacks

postДанные по заявке при создании или изменении

post/autoreg/webhooks

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/webhooks

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/webhooks

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"url": "https://test.ru/action",
"method": "POST",
"token": "ba7d29f5255c48ed99501ae6ecc49e1e"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"webhook_id": 1
}
}

Callback payload samples

Callback

POST: Данные по заявке при создании или изменении

Content type

application/json

Copy

Expand all Collapse all


{"action": "new_application",
"item": 
{"id": 1,
"phone": "+79999999999"
},
"updated_at": "2023-03-11T13:20:30+03:00"
}

Получить данные подписки на события изменения заявок

Получение данных подписки на события изменения заявок

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

webhook_id

required

integer

Example: 1

ID подписки на события

Responses

200

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

get/autoreg/webhooks/{webhook_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/webhooks/{webhook_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/webhooks/{webhook_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"item": 
{"id": 1,
"url": "https://test.ru/action",
"method": "POST",
"token": "ba7d29f5255c48ed99501ae6ecc49e1e"
}
}

Редактирование подписки на события изменения заявок

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

webhook_id

required

integer

Example: 1

ID подписки на события

Request Body schema: application/json

Any of

object
object
object

url	string Ссылка на обработчик запроса со стороны клиента

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

patch/autoreg/webhooks/{webhook_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/webhooks/{webhook_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/webhooks/{webhook_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"token": "ba7d29f5255c48ed99501ae6ecc49e1e",
"url": "https://test.ru/action",
"method": "POST"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}

Удаление подписки на события изменения заявок

Authorizations:

clientKeyHeaderclientKeyQuery

path Parameters

webhook_id

required

integer

Example: 1

ID подписки на события

Responses

204

No Content

401

Ошибка авторизации

403

Нет доступа к ресурсу

404

Ресурс не найден

429

Слишком много запросов

delete/autoreg/webhooks/{webhook_id}

Сервер, v1

https://api.jump.finance/taxi-public/v1/autoreg/webhooks/{webhook_id}

Test, v1

http://api.finance.test/taxi-public/v1/autoreg/webhooks/{webhook_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": 
{"title": "Ошибка авторизации",
"detail": "Требуется авторизация",
"fields": null,
"code": 401
}
}