Запуск оплаты счета

Обновлено 14 февраля 2025

POST

/invoices/{invoice_id}

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

Запрос

Path Parameters

invoice_id

string

required

ID счета

• application/json

Body

Информация о платежном инструменте

user_id object

oneOf

• partner_client_id
• user_uid
• encrypted_sub_id
• partner_client_sub_id

partner_client_id

string

required

Внешний идентификатор клиента партнера

user_uid

string

required

Внутренний идентификатор пользователя в приложении

encrypted_sub_id

string

required

Зашифрованный sub_id пользователя

partner_client_sub_id

string

required

Внешний идентификатор sub-а клиента партнера

operations object[]
Array [
operation
string
Возможные значения: [payment, prepare_payment, payment_loyalty_points]
Тип операции
code
string
Возможные значения: [new, card, QR, app2sbol, invoice, applestore, googleplay, applepay, googlepay]
Сервисный код операции, зависит от типа операции.
Для operation=payment указывается вариант оплаты, выбранный клиентом, например, card.
Для operation=payment_loyalty_points указывается код бонусной программы, например sbrf_spasibo.
value
string
Значение, соответствующее сервисному коду.
Для operation=payment указывается идентификатор, например, для card указывается ID выбранной карты.
Для operation=payment_loyalty_points сумма бонусных баллов, которая должна быть использована при совершении операции. Указывается в копейках, без разделителя. Например, 123 балла 50 копеек = 12350
]
device_info object

Информация об устройстве

device_platform_type

string

Наименование операционной системы устройства

device_platform_version

string

Версия операционной системы устройства

device_model

string

Модель устройства

device_manufacturer

string

Производитель устройства

device_id

string

Серийный номер устройства

surface

string

Поверхность

surface_version

string

Версия ПО

return_url

string

URL, на который требуется переадресовать пользователя в случае успешной оплаты.

Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru). Указывается либо return_url, либо return_deeplink

fail_url

string

URL, на который требуется переадресовать пользователя в случае неуспешной оплаты.

Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru).

return_deeplink

string

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

Указывается либо return_url, либо return_deeplink

Ответы

• 200
• 400
• 401
• default

Статус счета, в зависимости от статуса варианты оплаты

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

form_url

string

URL платежной формы, на который надо переадресовать клиента

deeplink

string

Deeplink, на который надо переадресовать клиента для оплаты в мобильном приложении

product object

Информация по продукту для оплаты счета в apple/google

provider

string

Возможные значения: [applestore, googleplay]

Платежная система

product_code

string

Идентификатор продукта в платежной системе

quantity

number

Количественные характеристики продукта

user_uid object

user_uid

string

required

Внутренний идентификатор пользователя в приложении

params object[]

Дополнительные параметры, уточняющие товарную позицию

Array [

key

string

required

Название параметра

value

string

required

Значение параметра

]

inapp_type

string

Тип продукта

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  },
  "form_url": "https://3dsec.sberbank.ru/payment/merchants/test/payment_ru.html?mdOrder=70906e55-7114-41d6-8332-4609dc6590f4",
  "deeplink": "sberbankonline://connect?addcard",
  "product": {
    "provider": "applestore",
    "product_code": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "quantity": 1.5,
    "user_uid": {
      "user_uid": "d43f2eb6-f299-439b-8a3b-43b114531f0d"
    },
    "params": [
      {
        "key": "packageName",
        "value": "com.MashaAndTheBear.HairSalon"
      }
    ],
    "inapp_type": "consumable"
  }
}

bad input parameter

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Access token is missing or invalid

Unexpected error

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Loading...

Loading...