URL

Ниже приведена информация о endpoint и методе http, использованном для создания ссылки:

HTTP Metod URL
POST /tokenlink/v1/products

Параметры запроса

Ожидаемые параметры, которые будут отправлены в запросах на создание новой ссылки, перечислены в таблице и подзаголовках ниже.

Название параметра Тип Обязательный Объяснение
name string Да Название ссылки
description string Нет Подробное объяснение ссылки. Вы можете использовать его для информирования пользователя на странице оплаты.
price decimal Нет Стоимость платежа, которая можно получить по ссылке. Если продукт не отправлен, пользователь может ввести цену в формате оплаты.
stock number Нет Если в продаете продукт, который есть в наличии, вы можете указать количество продукта на скаладе.
expireDate date Нет Если вы хотите сделать ссылку недействительной после определенной даты, вы можете отправить срок действия ссылки.
enabledInstallments string Нет Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6

Параметры возврата

Параметры, возвращаемые в результате создание ссылки, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:

Название параметра Тип Всегда доступен Объяснение
id long Да ID значение ссылки
status Status Да Значение, указывающее статус ссылки. Для активных ссылок отображается как ACTIVE, для пассивных PASSIVE. Ссылка, созданныя после операции создания ссылки, всегда ACTIVE.
token string Да Это 4-значный уникальный код,присвоенный ссылке.
url string Да URL информация ссылки. Вы можете поделиться этой ссылкой и получать деньги от своих пользователей.
qrCodeUrl string Да Ссылка представляет собой ссылку с QR-кодом. Вы можете получить доступ к ссылке для оплаты, отсканировав QR-код.

Примеры кодов

Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом: