Отличия API Платежного сервиса и платежного шлюза
API Платежного сервиса сделано похожим на стандартное API платежных шлюзов банков, однако в некоторых методах могут различаться тип, обязательность и наличие полей. Ниже перечислены известные отличия API Платежного сервиса от API банков. Знаком ⚠️ отмечены критичные отличия.
decline.do
В API Платежного сервиса: decline.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
merchantLogin |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
language |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. |
|---|---|---|---|---|---|
errorMessage |
String | Да | errorMessage |
String | Нет |
deposit.do
В API Платежного сервиса: deposit.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
currency |
String [3] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
jsonParams |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
itemPrice |
Integer [1..18] | Нет | itemPrice |
integer | Да | В API банка параметр необязательный, в Платежном сервисе - обязательный. |
depositedItemAmount |
Integer [1..18] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
| - | - | - | agentInterestsObject |
Object | Нет | Поле поддерживается только Платежным сервисом |
tax |
Object | Нет | tax |
Object | Условие | В Платежном сервисе параметр условный, в API банка необязательный. |
taxSum |
Integer | Да | taxSum |
number | Нет | Параметр не является обязательным в Платежном сервисе. |
nomenclature |
Integer [1..93] | Условие | nomenclature |
- | Нет | В Платежном сервисе параметр не обязательный, в API банка - условный. |
markQuantity |
object | Нет | - | - | - | Поле не поддерживается Платежным сервисом. |
type |
Integer | Да | agent_info.type |
Integer | Условие | В API банка обязательный параметр, в Платежном сервисе - условие. |
supplier_info |
Object | Нет | - | - | - | Разная структура параметра itemAttributes
|
agentInfoObject |
Object | Нет | - | - | - | Разная структура параметра itemAttributes. |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
errorCode |
String | Нет | errorCode |
String | да | Отличается обязательность |
finish3dsPayment.do
В API Платежного сервиса: finish3dsPayment.do
Тело запроса не отличается
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
redirect |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
errorCode |
String | Нет | errorCode |
String | да | Отличается обязательность |
finish3dsVer2Payment.do
В API Платежного сервиса: finish3dsVer2Payment.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
| - | - | - | mdOrder |
String | Нет | Параметр поддерживается только в Платежном сервисе |
| - | - | - | threeDSVer2FinishUrl |
String | Нет | Параметр поддерживается только в Платежном сервисе |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
redirect |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
errorCode |
String | нет | errorCode |
String | да | Отличается обязательность |
is3DSVer2 |
Boolean | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
getBindings.do
В API Платежного сервиса: getBindings.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
language |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
errorCode |
String | да | errorCode |
String | ⚠️нет | Отличается обязательность |
| - | - | - | bankName |
String | Нет | Параметр присутствует только в Платежном сервисе. Особенность Платежного сервиса. |
bindingCategory |
String | нет | ⚠️bindingType
|
String | нет | Отличается название параметра |
| - | - | - | gwId |
String | нет | Параметр присутствует только в Платежном сервисе. Особенность Платежного сервиса. |
сlientId |
String | Нет | clientId |
String | Да | В API банка параметр необязателен, в Платежном сервисе - обязательный. |
getOrderStatusExtended.do
В API Платежного сервиса: getOrderStatusExtended.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
userName |
String [1..30] | Условие | userName |
String | Да | В API банка параметр является условным, в Платежном сервисе обязательным. |
password |
String [1..30] | Условие | password |
String | Да | В API банка параметр является условным, в Платежном сервисе обязательным. |
token |
String [1..256] | Условие | - | - | - | Параметр не поддерживается Платежным сервисом. |
merchantLogin |
String [1..255] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
Ответ
getReceiptStatus.do
В API Платежного сервиса: getReceiptStatus.do
Структура запроса на отличается.
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
errorCode |
String [1..2] | Нет | errorCode |
String | Да | В Платежном сервисе параметр обязателен, в API банка - нет. |
orderNumber |
String [1..36] | Нет | orderNumber |
String | Да | В Платежном сервисе параметр обязателен, в API банка - нет. |
orderId |
String [1..36] | Нет | orderId |
String | Да | В Платежном сервисе параметр обязателен, в API банка - нет. |
ofdOrderBundle |
Object | Нет | ofd_order_bundle |
Array[Object] | Нет | Параметры имеют разные наименования. Разная структура вложенности. |
installmentPayment.do
В API Платежного сервиса: installmentPayment.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
additionalParameters |
Object | нет | ⚠️jsonParams
|
Object | нет | Разное наименование параметра |
| - | - | - | clientId |
String | ⚠️да | Дополнительный обязательный параметр |
| - | - | - | phone |
String | Нет | Параметр поддерживается только в Платежном сервисе |
| - | - | - | email |
String | Нет | Параметр поддерживается только в Платежном сервисе |
token |
String | Условие | - | - | - | Параметр не поддерживается в Платежном сервисе |
userName |
String | Условие | userName |
String | Да | Параметр обязательный в Платежном сервисе и условно-обязательный в API банка. |
password |
String | Условие | password |
String | Да | Параметр обязательный в Платежном сервисе и условно-обязательный в API банка. |
autocompletionDate |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
autoReverseDate |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
features |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
billingPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
preOrderPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
orderPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
billingAndShippingAddressMatchIndicator |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
Ответ
instantPayment.do
В API Платежного сервиса: instantPayment.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
autocompletionDate |
String | Нет | - | - | Параметр не поддерживается в Платежном сервисе | |
billingAndShippingAddressMatchIndicator |
String | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
cardHolderName |
String | нет | ⚠️cardholderName
|
String | нет | Разное наименование параметра |
expirationDate |
String | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
externalScaExemptionIndicator |
String | Нет | - | - | Параметр не поддерживается в Платежном сервисе | |
orderPayerData |
Object | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
originalPaymentDate |
String | Условие | - | - | Параметр не поддерживается в Платежном сервисе | |
originalPaymentNetRefNum |
String | Условие | - | - | Параметр не поддерживается в Платежном сервисе | |
| - | - | phone |
String | нет | Параметр поддерживается только в Платежном сервисе | |
preOrderPayerData |
Object | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
sbpTemplateId |
String | Условие | - | - | Параметр не поддерживается в Платежном сервисе | |
sessionTimeoutSecs |
Number | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
shippingPayerData |
Object | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
threeDSProtocolVersion |
Number | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
threeDSSDK |
Boolean | Нет | - | - | Параметр не поддерживается в Платежном сервисе | |
token |
String | Условие | - | - | Параметр не поддерживается в Платежном сервисе | |
userName |
String | Условие | userName |
String | Да | Параметр обязательный в Платежном сервисе и условно-обязательный в API банка. |
password |
String | Условие | password |
String | Да | Параметр обязательный в Платежном сервисе и условно-обязательный в API банка. |
orderNumber |
String | Условие | orderNumber |
String | Да | Параметр обязательный в Платежном сервисе, условно обязательный в API банка |
Ответ
paymentOrder.do
В API Платежного сервиса: paymentOrder.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
TEXT |
String | да | ⚠️cardholderName
|
String | нет | Разное наименование параметра |
$CVC |
Number | нет | ⚠️cvc
|
String | нет | Разное наименование параметра |
language |
String | да | language |
String | нет | |
MDORDER |
String | да | ⚠️mdOrder
|
String | да | Разное наименование параметра |
MM |
Number | нет | ⚠️month
|
String | нет | Разное наименование параметра |
$PAN |
Number | нет | ⚠️pan
|
String | нет | Разное наименование параметра |
YYYY |
Number | нет | ⚠️year
|
String | нет | Разное наименование параметра |
$EXPIRY |
Integer | Условие | - | - | - | Параметр не поддерживается в Платежном сервисе. |
shippingPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
preOrderPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
orderPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
billingAndShippingAddressMatchIndicator |
String[1] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
clientBrowserInfo |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
acsInIFrame |
Boolean | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
threeDSMethodURLServerDirect |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
| - | - | - | mdOrder |
String | да | Параметр поддерживается только в Платежном сервисе |
| - | - | - | transactionState |
String | нет | Параметр поддерживается только в Платежном сервисе |
paymentOrderBinding.do
В API Платежного сервиса: paymentOrderBinding.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
threeDSSDK |
Boolean | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
tii |
String | Да | tii |
String | Нет | В API банка параметр обязательный, в Платежном сервисе - нет. |
email |
String [1..40] | Условие | email |
String | Нет | В API банка параметр условный, в Платежном сервисе - нет. |
threeDSProtocolVersion |
Number | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
externalScaExemptionIndicator |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
seToken |
String | Условие | - | - | - | Параметр не поддерживается в Платежном сервисе. |
clientBrowserInfo |
Object | Optional | - | - | - | Параметр не поддерживается в Платежном сервисе. |
acsInIFrame |
boolean | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
| - | - | - | threeDSMethodNotificationUrl |
String | Нет | Параметр не поддерживается API банка. |
| - | - | - | threeDSServerTransId |
String | Нет | Параметр не поддерживается API банка. |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
threeDSMethodURLServerDirect |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
| - | - | - | mdOrder |
String | да | Параметр поддерживается только в Платежном сервисе |
| - | - | - | transactionState |
String | нет | Параметр поддерживается только в Платежном сервисе |
recurrentPayment.do
В API Платежного сервиса: recurrentPayment.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
feeInput |
- | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
additionalParameters |
Object | нет | ⚠️jsonParams
|
Object | нет | Разное наименование параметра |
billingAndShippingAddressMatchIndicator |
String | нет | - | - | Параметр не поддерживается в Платежном сервисе | |
orderPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
preOrderPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
shippingPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
| - | - | - | email |
String | нет | Параметр поддерживается только в Платежном сервисе |
| - | - | - | phone |
String | нет | Параметр поддерживается только в Платежном сервисе |
preAuth |
Boolean | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
autocompletionDate |
String[19] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
autoReverseDate |
String[19] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
features |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
billingPayerData |
Object | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
Ответ
refund.do
В API Платежного сервиса: refund.do
Структура ответа не отличается
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
amount |
Number | да | amount |
Number | нет | Если сумма не указана - возврат на полную сумму |
language |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
orderId |
String | да | orderId |
String | нет | Платежный сервис Роутер может принимать orderNumber вместо orderId
|
| - | - | - | orderNumber |
String | нет | Параметр поддерживается только в Платежном сервисе |
expectedDepositedAmount |
Integer [1..12] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
currency |
String [3] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
register.do / registerPreAuth.do
В API Платежного сервиса: register.do / registerPreAuth.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
| - | - | - | allowedPaymentWays |
Array[String] | нет | Параметр поддерживается только в Платежном сервисе |
| - | - | - | defaultBindingId |
String | нет | Параметр поддерживается только в Платежном сервисе |
billingAndShippingAddressMatchIndicator |
String | нет | - | - | - | |
billingPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
expirationDate |
UTC | нет | - | - | - | Параметр не поддерживается в Платежном сервисе. Доступен только sessionTimeoutSecs |
feeInput |
Number | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
orderPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
preOrderPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
prepaymentMdOrder |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
shippingPayerData |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
taxSystem |
Number | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
token |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
| - | - | - | orderNumber |
String | нет | Параметр присутствует только в Платежном сервисе |
reverse.do
В API Платежного сервиса: reverse.do
Структура ответа не отличается.
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
orderId |
String | да | orderId |
String | нет | Платежный сервис Роутер может принимать orderNumber вместо orderId
|
jsonParams |
Object | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
language |
String | нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
sbp_c2b/get.do
В API Платежного сервиса: sbp_c2b/get.do
Структура ответа не отличается.
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
memberId |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
tspMerchantId |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе |
account |
String | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
redirectUrl |
String [1..1024] | Нет | - | - | - | Параметр не поддерживается в Платежном сервисе. |
unBindCard.do
В API Платежного сервиса: unBindCard.do
Структура запроса не отличается.
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
| - | - | - | qwId |
String | Условие | Параметр поддерживается только в Платежном сервисе. |
| - | - | - | bindingId |
String | Нет | Параметр поддерживается только в Платежном сервисе. |
sbp_c2b/status.do
В API Платежного сервиса: sbp_c2b/status.do
Структура запроса не отличается.
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
errorCode |
String | Нет | errorCode |
String | Да | Параметр в API банка не обязательный, в Платежном сервисе - обязательный. |
status |
String | Нет | qrStatus |
String | Нет | Отличается название параметров. |
| - | - | - | transactionStateExtension |
String | Нет | Параметр поддерживается только Платежным сервисом. |
sbp_c2b/reject.do
В API Платежного сервиса: sbp_c2b/reject.do
Структура запроса не отличается.
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
errorCode |
String | Нет | errorCode |
String | Да | Параметр в API банка не обязательный, в Платежном сервисе - обязательный. |
rejected |
Boolean | Да | rejected |
Boolean | Нет | Параметр в API банка обязательный, в Платежном сервисе - не обязательный. |
sbp_c2b/unBind.do
В API Платежного сервиса: sbp_c2b/unBind.do
Запрос
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
bindingId |
String [1..255] | Нет | bindingId |
String | Да | Параметр обязательный только в Платежном сервисе. |
Ответ
| Стандартное API банка | Тип | Обяз. | API Платежного сервиса | Тип | Обяз. | Комментарий |
|---|---|---|---|---|---|---|
userMessage |
String [1..512] | Нет | - | - | - | Параметр поддерживается только API банка. |
| - | - | - | bindingId |
String | Нет | Параметр поддерживается только в Платежном сервисе. |
| - | - | - | gwId |
String | Нет | Параметр поддерживается только в Платежном сервисе. |