Поиск по сайту

API
Главная / API - Получение ссылки на оплату

Получение ссылки на оплату

Обновлено 05.04.2024
91 кб

Общие сведения

Сервис позволяет получать ссылки для онлайн-оплаты по накладным.

Получение ссылки на оплату

Запрос метода

Структура запроса

Адрес метода: https://api.dellin.ru/v1/payments/link.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "send":true,
   "request":[
      {  
         "docid":"1",
         "counteragent_type":"physical",
         "counteragent_data":"Иванов Иван Иванович",
         "phone":"+79812223355"
      },
      {  
         "docid":"2",
         "counteragent_type":"juridical",
         "counteragent_data":"1112223333",
         "email":"test@test.ru"
      },
      {  
         "docid":"3",
         "counteragent_uid":"00000000-0000-0000-0000-000000000000",
         "email":"test2@test.ru"
      }
   ]
}

Адрес метода: https://api.dellin.ru/v1/payments/link.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <send>true</send>
   <request>
      <docid>1</docid>
      <counteragent_type>physical</counteragent_type>
      <counteragent_data>Иванов Иван Иванович</counteragent_data>
      <phone>+79812223355</phone>
   </request>
   <request>
      <docid>2</docid>
      <counteragent_type>juridical</counteragent_type>
      <counteragent_data>1112223333</counteragent_data>
      <email>test@test.ru</email>
   </request>
   <request>
      <docid>3</docid>
      <counteragent_uid>00000000-0000-0000-0000-000000000000</counteragent_uid>
      <email>test2@test.ru</email>
   </request>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDНетstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

send

Да
boolean

Согласие на получение электронного чека об оплате.

Доступные значения:

  • "true" - пользователь ввел phone и/или email для отправки чека
  • "false" - пользователь отказался предоставлять контактные данные

request

Да*array of request.Request

Запрос ссылок на оплату по накладным (доступен запрос сразу по нескольким документам).

*Параметр обязателен только при передаче согласия на получение электронного чека об оплате ("send" = "true")

Request.Request
ПараметрR*ТипОписание
docidДаstring

Номер накладной для оплаты (не следует передавать номер заказа)

counteragent_typeДа*string

Тип контрагента-плательщика.

Доступные значения:

  • "juridical" - юр. лицо
  • "physical"- физ. лицо

*Обязательна передача либо параметров "counteragent_type" и "counteragent_data", либо параметра "counteragent_uid"

counteragent_dataДа*string

Данные контрагента:

  • для юр. лица - ИНН
  • для физ. лица - номер телефона или ФИО
  • для плательщика, являющегося анонимным получателем, - номер телефона

*Обязательна передача либо параметров "counteragent_type" и "counteragent_data", либо параметра "counteragent_uid"

counteragent_uidДа*string

Идентификатор КА-плательщика.

*Обязательна передача либо параметров "counteragent_type" и "counteragent_data", либо параметра "counteragent_uid"

phoneДа*string

Номер телефона для отправки чека

*Обязательна передача хотя бы одного из параметров: "phone", "email"

emailДа*object

E-mail адрес для отправки чека

*Обязательна передача хотя бы одного из параметров: "phone", "email"

Ответ метода

Структура ответа

{ 
   "payment_links":[ 
      { 
         "docid":"19-01025000562",
         "link":"https://xxxxxxxxxxxxx.xx/xxxxxxxxxxxxxxxxxx"
      }
   ]
}
<response>
   <payment_links>
      <docid>19-01025000562</docid>
      <link>https://xxxxxxxxxxxxx.xx/xxxxxxxxxxxxxxxxxx</link>
   </payment_links>
</response>

Описание параметров

Response
ПараметрТипОписание
payment_linksarray of Response.Payment_linksМассив ссылок на оплату по накладным

Response.Payment_links
ПараметрТипОписание
docidstringНомер накладной для оплаты
linkstringСсылка для оплаты

Обработка ошибок

Номер ошибкиhttp-кодКраткое описаниеДетальное описание

719001

400Необходимо получить согласиеНеобходимо получить согласие на отправку данных о платеже