service-api-finance (public) (1.0)

Download OpenAPI specification:Download

Публичные методы 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

Справочники

Справочники

Интеграции

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

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

Responses

200

Ok

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
[
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

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
[
  • {
    },
  • {
    }
]

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

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

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

Responses

200

Ok

400

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

401

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

403

Не