URL

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

HTTP Metod URL
POST /tokenlink/v1/products

Endpoint принимает application/json и multipart/form-data для загрузки изображения. Успешный запрос возвращает 201 Created.

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

name обязателен и содержит 1–255 символов; description — не более 255 символов. price должен быть положительным и иметь не более двух десятичных знаков, expireDate — будущая дата и время ISO; items принимает не более 250 записей. Ожидаемые параметры, которые будут отправлены в запросах на создание новой ссылки, перечислены в таблице и подзаголовках ниже.

Название параметра Тип Обязательный Объяснение
name string Да Название ссылки
description string Нет Подробное объяснение ссылки. Вы можете использовать его для информирования пользователя на странице оплаты.
price decimal Нет Стоимость платежа, которая можно получить по ссылке. Если продукт не отправлен, пользователь может ввести цену в формате оплаты.
stock number Нет Если в продаете продукт, который есть в наличии, вы можете указать количество продукта на скаладе.
expireDate date Нет Если вы хотите сделать ссылку недействительной после определенной даты, вы можете отправить срок действия ссылки.
enabledInstallments string Нет Вы можете использовать это поле, если хотите получать только указанные вами платежи в рассрочку. Пример: 1,2,3,6
subMerchantIdlongНетПоле subMerchantId текущего контракта TokenPay.
paymentGroupPaymentGroupНетПоле paymentGroup текущего контракта TokenPay.
subMerchantPricedecimalНетПоле subMerchantPrice текущего контракта TokenPay.
conversationIdstringНетПоле conversationId текущего контракта TokenPay.
enabledBanksstringНетПоле enabledBanks текущего контракта TokenPay.
posTypePosBlockageResolveTypeНетПоле posType текущего контракта TokenPay.
externalIdstringНетПоле externalId текущего контракта TokenPay.
subExternalIdstringНетПоле subExternalId текущего контракта TokenPay.
externalProductUniqueIdstringНетПоле externalProductUniqueId текущего контракта TokenPay.
enabledInstForCommercialstringНетПоле enabledInstForCommercial текущего контракта TokenPay.
kvkkUrlstringНетПоле kvkkUrl текущего контракта TokenPay.
paymentDocumentTypestringНетПоле paymentDocumentType текущего контракта TokenPay.
merchantBranchNamestringНетПоле merchantBranchName текущего контракта TokenPay.
paymentPhasePaymentPhaseНетФаза платежа; значение по умолчанию AUTH.
currencyCurrencyНетПоле currency текущего контракта TokenPay.
itemsPaymentItem[]НетРазбивка платежа; не более 250 записей.
languagestringНетПоле language текущего контракта TokenPay.
productSpecificationTypeProductSpecificationTypeНетПоле productSpecificationType текущего контракта TokenPay.
chippinPhoneNumberstringНетПоле chippinPhoneNumber текущего контракта TokenPay.
linkTypeLinkTypeНетПоле linkType текущего контракта TokenPay.
rapidUserIdstringНетПоле rapidUserId текущего контракта TokenPay.
chippinBranchTypestringНетПоле chippinBranchType текущего контракта TokenPay.
merchantUserEmailstringНетПоле merchantUserEmail текущего контракта TokenPay.
customerEmailstringНетПоле customerEmail текущего контракта TokenPay.
customerPhonestringНетПоле customerPhone текущего контракта TokenPay.
autoPostAuthDateCountstringНетПоле autoPostAuthDateCount текущего контракта TokenPay.
exchangePricestringНетПоле exchangePrice текущего контракта TokenPay.
taxNumberstringНетПоле taxNumber текущего контракта TokenPay.
makeReceiptQueryEnabledbooleanНетВключает запрос чека; по умолчанию false.
specificDistributionbooleanНетВключает специальное распределение; по умолчанию false.

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

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

Название параметра Тип Всегда доступен Объяснение
id long Да ID значение ссылки
status Status Да Значение, указывающее статус ссылки. Для активных ссылок отображается как ACTIVE, для пассивных PASSIVE. Ссылка, созданныя после операции создания ссылки, всегда ACTIVE.
token string Да Это 4-значный уникальный код,присвоенный ссылке.
url string Да URL информация ссылки. Вы можете поделиться этой ссылкой и получать деньги от своих пользователей.
qrCodeUrl string Да Ссылка представляет собой ссылку с QR-кодом. Вы можете получить доступ к ссылке для оплаты, отсканировав QR-код.
namestringНетПоле name текущего контракта TokenPay.
descriptionstringНетПоле description текущего контракта TokenPay.
pricedecimalНетПоле price текущего контракта TokenPay.
stockintegerНетПоле stock текущего контракта TokenPay.
soldCountintegerНетПоле soldCount текущего контракта TokenPay.
enabledInstallmentsstringНетПоле enabledInstallments текущего контракта TokenPay.
expireDatedate-timeНетПоле expireDate текущего контракта TokenPay.
paymentIdListlong[]НетИдентификаторы платежей, созданных по ссылке.
paymentPhasePaymentPhaseНетФаза платежа; значение по умолчанию AUTH.

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

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