Ниже приведена информация о endpoint и методе http, используемом для запроса ссылки:
| HTTP Metod | URL | URL параметры |
|---|---|---|
GET |
/tokenlink/v1/products/:id |
id: ID значение ссылки |
Параметры, возвращаемые в результате запроса ссылки, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:
| Название параметра | Тип | Всегда доступен | Объяснение |
|---|---|---|---|
id |
long |
Да | ID значение ссылки |
status |
Status |
Да | Значение, показывающее статус ссылки. Для активных ссылок отображается как ACTIVE, для пассивных PASSIVE. Ссылка, созданныя после операции создания ссылки, всегда ACTIVE. |
name |
string |
Да | Название, присвоенное ссылке |
description |
string |
Нет | Подробное объяснение ссылки. Вы можете использовать его для информирования пользователя на странице оплаты. |
price |
decimal |
Нет | Стоимость платежа, которая можно получить по ссылке. Если продукт не отправлен, пользователь может ввести цену в форме оплаты. |
stock |
number |
Нет | Если вы продаете продукт, который есть в наличии, вы можете указать количество товара на складе. |
soldCount |
number |
Да | Он показывает, сколько раз была произведена оплата по ссылке. |
enabledInstallments |
string |
Нет | Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6 |
expireDate |
date |
Нет | Срок действия ссылки. |
token |
string |
Да | Это 4-значный уникальный ключ, присвоенный ссылке. |
url |
string |
Да | URL информация ссылки. Вы можете поделиться этой ссылкой и получать деньги от своих пользователей. |
qrCodeUrl |
string |
Да | Ссылка представляет собой ссылку с QR-кодом. Вы можете получить доступ к ссылке для оплаты, отсканировав QR-код. |
Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом: