Как настроить интеграцию с OpenApi?

Чтобы управлять выплатами исполнителям из своего интерфейса, настройте интеграцию по API с сервисом Jump.Finance.

Документация OpenAPI: https://apidoc.jump.finance/openapi-v1

Возможности интеграции:

  • создание исполнителя и редактирование информации о нём
  • создание выплат 
  • формирование чеков ФНС по выплатам самозанятым
  • получение балансов банковских счетов компании
  • управление юрлицами для групп компаний

Что такое ключ OpenAPI и зачем он нужен?

Ключ OpenAPI — это уникальный код, который даёт вашей системе доступ к сервису Jump.Finance. Ключ функционирует как идентификатор, позволяющий Jump определить, кто отправляет запрос, и гарантировать безопасность соединения.

Как получить ключ интеграции OpenAPI?

  1. Откройте в личном кабинете Jump.Finance раздел "Настройки" и перейдите в подраздел "Интеграции"

  2. Активируйте интеграцию OpenAPI, если она не включена

  3. Нажмите на три точки и выберите "Выпусить новый ключ"

  4. Для создания ключа в открывшемся окне нажмите на кнопку "Создать новый"

  5. Вы получили новый ключ-идентификатор. Обязательно сохраните его. Увидеть ключ снова не получится.

Рекомендации для разработчиков 

Документация OpenAPI: https://apidoc.jump.finance/openapi-v1

rate limit — 600 запросов в минуту

Тестирование

Мы не предоставляем песочницу для тестирования. На этапе тестирования рекомендуем один из следующих вариантов: 

  1. Отключить счет в личном кабинете Jump. 
    Для этого перейдите в раздел Настройки – Счета, и отключите счет из списка через переключатель.

  2. Отправлять выплаты созданные по API на ручное подтверждение через личный кабинет. 
    Для этого перейдите в раздел Настройки – Выплаты, и в поле Open API установите галочку «Требующие подтверждения».

Так вы сможете тестово создавать выплаты, но движение средств происходить не будет – для подтверждения необходимо зайти в личный кабинет и подтвердить желаемые выплаты для оплаты. 

Создание исполнителя

При создании исполнителя через метод API /postContractorsStore есть параметр group_id — это необязательно поле. Параметр присваивается автоматически для каждого созданного исполнителя.
Параметр agent id — юрлицо, добавленное в ваш личный кабинет.

Так же у каждого исполнителя есть правовой статус legal_form:

  • {id: 1, title: "Физическое лицо"}
  • {id: 2, title: "Самозанятый"}
  • {id: 3, title: "Индивидуальный предприниматель"}

Порядок вызова методов

Рекомендуем следующий порядок для вызова методов:

1. GET the agent_id from the API "/banks_accounts".
2. CREATE a performer by making a POST request to the API "/contractors".
3. CREATE a payment by making a POST request to the API "/payments".
4. GET the payment details and check the payment status.

Типы реквизитов для метода POST request to the API "/payments".:
type_id: 10 — Выплата по номеру телефона
type_id: 8 — Выплата по номеру карты

Теперь вы можете интегрировать сервис Jump.Finance с вашей системой и начать автоматизацию выплат исполнителям. 

Если у вас возникнут вопросы, обращайтесь в чат технической поддержки в вашем личном кабинете Jump.Finance!

Вернуться назад
Остались вопросы?

Мы всегда на связи и готовы ответить на любой вопрос

Позвоните нам

8 800 234 87 73 Звонок по РФ бесплатный

Техническая поддержка


Связь через мессенджеры


Наши соцсети