APIGate
WebService format
Version 1.32
Оглавление
1.
Безопасность и доступ................................................................................................................................4
1.1
1.1
2.
Авторизация запросов средствами ws-security.........................................................................................................4
Доступ по институту.....................................................................................................................................................4
Операции.....................................................................................................................................................5
2.1.
2.2.
2.3.
2.4.
2.5.
2.6.
2.7.
2.8.
2.9.
2.10.
2.11.
2.12.
2.13.
2.14.
2.15.
2.16.
2.17.
2.18.
2.19.
2.20.
2.21.
2.22.
2.23.
2.24.
2.25.
2.26.
2.27.
2.28.
2.29.
2.30.
2.31.
2.32.
2.33.
2.34.
2.35.
2.36.
2.37.
2.38.
2.39.
2.40.
2.41.
2.42.
2.43.
2.44.
2.45.
2.46.
2.47.
2.48.
2.49.
activateCard...................................................................................................................................................................5
addCardLimitException..................................................................................................................................................6
bindCardToAccount.......................................................................................................................................................7
blockCard.......................................................................................................................................................................9
blockCardB...................................................................................................................................................................10
cardAuthentication......................................................................................................................................................11
cardStatusInquiry.........................................................................................................................................................12
cashDeposit..................................................................................................................................................................13
changeAccountLimit....................................................................................................................................................15
changeAccountStatus..................................................................................................................................................16
changeCardLimit..........................................................................................................................................................17
changeCardStatus........................................................................................................................................................18
changeExceedLimit......................................................................................................................................................19
changePin.....................................................................................................................................................................20
checkOtp......................................................................................................................................................................21
checkCard.....................................................................................................................................................................22
createVirtualCard.........................................................................................................................................................23
creditCard....................................................................................................................................................................25
creditCardEcommerce.................................................................................................................................................27
debitCard.....................................................................................................................................................................28
feeCalculation..............................................................................................................................................................30
fundsTransfer...............................................................................................................................................................31
generateCVC2..............................................................................................................................................................33
generatePin..................................................................................................................................................................34
generateEPin................................................................................................................................................................36
getAccountData...........................................................................................................................................................37
getCardBalance............................................................................................................................................................38
getCardData.................................................................................................................................................................39
getCardLimits...............................................................................................................................................................40
getCardList...................................................................................................................................................................41
getCardListByOwner....................................................................................................................................................42
getCustomFields..........................................................................................................................................................44
getHoldList...................................................................................................................................................................45
getMerchantFeeList.....................................................................................................................................................46
getMerchantList...........................................................................................................................................................47
getMerchantTerminalList............................................................................................................................................48
getPerson.....................................................................................................................................................................49
getServicesList..............................................................................................................................................................50
getTerminalFeeList.......................................................................................................................................................51
getTransactionDetailsB................................................................................................................................................52
getTransactions............................................................................................................................................................53
getTransactionsB..........................................................................................................................................................55
getTransactionsBO.......................................................................................................................................................57
getTransactionStatus...................................................................................................................................................58
miniStatement.............................................................................................................................................................60
p2pTransfer..................................................................................................................................................................61
purchase.......................................................................................................................................................................63
resetPinCounter...........................................................................................................................................................65
reversal........................................................................................................................................................................66
2
2.50.
2.51.
2.52.
2.53.
3.
refund...........................................................................................................................................................................68
sendOtp........................................................................................................................................................................69
serviceAction................................................................................................................................................................70
validateCard.................................................................................................................................................................72
Составные типы.........................................................................................................................................74
3.1.
3.2.
3.3.
3.4.
3.5.
3.6.
3.7.
3.8.
3.9.
3.10.
3.11.
3.12.
3.13.
3.14.
3.15.
3.16.
3.17.
3.18.
3.19.
3.20.
3.21.
3.22.
3.23.
3.24.
3.25.
3.26.
3.27.
3.28.
3.29.
3.30.
3.31.
3.32.
3.33.
3.34.
3.35.
3.36.
3.37.
3.38.
3.39.
3.40.
3.41.
3.42.
3.43.
3.44.
3.45.
3.46.
3.47.
3.48.
accountDataType.........................................................................................................................................................74
accountDataDetailedType...........................................................................................................................................74
cardDataType...............................................................................................................................................................74
cardDataDetailedType.................................................................................................................................................75
cardIdentificationType.................................................................................................................................................75
cardListElement...........................................................................................................................................................75
cardListType.................................................................................................................................................................75
changeCardStatusRequestType...................................................................................................................................75
customFieldsDataType.................................................................................................................................................76
customFieldsType........................................................................................................................................................76
customerType..............................................................................................................................................................76
feeType........................................................................................................................................................................76
financialTransactionResponseType.............................................................................................................................76
limitBaseDataType.......................................................................................................................................................77
limitExceptionType......................................................................................................................................................77
limitFullDataType.........................................................................................................................................................77
limitsType.....................................................................................................................................................................77
merchantType..............................................................................................................................................................77
miniStatementRecordType..........................................................................................................................................78
personalDataType........................................................................................................................................................78
personMoneySendType...............................................................................................................................................78
personType..................................................................................................................................................................78
rowRangeType.............................................................................................................................................................78
serviceIdentificationType.............................................................................................................................................79
serviceParametersType...............................................................................................................................................79
servicesListDataType....................................................................................................................................................79
servicesListType...........................................................................................................................................................79
simpleIsoRequestType.................................................................................................................................................79
simpleResponseType...................................................................................................................................................79
terminalType................................................................................................................................................................80
transactionBDataType.................................................................................................................................................80
transactionDetailsBDataType......................................................................................................................................80
transactionDataType....................................................................................................................................................81
transactionBODataType...............................................................................................................................................82
transactionDatePeriodType.........................................................................................................................................82
transactionDateStrictPeriodType................................................................................................................................83
transactionDateLowerBoundedPeriodType................................................................................................................83
transactionDateTimePeriodType.................................................................................................................................83
transactionDateTimeStrictPeriodType........................................................................................................................83
transactionDateTimeLowerBoundedPeriodType........................................................................................................83
transactionsType..........................................................................................................................................................83
transactionsBOType.....................................................................................................................................................83
transactionsBType.......................................................................................................................................................83
virtualCardIdentificationType......................................................................................................................................84
accountsType...............................................................................................................................................................84
cardAcceptorParametersType.....................................................................................................................................84
originalTransactionParametersType............................................................................................................................84
cardsType.....................................................................................................................................................................84
4.
Простые типы............................................................................................................................................85
5.
Ошибки APIGate........................................................................................................................................89
3
5.1
5.2
6.
Справочники..............................................................................................................................................90
6.1
6.2
6.3
6.4
7.
serviceLevelFault..........................................................................................................................................................89
svfeProcessingFault.....................................................................................................................................................89
Статусы карт................................................................................................................................................................90
Типы циклов................................................................................................................................................................91
Значения processing code..........................................................................................................................................91
Коды ответов..............................................................................................................................................................92
Редакции...................................................................................................................................................94
4
1. Безопасность и доступ
1.1
Авторизация запросов средствами ws-security
При вызове всех методов в заголовке запроса SOAP должна передаваться идентификационная
информация согласно стандарту WSS (спецификация стандарта), а именно пара логин + пароль, где логин –
это идентификатор банка в формате «00xx», где «xx» - двузначный код банка. Пароль для доступа к боевой
системе предоставляется оператором интеграционного шлюза (процессинговым центром) на основании
письменного запроса от банка. В тестовой среде пароль совпадает с логином банка. В soap-запросе
авторизационные данные передаются в заголовке запроса.
Пример заголовка:
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-0258620B5BF40D6AD4151203062087123">
<wsse:Username>0001</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
Важно! Для операций с extId если авторизация выключена(пользователь не задан) – берется
дефолтный институт ‘9999’
1.1
Доступ по институту
APIGATE осуществляет проверку принадлежности запрашиваемых объектов, используемых в
операции, финансовому институту, инициирующему операцию. Если объект (карта, счет, держатель,
клиент, операция), запрашиваемый финансовым институтом в операции, не принадлежит данному
финансовому институту, операция будет отклонена. Исключение составляют операции p2pTransfer,
checkCard: допускается осуществлять зачисление на карточные счета и проверять данные карты других
финансовых институтов.
Для каждого финансового института в системе заводится отдельная пара merchantID/terminalID,
принадлежащая данному финансовому институту, от имени которой будут отправляться транзакции в
систему фронтэнда (для метода creditCardEcommerce сделано исключение – пара merchantID/terminalID
передается в качестве входных параметров вызова метода). В тестовой среде пары merchantID/terminalID
уже прописаны. В боевой системе пара merchantID/terminalID регистрируется на основании заявления от
банка.
5
2. Операции
Для всех нижеперечисленных методов указаны форматы положительных ответов от системы.
Ответы в случае отказа или сбоя описываются в разделе Ошибки APIGate.
2.1.
activateCard
Активировать карту.
Запрос (activateCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (штрих-код) или
(маскированный номер
карты и идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
Ответ (activateCardResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://www.bpc.ru/apigate/command/activateCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<act:activateCardRequest>
<act:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</act:cardIdentification>
</act:activateCardRequest>
</soapenv:Body>
</soapenv:Envelope>
6
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://www.bpc.ru/apigate/command/activateCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<act:activateCardResponse>
<gen:responseCode>00</gen:responseCode>
</act:activateCardResponse>
</soap:Body>
</soap:Envelope>
2.2.
addCardLimitException
Добавить исключение для лимита уровня карты.
Запрос (addCardLimitExceptionRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
limitException
limitExceptionType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Параметры исключения
лимита
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
Ответ (addCardLimitExceptionResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
7
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:add="http://www.bpc.ru/apigate/command/addCardLimitException/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<add:addCardLimitExceptionRequest>
<add:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</add:cardIdentification>
<add:limitException>
<gen:limitName>LMTTC01</gen:limitName>
<gen:startDate>2015-04-20</gen:startDate>
<gen:endDate>2015-04-30</gen:endDate>
<gen:value>10000000</gen:value>
<gen:cycleType>4</gen:cycleType>
<gen:cycleLength>1</gen:cycleLength>
</add:limitException>
</add:addCardLimitExceptionRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:add="http://www.bpc.ru/apigate/command/addCardLimitException/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<add:addCardLimitExceptionResponse>
<gen:responseCode>00</gen:responseCode>
</add:addCardLimitExceptionResponse>
</soap:Body>
</soap:Envelope>
2.3.
bindCardToAccount
Выполнить привязку карты к счету.
Запрос (bindCardToAccountRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
accountNumber
accountNumberType
accountType
accountCurrency
accountTypeType
currencyN3CodeType
personalData
personalDataType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер и срок действия
карты
Номер счета, к которому
выполняется привязка
Тип счета
Валюта счета (требуется
только при создании
нового счета)
Персональные данные
держателя карты
Обязательность
-
+
+
+
-
8
Ответ (bindCardToAccountResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bin="http://www.bpc.ru/apigate/command/bindCardToAccount/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<bin:bindCardToAccountRequest>
<bin:cardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</bin:cardIdentification>
<bin:accountNumber>4000010000000001</bin:accountNumber>
<bin:accountType>ACCOUNT_TYPE_DEFAULT</bin:accountType>
<bin:accountCurrency>643</bin:accountCurrency>
<bin:personalData>
<gen:firstName>IVAN</gen:firstName>
<gen:lastName>IVANOV</gen:lastName>
</bin:personalData>
</bin:bindCardToAccountRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bin="http://www.bpc.ru/apigate/command/bindCardToAccount/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<bin:bindCardToAccountResponse>
<gen:responseCode>00</gen:responseCode>
</bin:bindCardToAccountResponse>
</soap:Body>
</soap:Envelope>
9
2.4.
blockCard
Блокировать карту (карта изначально должна иметь статус «VALID CARD»).
Запрос (blockCardRequest)
Является элементом типа changeCardStatusRequestType.
Элемент
Тип
extId
extIdType
cardIdentification
cardIdentificationType
hotCardStatus
hotCardStatusType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (штрих-код) или
(маскированный номер
карты и идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Статус карты
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
Ответ (blockCardResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bloc="http://www.bpc.ru/apigate/command/blockCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<bloc:blockCardRequest>
<gen:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</gen:cardIdentification>
<gen:hotCardStatus>6</gen:hotCardStatus>
</bloc:blockCardRequest>
</soapenv:Body>
</soapenv:Envelope>
10
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bloc="http://www.bpc.ru/apigate/command/blockCard/" xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<bloc:blockCardResponse >
<responseCode>00</responseCode>
</bloc:blockCardResponse>
</soap:Body>
</soap:Envelope>
2.5.
blockCardB
Блокировать одну или несколько карт.
Запрос (blockCardBRequest)
Команда поддерживает следующие наборы параметров. Блокирование одной или нескольких карт по
номеру счета и держателю карты - accountNumber, registrationId, hotCardStatus, accountSelectionMode.
Блокирование карты по номеру карты и держателю карты - cardNumber, registrationId, hotCardStatus.
Блокирование одной или нескольких карт по номеру счета и номеру телефона - accountNumber,
phoneNumber, hotCardStatus, accountSelectionMode. Блокирование карты по номеру карты и номеру
телефона - cardNumber, phoneNumber, hotCardStatus. Блокировка всех карт, прикрепленных к номеру
телефона - phoneNumber, hotCardStatus.
Элемент
Тип
Описание
Обязательность
extId
extIdType
Внешний
идентификатор
транзакции
registrationId
personIdLastDigitMaskType
Идентификатор
держателя карты
(последние 8 символов)
phoneNumber
phoneNumberType
Номер телефона
accountNumber
accountNumberLastDigitMaskTyp Номер счета (последние e
4 цифры)
cardNumber
cardLastDigitMaskType
Номер карты
(последние 4 цифры)
hotCardStatus
hotCardStatusType
Статус карты
+
accountSelectionMode
entitySelectionMode
Режим выполнения
операции при выборке
нескольких счетов
Ответ (blockCardBResponse)
Расширяет тип simpleResponseType. При блокировании одной карты responseCode содержит код ответа
фронтальной системы. При блокировании нескольких карт responseCode всегда содержит код "00"
Элемент
Тип
Описание
Обязательность
responseCode
responseCodeType
Код завершения
+
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
numberOfCardsBlocked
unsignedShort
Количество
заблокированных карт
11
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bloc="http://www.bpc.ru/apigate/command/blockCardB/">
<soapenv:Header/>
<soapenv:Body>
<bloc:blockCardBRequest>
<bloc:cardNumber>0005</bloc:cardNumber>
<bloc:hotCardStatus>6</bloc:hotCardStatus>
</bloc:blockCardBRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bloc="http://www.bpc.ru/apigate/command/blockCardB/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<bloc:blockCardBResponse>
<responseCode>00</responseCode>
</bloc:blockCardBResponse>
</soap:Body>
</soap:Envelope>
2.6.
cardAuthentication
Выполнить аутентификацию карты.
Запрос (cardAuthenticationRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты.
Обязательность
-
Описание
Флаг аутентификации
карты
Срок действия
аутентификации
Обязательность
+
+
Ответ (cardAuthenticationResponse)
Элемент
authenticationFlag
Тип
string
expiryAuthentication
date
+
12
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:car="http://www.bpc.ru/apigate/command/cardAuthentication/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<car:cardAuthenticationRequest>
<car:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</car:cardIdentification>
</car:cardAuthenticationRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:car="http://www.bpc.ru/apigate/command/cardAuthentication/">
<soapenv:Header/>
<soapenv:Body>
<car:cardAuthenticationResponse>
<car:authenticationFlag>1</car:authenticationFlag>
<car:expiryAuthentication>2019-09-24</car:expiryAuthentication>
</car:cardAuthenticationResponse>
</soapenv:Body>
</soapenv:Envelope>
2.7.
cardStatusInquiry
Запросить статус карты.
Запрос (cardStatusInquiryRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты.
Обязательность
-
Описание
Статус карты
Обязательность
+
+
Ответ (cardStatusInquiryResponse)
Является элементом типа hotCardStatusType.
Элемент
Тип
hotCardStatus
hotCardStatusType
13
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:car="http://www.bpc.ru/apigate/command/cardStatusInquiry/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<car:cardStatusInquiryRequest>
<car:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</car:cardIdentification>
</car:cardStatusInquiryRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:car="http://www.bpc.ru/apigate/command/cardStatusInquiry/">
<soapenv:Header/>
<soapenv:Body>
<car:cardStatusInquiryResponse>
<car:hotCardStatus>6</car:hotCardStatus>
</car:cardStatusInquiryResponse>
</soapenv:Body>
</soapenv:Envelope>
2.8.
cashDeposit
Внести наличные средства.
Запрос (cashDepositRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
amount
currency
accountNumber
amountType
currencyN3CodeType
accountNumberType
Описание
Параметры
идентификации карты.
Возможные варианты:
номер карты или
идентификатор карты,
или маскированный
номер и идентификатор
держателя, или
маскированный номер
и номер телефона, или
маскированный номер
и номер счета. Также
должен быть указан
срок действия карты
Сумма
Валюта
Номер счета
Обязательность
+
+
+
-
14
Ответ (cashDepositResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
Описание
Код завершения
операции SVFE
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
+
+
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cas="http://www.bpc.ru/apigate/command/cashDeposit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<cas:cashDepositRequest>
<cas:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</cas:cardIdentification>
<cas:amount>10000</cas:amount>
<cas:currency>840</cas:currency>
<cas:accountType>ACCOUNT_TYPE_SAVING</cas:accountType>
</cas:cashDepositRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cas="http://www.bpc.ru/apigate/command/cashDeposit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<cas:cashDepositResponse>
<gen:responseCode>00</gen:responseCode>
<gen:processingCode>211000</gen:processingCode>
<gen:systemTraceAuditNumber>203046</gen:systemTraceAuditNumber>
<gen:localTransactionDate>2017-02-27T18:59:58+04:00</gen:localTransactionDate>
<gen:rrn>987654321987</rrn>
<gen:authorizationIdResponse>123456</gen:authorizationIdResponse>
</cas:cashDepositResponse>
</soap:Body>
</soap:Envelope>
15
2.9.
changeAccountLimit
Изменить значение лимита уровня счета.
Запрос (changeAccountLimitRequest)
Элемент
accountNumber
Тип
accountNumberType
limit
limitBaseDataType
Описание
Номер счета, к которому
выполняется привязка
Параметры лимита
Обязательность
+
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
Ответ (changeAccountLimitResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeAccountLimit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chan:changeAccountLimitRequest>
<chan:accountNumber>4000010000000003</chan:accountNumber>
<chan:limit>
<gen:name>LMTTC01</gen:name>
<gen:value>10000000</gen:value>
</chan:limit>
</chan:changeAccountLimitRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeAccountLimit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changeAccountLimitResponse>
<gen:responseCode>00</gen:responseCode>
</chan:changeAccountLimitResponse>
</soap:Body>
</soap:Envelope>
16
2.10. changeAccountStatus
Изменить статус счета.
Запрос (changeAccountStatusRequest)
Элемент
accountNumber
accountStatus
Тип
accountNumberType
accountStatusType
Описание
Номер счета
Статус счета
Обязательность
+
+
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
Ответ (changeAccountStatusResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeAccountStatus/">
<soapenv:Header/>
<soapenv:Body>
<chan:changeAccountStatusRequest>
<chan:accountNumber>000000002652</chan:accountNumber>
<chan:accountStatus>1</chan:accountStatus>
</chan:changeAccountStatusRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeAccountStatus/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changeAccountStatusResponse>
<gen:responseCode>1</gen:responseCode>
</chan:changeAccountStatusResponse>
</soap:Body>
</soap:Envelope>
17
2.11. changeCardLimit
Изменить значение лимита уровня карты.
Запрос (changeCardLimitRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
limit
limitBaseDataType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
срок действия карты, а
также ее номер или
идентификатор
Параметры лимита
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
Ответ (changeCardLimitResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeCardLimit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chan:changeCardLimitRequest>
<chan:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</chan:cardIdentification>
<chan:limit>
<gen:name>LMTTC01</gen:name>
<gen:value>10000000</gen:value>
</chan:limit>
</chan:changeCardLimitRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
18
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeCardLimit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changeCardLimitResponse>
<gen:responseCode>00</gen:responseCode>
</chan:changeCardLimitResponse>
</soap:Body>
</soap:Envelope>
2.12. changeCardStatus
Изменить статус карты.
Запрос (changeCardStatusRequest)
Является элементом типа changeCardStatusRequestType.
Элемент
Тип
extId
extIdType
cardIdentification
cardIdentificationType
hotCardStatus
hotCardStatusType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (штрих-код) или
(маскированный номер
карты и идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Статус карты
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
Ответ (changeCardStatusResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
19
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeCardStatus/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chan:changeCardStatusRequest>
<gen:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</gen:cardIdentification>
<gen:hotCardStatus>17</gen:hotCardStatus>
</chan:changeCardStatusRequest>
</soapenv:Body>
</soapenv:Envelope>
20
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeCardStatus/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changeCardStatusResponse>
<responseCode>00</responseCode>
</chan:changeCardStatusResponse>
</soap:Body>
</soap:Envelope>
2.13. changeExceedLimit
Изменить лимит овердрафта на карточном счете.
Запрос (changeExceedLimitRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
amount
currency
accountNumber
amountType
currencyN3CodeType
accountNumberType
expDate
limitEdgeDateType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты + срок
действия карты) или
(идентификатор карты)
Сумма
Валюта
Номер счета, к которому
выполняется привязка
Дата окончания
действия лимита
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
+
+
+
Ответ (changeCardStatusResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
21
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeExceedLimit/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Body>
<chan:changeExceedLimitRequest>
<chan:cardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</chan:cardIdentification>
<chan:amount>100</chan:amount>
<chan:currency>810</chan:currency>
<chan:accountNumber>4000010000000001</chan:accountNumber>
</chan:changeExceedLimitRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changeExceedLimit/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changeExceedLimitResponse>
<responseCode>00</responseCode>
</chan: changeExceedLimitResponse>
</soap:Body>
</soap:Envelope>
2.14. changePin
Изменить PIN-код.
Запрос (changePinRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
newPinData
encryptedPinDataType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Новое значение PINкода
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
+
Ответ (changePinResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
22
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changePin/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chan:changePinRequest>
<chan:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</chan:cardIdentification>
<chan:newPinData>059B2AA97DF72557</chan:newPinData>
</chan:changePinRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chan="http://www.bpc.ru/apigate/command/changePin/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chan:changePinResponse>
<responseCode>00</responseCode>
</chan:changePinResponse>
</soap:Body>
</soap:Envelope>
2.15. checkOtp
Проверка одноразового пароля
Запрос (checkOtpRequest)
Элемент
transactionId
Тип
sendOtpTransIdType
Otp
checkOtpOtpType
Описание
Идентификатор
транзакции после
sendOtp
One time pass
Обязательность
+
Описание
Код проверки ОТП, 00 проверилось правильно
Обязательность
+
+
Ответ (checkOtpResponse)
Элемент
responseCode
Тип
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chec="http://www.bpc.ru/apigate/command/checkOtp/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chec:checkOtpRequest>
<gen:transactionId>123456</gen: transactionId >
<gen:otp>654321</gen:otp>
</chec:checkCardRequest>
</soapenv:Body>
</soapenv:Envelope>
23
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chec="http://www.bpc.ru/apigate/command/checkOtp/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chec:checkOtpResponse>
<chec:responseCode>00</chec:responseCode>
</chec:checkCardResponse>
</soap:Body>
</soap:Envelope>
2.16. checkCard
Выполнить транзакционную проверку карты.
Запрос (checkCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
маскированный номер
карты и номер
телефона, либо штрихкод
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Данные карты (только
если responseCode = 0
или 00)
Обязательность
+
+
Ответ (checkCardResponse)
Элемент
responseCode
Тип
responseCodeType
cardData
cardDataType
-
Пример запроса:
24
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chec="http://www.bpc.ru/apigate/command/checkCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<chec:checkCardRequest>
<chec:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</chec:cardIdentification>
</chec:checkCardRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:chec="http://www.bpc.ru/apigate/command/checkCard/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<chec:checkCardResponse>
<chec:responseCode>00</chec:responseCode>
<chec:cardData>
<cardNumber>4000010000000003</cardNumber>
<expiryDate>202012</expiryDate>
</chec:cardData>
</chec:checkCardResponse>
</soap:Body>
</soap:Envelope>
2.17. createVirtualCard
Создать виртуальную карту.
Запрос (createVirtualCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
virtualCardIdentification
virtualCardIdentificationType
amount
amountType
phoneNumber
currency
accountNumber
phoneNumberType
currencyN3CodeType
accountNumberType
deliveryMethod
virtualCardDataDeliveryMethodT
ype
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации
основной карты
Параметры
идентификации
виртуальной карты.
Должны быть указаны
срок действия и тип
продукта
Сумма на карточном
счете
Номер телефона
Валюта
Номер счета для
идентификации
основной карты
Способ доставки данных
виртуальной карты
Обязательность
-
-
+
+
+
-
25
Ответ (createVirtualCardResponse)
Элемент
virtualCardIdentification
Тип
virtualCardIdentificationType
Описание
Параметры виртуальной
карты
Обязательность
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cre="http://www.bpc.ru/apigate/command/createVirtualCard/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<cre:createVirtualCardRequest>
<cre:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</cre:cardIdentification>
<cre:virtualCardIdentification>
<gen:expDate>201512</gen:expDate>
<gen:productType>66</gen:productType>
</cre:virtualCardIdentification>
<cre:amount>0</cre:amount>
<cre:currency>643</cre:currency>
<cre:deliveryMethod>WS</cre:deliveryMethod>
</cre:createVirtualCardRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cre="http://www.bpc.ru/apigate/command/createVirtualCard/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<cre:createVirtualCardResponse>
<cre:virtualCardIdentification>
<cardNumber>8052469316638594</cardNumber>
<expDate>202012</expDate>
<productType>66</productType>
<cvv2>603</cvv2>
</cre:virtualCardIdentification>
</cre:createVirtualCardResponse>
</soap:Body>
</soap:Envelope>
26
2.18. creditCard
Зачислить средства на карту.
Запрос (creditCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
amount
currency
amountType
currencyN3CodeType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (маскированный
номер карты и
идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Сумма
Валюта
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
+
Ответ (creditCardResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
+
+
+
+
+
27
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cred="http://www.bpc.ru/apigate/command/creditCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<cred:creditCardRequest>
<cred:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</cred:cardIdentification>
<cred:amount>100000</cred:amount>
<cred:currency>643</cred:currency>
</cred:creditCardRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cred="http://www.bpc.ru/apigate/command/creditCard/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<cred:creditCardResponse>
<responseCode>00</responseCode>
<processingCode>270000</processingCode>
<systemTraceAuditNumber>51092</systemTraceAuditNumber>
<localTransactionDate>2017-03-09T14:33:31+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123ABC</authorizationIdResponse>
</cred:creditCardResponse>
</soap:Body>
</soap:Envelope>
28
2.19. creditCardEcommerce
Зачислить средства на карту.
Запрос (creditCardEcommerceRequest)
Элемент
extId
Тип
extIdType
merchantId
string
terminalId
string
sourceCardIdentification
cardIdentificationType
destinationCardIdentificatio
n
cardIdentificationType
sender
recepient
amount
currency
sourceAccountNumber
personMoneySendType
personMoneySendType
amountType
currencyN3CodeType
accountNumberType
destinationAccountNumber
accountNumberType
Описание
Внешний
идентификатор
транзакции
Идентификатор
мерчента
Идентификатор
терминала
Параметры
идентификации
дебетуемой карты.
Необходимо указать
номер и срок действия
карты
Параметры
идентификации
кредитуемой карты.
Необходимо указать
номер карты
Данные отправителя
Данные получателя
Сумма
Валюта
Номер счета
дебетуемой карты
Номер счета
кредитуемой карты
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
-
-
+
+
+
-
Ответ (creditCardEcommerceResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
+
+
+
+
+
29
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cred="http://www.bpc.ru/apigate/command/creditCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<cred:creditCardRequest>
<cred:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</cred:cardIdentification>
<cred:amount>100000</cred:amount>
<cred:currency>643</cred:currency>
</cred:creditCardRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cred="http://www.bpc.ru/apigate/command/creditCard/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<cred:creditCardResponse>
<responseCode>00</responseCode>
<processingCode>270000</processingCode>
<systemTraceAuditNumber>51092</systemTraceAuditNumber>
<localTransactionDate>2017-03-09T14:33:31+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123ABC</authorizationIdResponse>
</cred:creditCardResponse>
</soap:Body>
</soap:Envelope>
2.20. debitCard
Списать средства с карты.
Запрос (debitCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (маскированный
номер карты и
идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Обязательность
-
+
30
amount
currency
amountType
currencyN3CodeType
Сумма
Валюта
+
+
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
Ответ (debitCardResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
+
+
+
+
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:deb="http://www.bpc.ru/apigate/command/debitCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<deb:debitCardRequest>
<deb:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</deb:cardIdentification>
<deb:amount>100000</deb:amount>
<deb:currency>643</deb:currency>
</deb:debitCardRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:deb="http://www.bpc.ru/apigate/command/debitCard/" xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<deb:debitCardResponse>
<responseCode>00</responseCode>
<processingCode>170000</processingCode>
<systemTraceAuditNumber>51106</systemTraceAuditNumber>
<localTransactionDate>2017-03-09T14:46:00+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123ABC</authorizationIdResponse>
</deb:debitCardResponse>
</soap:Body>
</soap:Envelope>
31
2.21. feeCalculation
Рассчитать эквайринговую комиссию для P2P операции.
Метод возвращает из SVFE сумму посчитанной эквайринговой комиссии по P2P переводу. В рамках этого
метода API-gate будет подставлять в запрос к FE информацию по Terminal ID, Merchant ID, взятую из
настроек пользователей API-gate для того, чтобы определить эквайера, от имени которого будет
производиться перевод и для которого необходимо расчитать комиссию.
Запрос (feeCalculationRequest)
Элемент
extId
Тип
extIdType
sourceCardIdentification
cardIdentificationType
destinationCardIdentificatio
n
cardIdentificationType
amount
currency
sourceAccountNumber
amountType
currencyN3CodeType
accountNumberType
destinationAccountNumber
accountNumberType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации
дебетуемой карты.
Необходимо указать
номер и срок действия
карты
Параметры
идентификации
кредитуемой карты.
Необходимо указать
номер карты
Сумма
Валюта
Номер счета
дебетуемой карты
Номер счета
кредитуемой карты
Обязательность
-
Описание
Сумма посчитанной
комиссии
Валюта посчитанной
комиссии
Обязательность
+
+
+
+
+
-
Ответ (feeCalculationResponse)
Элемент
amount
Тип
amountType
currency
currencyN3CodeType
+
Пример запроса:
32
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:feec="http://www.bpc.ru/apigate/command/feeCalculation/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<feec:feeCalculationRequest>
<feec:sourceCardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</feec:sourceCardIdentification>
<feec:destinationCardIdentification>
<gen:cardNumber>4000010000000004</gen:cardNumber>
</feec:destinationCardIdentification>
<feec:amount>100000</feec:amount>
<feec:currency>643</feec:currency>
</feec:feeCalculationRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:feec="http://www.bpc.ru/apigate/command/feeCalculation/">
<soapenv:Header/>
<soapenv:Body>
<feec:feeCalculationResponse>
<feec:amount>100</feec:amount>
<feec:currency>643</feec:currency>
</feec:feeCalculationResponse>
</soapenv:Body>
</soapenv:Envelope>
2.22. fundsTransfer
Выполнить перевод между счетами карты.
Запрос (fundsTransferRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
sourceAccountType
sourceAccountIndex
accountTypeType
accountIndexType
destinationAccountType
destinationAccountIndex
accountTypeType
accountIndexType
amount
currency
amountType
currencyN3CodeType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Тип счета-источника
Порядковый номер
счета-источника
Тип счета-приемника
Порядковый номер
счета-приемника
Сумма
Валюта
Обязательность
-
+
+
+
+
+
Ответ (fundsTransferResponse)
Является элементом типа financialTransactionResponseType.
33
Элемент
responseCode
Тип
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
+
+
+
34
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:fun="http://www.bpc.ru/apigate/command/fundsTransfer/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<fun:fundsTransferRequest>
<fun:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</fun:cardIdentification>
<fun:sourceAccountType>ACCOUNT_TYPE_CHECKING</fun:sourceAccountType>
<fun:sourceAccountIndex>1</fun:sourceAccountIndex>
<fun:destinationAccountType>ACCOUNT_TYPE_LOYALTY</fun:destinationAccountType>
<fun:destinationAccountIndex>2</fun:destinationAccountIndex>
<fun:amount>50000</fun:amount>
<fun:currency>643</fun:currency>
</fun:fundsTransferRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:fun="http://www.bpc.ru/apigate/command/fundsTransfer/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<fun:fundsTransferResponse>
<responseCode>00</responseCode>
<processingCode>402192</processingCode>
<systemTraceAuditNumber>51256</systemTraceAuditNumber>
<localTransactionDate>2017-03-09T17:14:21+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123456</authorizationIdResponse>
</fun:fundsTransferResponse>
</soap:Body>
</soap:Envelope>
35
2.23. generateCVC2
Сгенерировать CVC2.
Запрос (generateCVC2Request)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
номер карты и ее срок
действия или
идентификатор карты
Обязательность
+
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
CVV2
Обязательность
+
Ответ (generateCVC2Response)
Расширяет тип simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
cvc2
cvv2Type
-
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generateCVC2/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generateCVC2Request>
<gen:cardIdentification>
<gen1:cardNumber>4000010000000001</gen1:cardNumber>
<gen1:expDate>202012</gen1:expDate>
</gen:cardIdentification>
</gen:generateCVC2Request>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generateCVC2/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generateCVC2Response>
<gen1:responseCode>00</gen1:responseCode>
<gen1:cvc2>123</gen1:cvc2>
</gen:generateCVC2Response>
</soapenv:Body>
</soapenv:Envelope>
36
2.24. generatePin
Сгенерировать PIN-код.
Запрос (generatePinRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
pinDeliveryMethod
pinDeliveryMethodType
pinValue
pinValueType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
маскированный номер
карты и номер
мобильного телефона
Способ доставки PINкода
PIN-код
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
PIN-код
Зашифрованный PINкод
Обязательность
+
+
+
-
Ответ (generatePinResponse)
Расширяет тип simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
pinValue
encryptedPinValue
pinValueType
base64Binary
-
37
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generatePin/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generatePinRequest>
<gen:cardIdentification>
<gen1:cardNumberMask>400001%0003</gen1:cardNumberMask>
<gen1:phoneNumber>+79021111111</gen1:phoneNumber>
</gen:cardIdentification>
<gen:pinDeliveryMethod>WS</gen:pinDeliveryMethod>
</gen:generatePinRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generatePin/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generatePinResponse>
<gen1:responseCode>00</gen1:responseCode>
<gen1:pinValue>8932</gen1:pinValue>
</gen:generatePinResponse>
</soapenv:Body>
</soapenv:Envelope>
38
2.25. generateEPin
Сгенерировать EPIN-код.
Запрос (generateEPinRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
pinDeliveryMethod
pinValue
pinDeliveryMethodType
pinValueType
Описание
Внешний идентификатор
транзакции
Параметры идентификации
карты. Необходимо указать
маскированный номер карты и
номер мобильного телефона
Способ доставки PIN-кода
PIN-код
Обязательность
-
Описание
Код завершения операции SVFE.
Список
возможных значений см. в
таблице Коды ответов в колонке
«Код ответа ISO»
PIN-код
Зашифрованный PIN-код
Обязательность
+
+
+
-
Ответ (generateEPinResponse)
Расширяет тип simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
pinValue
encryptedPinValue
pinValueType
base64Binary
-
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generateEPin/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generateEPinRequest>
<gen1:cardIdentification>
<gen1:cardNumberMask>400001%0003</gen1:cardNumberMask>
<gen1:phoneNumber>+79021111111</gen1:phoneNumber>
</gen1:cardIdentification>
<gen1:pinDeliveryMethod>WS</gen1:pinDeliveryMethod>
</gen:generateEPinRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:gen="http://www.bpc.ru/apigate/command/generateEPin/"
xmlns:gen1="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<gen:generateEPinResponse>
<gen1:responseCode>00</gen1:responseCode>
<gen1:pinValue>8932</gen1:pinValue>
</gen:generateEPinResponse>
</soapenv:Body>
</soapenv:Envelope>
39
2.26. getAccountData
Получить информацию по счету.
Запрос (getAccountDataRequest)
Элемент
accountNumber
Тип
accountNumberType
Описание
Номер счета
Обязательность
+
Описание
Параметры счета
Обязательность
+
Ответ (getAccountDataResponse)
Элемент
accountData
Тип
accountDataDetailedType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getAccountData/">
<soapenv:Header/>
<soapenv:Body>
<get:getAccountDataRequest>
<get:accountNumber>4000010000000003</get:accountNumber>
</get:getAccountDataRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
40
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getAccountData/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getAccountDataResponse>
<get:accountData>
<number>4000010000000003</number>
<currency>810</currency>
<balance>100885567</balance>
<customerId>10022830</customerId>
<cards>
<cardData>
<cardNumberMask>400001******0003</cardNumberMask>
<expiryDate>202012</expiryDate>
<cardId>987654321012</cardId>
<hotCardStatus>0</hotCardStatus>
<cardTypeName>VISA PLATINUM</cardTypeName>
<embossedName>TEST FOR_BO_TRANS1</embossedName>
<customerId>10022830</customerId>
<personId>40000003</personId>
<pinDenialCounter>0</pinDenialCounter>
<plasticNumber>0</plasticNumber>
<hotCardStatusDescription>VALID
CARD</hotCardStatusDescription>
<cardIsPrimary>true</cardIsPrimary>
<cardBindToCustomer>false</cardBindToCustomer>
<customerIsCardholder>false</customerIsCardholder>
</cardData>
</cards>
</get:accountData>
</get:getAccountDataResponse>
</soap:Body>
</soap:Envelope>
2.27. getCardBalance
Получить баланс карты.
Запрос (getCardBalanceRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (штрих-код) или
(номер счета) или
(маскированный номер
карты и идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Обязательность
-
+
41
accountNumber
accountNumberType
accountType
accountTypeType
Номер счета, к которому
выполняется привязка
Тип счета
-
Описание
Параметры карты
(номер и срок действия)
Баланс
Валюта
Кредитный лимит
Валюта кредитного
лимита
Собственные средства
Валюта собственных
средств
Обязательность
-
-
Ответ (getCardBalanceResponse)
Элемент
cardIdentification
Тип
cardIdentificationType
balance
currency
availableExceedLimit
availableExceedLimitCurrenc
y
ownFunds
ownFundsCurrency
amountType
currencyN3CodeType
amountType
currencyN3CodeType
amountType
currencyN3CodeType
-
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardBalance/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardBalanceRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
</get:cardIdentification>
</get:getCardBalanceRequest>
</soapenv:Body>
</soapenv:Envelope>
42
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardBalance/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getCardBalanceResponse>
<get:cardIdentification>
<cardNumber>4000010000000001</cardNumber>
<expDate>202012</expDate>
</get:cardIdentification>
<get:balance>2000000</get:balance>
<get:currency>643</get:currency>
<get:availableExceedLimit>100000</get:availableExceedLimit>
<get:availableExceedLimitCurrency>643</get:availableExceedLimitCurrency>
<get:ownFunds>19000000</get:ownFunds>
<get:ownFundsCurrency>643</get:ownFundsCurrency>
</get:getCardBalanceResponse>
</soap:Body>
</soap:Envelope>
2.28. getCardData
Получить информацию по карте.
Запрос (getCardDataRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
номер карты и ее срок
действия или
идентификатор карты
Обязательность
+
Описание
Данные карты
Обязательность
+
Ответ (getCardDataResponse)
Элемент
cardData
Тип
cardDataDetailedType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardData/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardDataRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</get:cardIdentification>
</get:getCardDataRequest>
</soapenv:Body>
</soapenv:Envelope>
43
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardData/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getCardDataResponse>
<get:cardData>
<cardNumberMask>400001******0003</cardNumberMask>
<expiryDate>202012</expiryDate>
<cardId>987654321012</cardId>
<hotCardStatus>0</hotCardStatus>
<cardTypeName>VISA PLATINUM</cardTypeName>
<embossedName>TEST FOR_BO_TRANS1</embossedName>
<customerId>10022830</customerId>
<personId>40000003</personId>
<pinDenialCounter>0</pinDenialCounter>
<plasticNumber>0</plasticNumber>
<hotCardStatusDescription>VALID CARD</hotCardStatusDescription>
<cardIsPrimary>true</cardIsPrimary>
<cardBindToCustomer>false</cardBindToCustomer>
<customerIsCardholder>false</customerIsCardholder>
<accounts>
<accountData>
<number>4000010000000003</number>
<currency>810</currency>
<balance>100885567</balance>
<customerId>10022830</customerId>
</accountData>
</accounts>
</get:cardData>
</get:getCardDataResponse>
</soap:Body>
</soap:Envelope>
2.29. getCardLimits
Метод возвращает информацию об установленных и текущих значениях лимитов из системы SVFE.
Запрос (getCardLimitsRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Обязательность
+
Описание
Лимиты карты
Обязательность
+
Ответ (getCardLimitsResponse)
Элемент
limits
Тип
limitsType
44
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardLimits/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardLimitsRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</get:cardIdentification>
</get:getCardLimitsRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardLimits/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getCardLimitsResponse>
<get:limits>
<limit>
<name>LMTTC05</name>
<value>999999999999</value>
<cycleType>0</cycleType>
<cycleLength>1</cycleLength>
<currentValue>0</currentValue>
<limitExceptions/>
</limit>
</get:limits>
</get:getCardLimitsResponse>
</soap:Body>
</soap:Envelope>
2.30. getCardList
Получить список карт по номеру телефона.
Запрос (getCardListRequest)
Элемент
phoneNumber
Тип
phoneNumberType
Описание
Номер телефона
Обязательность
+
Описание
Номер телефона
Список карт
Обязательность
+
+
Ответ (getCardListResponse)
Элемент
phoneNumber
cardList
Тип
phoneNumberType
cardListType
45
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardList/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardListRequest>
<get:phoneNumber>7948561324</get:phoneNumber>
<get:localTransactionDate>2015-04-09T11:15:35+04:00</get:localTransactionDate>
</get:getCardListRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardList/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardListResponse>
<get:phoneNumber>?</get:phoneNumber>
<get:cardList>
<gen:cardList>
<gen:cardNumber>4001000000000001</gen:cardNumber>
<gen:authenticationFlag>5</gen:authenticationFlag>
</gen:cardList>
</get:cardList>
</get:getCardListResponse>
</soapenv:Body>
</soapenv:Envelope>
2.31. getCardListByOwner
Получить список карт по идентификатору клиента и/или держателя карты.
Запрос (getCardListByOwnerRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
идентификатор клиента
(customerId) и/или
идентификатор
держателя карты
(cardholderId)
Обязательность
+
Описание
Перечень карт
Обязательность
-
Ответ (getCardListByOwnerResponse)
Элемент
cards
Тип
cardDataType
46
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardListByOwner/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCardListByOwnerRequest>
<get:cardIdentification>
<gen:customerId>10022830</gen:customerId>
</get:cardIdentification>
</get:getCardListByOwnerRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
47
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCardListByOwner/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getCardListByOwnerResponse>
<get:cards>
<get:card>
<cardNumberMask>400001******0004</cardNumberMask>
<expiryDate>202012</expiryDate>
<cardId>99</cardId>
<hotCardStatus>0</hotCardStatus>
<cardTypeName>EC/MC Virtual</cardTypeName>
<embossedName>TEST FOR_BO_TRANS1</embossedName>
<customerId>10022830</customerId>
<personId>40000004</personId>
<pinDenialCounter>0</pinDenialCounter>
<plasticNumber>0</plasticNumber>
<hotCardStatusDescription>VALID CARD</hotCardStatusDescription>
<cardIsPrimary>true</cardIsPrimary>
<cardBindToCustomer>true</cardBindToCustomer>
<customerIsCardholder>false</customerIsCardholder>
</get:card>
<get:card>
<cardNumberMask>400001******0017</cardNumberMask>
<expiryDate>202012</expiryDate>
<hotCardStatus>0</hotCardStatus>
<cardTypeName>EC/MC Virtual</cardTypeName>
<embossedName>TEST FOR_BO_TRANS1</embossedName>
<customerId>10022830</customerId>
<personId>40000017</personId>
<pinDenialCounter>0</pinDenialCounter>
<plasticNumber>0</plasticNumber>
<hotCardStatusDescription>VALID CARD</hotCardStatusDescription>
<cardIsPrimary>true</cardIsPrimary>
<cardBindToCustomer>true</cardBindToCustomer>
<customerIsCardholder>false</customerIsCardholder>
</get:card>
</get:cards>
</get:getCardListByOwnerResponse>
</soap:Body>
</soap:Envelope>
2.32. getCustomFields
Получить пользовательские поля.
Запрос (getCustomFieldsRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты и
ее срок действия
Обязательность
+
Описание
Обязательность
Ответ (getCustomFieldsResponse)
Элемент
Тип
48
customFields
customFieldsType
Пользовательские поля
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCustomFields/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCustomFieldsRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000004</gen:cardNumber>
</get:cardIdentification>
</get:getCustomFieldsRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getCustomFields/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<get:getCustomFieldsResponse>
<get:customFields>
<gen:customFields>
<gen:fieldName>TEMP</gen:fieldName>
<gen:value>qwe</gen:value>
</gen:customFields>
</get:customFields>
</get:getCustomFieldsResponse>
</soapenv:Body>
</soapenv:Envelope>
49
2.33. getHoldList
Получение информации о захолдированных операциях (не проведенных операциях).
Запрос (getHoldListRequest)
Элемент
cardNumber
expDate
rowRange
period
Тип
cardNumberType
cardExpDateType
rowRangeType
transactionDateTimeLowerBound
edPeriodType
Описание
Номер карты
Срок действия карты
Диапазон строк
Временной период
Обязательность
+
+
+
Описание
Общая сумма не
проведенных операций
в национальной валюте
Количество операций
Транзакции
Обязательность
-
Ответ (getHoldListResponse)
Элемент
balance
Тип
amountType
numberOfTransactions
transactions
unsignedShort
transactionsBType
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getHoldList/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getHoldListRequest>
<get:cardNumber>4000010000000004</get:cardNumber>
<get:rowRange>
<gen:start>1</gen:start>
<gen:end>1</gen:end>
</get:rowRange>
<get:period>
<gen:start>2015-04-01</gen:start>
</get:period>
</get:getHoldListRequest>
</soapenv:Body>
</soapenv:Envelope>
50
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getHoldList/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getHoldListResponse>
<get:balance>100</get:balance>
<get:numberOfTransactions>1</get:numberOfTransactions>
<get:transactions>
<gen:transaction>
<gen:cardNumber>4000010000000004</gen:cardNumber>
<gen:cardSequenceNumber>1</gen:cardSequenceNumber>
<gen:utrnno>123456</gen:utrnno>
<gen:reversal>0</gen:reversal>
</gen:transaction>
</get:transactions>
</get:getHoldListResponse>
</soapenv:Body>
</soapenv:Envelope>
2.34. getMerchantFeeList
Получить список комиссий мерчанта.
Запрос (getMerchantFeeListRequest)
Элемент
merchantId
Тип
merchantIdType
Описание
Обязательность
+
Описание
Список комиссий
Обязательность
+
Ответ (getMerchantFeeListResponse)
Элемент
feeList
Тип
feeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantFeeList/">
<soapenv:Header/>
<soapenv:Body>
<get:getMerchantFeeListRequest>
<get:merchantId>M000001</get:merchantId>
</get:getMerchantFeeListRequest>
</soapenv:Body>
</soapenv:Envelope>
51
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantFeeList/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getMerchantFeeListResponse>
<get:feeList>
<fee>
<feeType>Merchant sub-level maintenance</feeType>
<feeValue>1000</feeValue>
</fee>
<fee>
<feeType>Merchant sub-level registration</feeType>
<feeValue>1000</feeValue>
</fee>
<fee>
<feeType>Terminal maintenance</feeType>
<feeValue>1000</feeValue>
</fee>
<fee>
<feeType>Terminal registration</feeType>
<feeValue>1000</feeValue>
</fee>
</get:feeList>
</get:getMerchantFeeListResponse>
</soap:Body>
</soap:Envelope>
2.35. getMerchantList
Получить список мерчантов.
Запрос (getMerchantListRequest)
Запрос без параметров.
Элемент
Тип
Описание
Обязательность
Описание
Список мерчантов
Обязательность
-
Ответ (getMerchantListResponse)
Элемент
merchantList
Тип
merchantType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantList/">
<soapenv:Header/>
<soapenv:Body>
<get:getMerchantListRequest/>
</soapenv:Body>
</soapenv:Envelope>
52
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantList/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getMerchantListResponse>
<get:merchantList>
<get:merchant>
<get:id>10001001</get:id>
<get:status>Valid Entity</get:status>
<get:name>VINEXIM UNIPAYMENT</get:name>
<get:contractId>201</get:contractId>
<get:contractDescription>1</get:contractDescription>
<get:contractStatus>Valid Entry</get:contractStatus>
</get:merchant>
<get:merchant>
<get:id>M000001</get:id>
<get:status>Valid Entity</get:status>
<get:name>ALGECO</get:name>
<get:contractId>201</get:contractId>
<get:contractDescription>1</get:contractDescription>
<get:contractStatus>Valid Entry</get:contractStatus>
</get:merchant>
</get:merchantList>
</get:getMerchantListResponse>
</soap:Body>
</soap:Envelope>
2.36. getMerchantTerminalList
Получить список терминалов мерчанта.
Запрос (getMerchantTerminalListRequest)
Элемент
merchantId
Тип
merchantIdType
Описание
Идентификатор
мерчанта
Обязательность
+
Описание
Список терминалов
Обязательность
+
Ответ (getMerchantTerminalListResponse)
Элемент
terminalList
Тип
terminalType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantTerminalList/">
<soapenv:Header/>
<soapenv:Body>
<get:getMerchantTerminalListRequest>
<get:merchantId>M000001</get:merchantId>
</get:getMerchantTerminalListRequest>
</soapenv:Body>
</soapenv:Envelope>
53
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getMerchantTerminalList/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getMerchantTerminalListResponse>
<get:terminalList>
<get:terminal>
<get:id>10000181</get:id>
<get:type>POS</get:type>
<get:registrationDate>2013-09-05</get:registrationDate>
<get:address>Bolshaya Nikatskaya St, 5 Moscow 643</get:address>
<get:status>Valid Entry</get:status>
<get:feeValue>1000</get:feeValue>
</get:terminal>
<get:terminal>
<get:id>10000082</get:id>
<get:type>ATM</get:type>
<get:registrationDate>2013-07-31</get:registrationDate>
<get:address>Bolshaya Nikatskaya St, 5 Moscow 643</get:address>
<get:status>Valid Entry</get:status>
</get:terminal>
</get:terminalList>
</get:getMerchantTerminalListResponse>
</soap:Body>
</soap:Envelope>
2.37. getPerson
Получить информацию о держателе карты.
Запрос (getPersonRequest)
Элемент
personId
Тип
personIdType
Описание
Идентификатор
держателя карты
Обязательность
+
Описание
Параметры держателя
карты
Параметры клиента
Обязательность
+
Ответ (getPersonResponse)
Элемент
person
Тип
personType
customer
customerType
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getPerson/">
<soapenv:Header/>
<soapenv:Body>
<get:getPersonRequest>
<get:personId>10000021</get:personId>
</get:getPersonRequest>
</soapenv:Body>
</soapenv:Envelope>
54
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getPerson/" xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getPersonResponse>
<get:person>
<personId>10000021</personId>
<firstName>IVANOV_1</firstName>
<secondName>IVANOVICH</secondName>
<surname>IVANOV</surname>
</get:person>
<get:customer>
<customerId>10000001</customerId>
<address>Nowhere street h.1</address>
</get:customer>
</get:getPersonResponse>
</soap:Body>
</soap:Envelope>
2.38. getServicesList
Получить сервисы, подключенные к карте.
Запрос (getServicesListRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты и
ее срок действия
Обязательность
+
Описание
Сервисы,
подключенные к карте
Обязательность
+
Ответ (getServicesListResponse)
Элемент
servicesList
Тип
servicesListType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getServicesList/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getServicesListRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</get:cardIdentification>
</get:getServicesListRequest>
</soapenv:Body>
</soapenv:Envelope>
55
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getServicesList/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getServicesListResponse>
<get:servicesList>
<gen:servicesList>
<gen:serviceIdentificationType>
<gen:serviceType>7</gen:serviceType>
<gen:serviceId>300</gen:serviceId>
<gen:serviceObjectType>SERVICE_OBJECT_CARD</gen:serviceObjectType>
</gen:serviceIdentificationType>
</gen:servicesList>
</get:servicesList>
</get:getServicesListResponse>
</soapenv:Body>
</soapenv:Envelope>
2.39. getTerminalFeeList
Получить список комиссий терминала.
Запрос (getTerminalFeeListRequest)
Элемент
terminalId
Тип
boTerminalIdType
Описание
Идентификатор
терминала
Обязательность
+
Описание
Список комиссий
Обязательность
+
Ответ (getTerminalFeeListResponse)
Элемент
feeList
Тип
feeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTerminalFeeList/">
<soapenv:Header/>
<soapenv:Body>
<get:getTerminalFeeListRequest>
<get:terminalId>10000181</get:terminalId>
</get:getTerminalFeeListRequest>
</soapenv:Body>
</soapenv:Envelope>
56
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTerminalFeeList/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<get:getTerminalFeeListResponse>
<get:feeList>
<fee>
< feeType>Terminal maintenance - additional</feeType>
< feeValue>1</feeValue>
</fee>
<fee>
<feeType>Terminal maintenance</feeType>
<feeValue>1000</feeValue>
</fee>
<fee>
<feeType>Terminal registration</feeType>
<feeValue>1000</feeValue>
</fee>
</get:feeList>
</get:getTerminalFeeListResponse>
</soap:Body>
</soap:Envelope>
2.40. getTransactionDetailsB
Получить подробную информацию о транзакции.
Запрос (getTransactionDetailsBRequest)
Элемент
utrnno
Тип
utrnnoType
reversal
maskCardNumber
reversalType
boolean
Описание
Идентификатор
транзакции
Флаг отмены операции
Флаг маскирования
номеров карт в ответе
(по умолчанию false)
Обязательность
+
Описание
Параметры транзакции
Обязательность
+
+
-
Ответ (getTransactionDetailsBResponse)
Элемент
transaction
Тип
transactionDetailsBDataType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionDetailsB/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionDetailsBRequest>
<get:utrnno>1234215</get:utrnno>
<get:reversal>0</get:reversal>
</get:getTransactionDetailsBRequest>
</soapenv:Body>
</soapenv:Envelope>
57
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionDetailsB/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionDetailsBResponse>
<get:transaction>
<gen:cardNumber>4001000000000001</gen:cardNumber>
<gen:cardSequenceNumber>1</gen:cardSequenceNumber>
<gen:utrnno>1234215</gen:utrnno>
<gen:reversal>0</gen:reversal>
<gen:responseCode>00</gen:responseCode>
<gen:authorizationIdResponse>000000</gen:authorizationIdResponse>
<gen:processingCode>84000</gen:processingCode>
<gen:amount>10000</gen:amount>
<gen:currency>643</gen:currency>
</get:transaction>
</get:getTransactionDetailsBResponse>
</soapenv:Body>
</soapenv:Envelope>
2.41. getTransactions
Получить транзакционную историю.
Запрос (getTransactionsRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
period
transactionDateStrictPeriodType
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты и
ее срок действия
Временной период
Обязательность
+
Описание
Транзакции
Обязательность
+
+
Ответ (getTransactionsResponse)
Элемент
transactions
Тип
transactionsType
58
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactions/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</get:cardIdentification>
<get:period>
<gen:start>2015-04-01</gen:start>
<gen:end>2015-05-01</gen:end>
</get:period>
</get:getTransactionsRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactions/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsResponse>
<get:transactions>
<gen:transaction>
<gen:authorizationDate>2015-04-09T11:15:35+04:00</gen:authorizationDate>
<gen:transactionType>774</gen:transactionType>
<gen:operationDirection>debit</gen:operationDirection>
<gen:amount>10000</gen:amount>
<gen:currency>643</gen:currency>
<gen:amountInAccountCurrency>0</gen:amountInAccountCurrency>
<gen:utrnno>2203248</gen:utrnno>
<gen:transactionDescription>POS purchase</gen:transactionDescription>
<gen:feeDirection>debit</gen:feeDirection>
<gen:acquireFeeAmount>0</gen:acquireFeeAmount>
<gen:feIssuerFeeAmount>0</gen:feIssuerFeeAmount>
<gen:boIssuerFeeAmount>0</gen:boIssuerFeeAmount>
<gen:mcc>5999</gen:mcc>
<gen:merchantCountry>RUS</gen:merchantCountry>
<gen:merchantCity>MOSCOW1234512345123451234512345</gen:merchantCity>
<gen:merchantName>PREDPRINIMATEL</gen:merchantName>
<gen:merchantId>M999101</gen:merchantId>
<gen:terminalAddress>MERCHANT2 RUS MOSCOW ZEMLYANOI VAL 50/A</gen:terminalAddress>
<gen:authorizationIdResponse>000000</gen:authorizationIdResponse>
</gen:transaction>
</get:transactions>
</get:getTransactionsResponse>
</soapenv:Body>
</soapenv:Envelope>
59
2.42. getTransactionsB
Получить транзакционную историю.
Запрос (getTransactionsBRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
rowRange
period
responseCode
rowRangeType
transactionDateTimeLowerBound
edPeriodType
responseCodeInternalType
maskCardNumber
boolean
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Диапазон строк
Временной период
Обязательность
+
Внутренний код ответа
SVFE
Флаг маскирования
номеров карт в ответе
(по умолчанию false)
-
Описание
Транзакции
Обязательность
+
+
+
-
Ответ (getTransactionsBResponse)
Элемент
transactions
Тип
transactionsBType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionsB/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsBRequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000017</gen:cardNumber>
</get:cardIdentification>
<get:rowRange>
<gen:start>1</gen:start>
<gen:end>10</gen:end>
</get:rowRange>
<get:period>
<gen:start>2015-04-01</gen:start>
<gen:end>2015-05-01</gen:end>
</get:period>
</get:getTransactionsBRequest>
</soapenv:Body>
</soapenv:Envelope>
60
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionsB/" xmlns:gen="http://www.bpc.ru/apigate/
general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsBResponse>
<get:transactions>
<ns2:transaction>
<ns2:cardNumber>400001*0001</ns2:cardNumber>
<ns2:expiryDate>2020-12-31</ns2:expiryDate>
<ns2:cardSequenceNumber>0</ns2:cardSequenceNumber>
<ns2:utrnno>100053</ns2:utrnno>
<ns2:reversal>false</ns2:reversal>
<ns2:responseCode>-1</ns2:responseCode>
<ns2:transactionType>774</ns2:transactionType>
<ns2:transmissionDate>2019-11-02T01:28:18+03:00</ns2:transmissionDate>
<ns2:trace>000001</ns2:trace>
<ns2:localTransactionDate>2019-11-02T01:28:18+03:00</ns2:localTransactionDate>
<ns2:referenceNumber>000000100053</ns2:referenceNumber>
<ns2:authorizationIdResponse>100053</ns2:authorizationIdResponse>
<ns2:processingCode>000000</ns2:processingCode>
<ns2:amount>10000</ns2:amount>
<ns2:currency>810</ns2:currency>
<ns2:accountNumber>4000010000000001</ns2:accountNumber>
<ns2:terminalAddress>
<ns2:terminalId>M999101</ns2:terminalId>
<ns2:terminalCountry>RU</ns2:terminalCountry>
<ns2:terminalState>00</ns2:terminalState>
<ns2:terminalPostalCode>1234</ns2:terminalPostalCode>
<ns2:terminalCity>MOSCOW</ns2:terminalCity>
<ns2:terminalStreet>ZEMLYANOI VAL 50/A</ns2:terminalStreet>
<ns2:terminalName>MERCHANT2</ns2:terminalName>
</ns2:terminalAddress>
< ns2:mcc>6010</ns2:mcc>
</ns2:transaction>
</get:transactions>
</get:getTransactionsBResponse>
</soapenv:Body>
</soapenv:Envelope>
61
2.43. getTransactionsBO
Получить транзакционную историю.
Метод предоставляет транзакционную информацию о проведенных операциях в системе SVBO за
указанный период (не более 31-го дня).
В рамках запроса выводится информация:
 обо всех финансовых операциях из клиринга (VISA, MC, Diners, Amex GN, SV2SV), в том числе
несматченные с авторизациями;
 обо всех нефинансовых операциях из posting-файла;
 успешно обработанные авторизации из posting-файла, на которые еще не пришел клиринг.
Запрос (getTransactionsBORequest)
Элемент
cardIdentification
Тип
cardIdentificationType
period
transactionDateStrictPeriodType
Описание
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты и
ее срок действия
Временной период
Обязательность
+
Описание
Транзакции
Обязательность
+
+
Ответ (getTransactionsBOResponse)
Элемент
transactions
Тип
transactionsBOType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionsBO/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsBORequest>
<get:cardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</get:cardIdentification>
<get:period>
<gen:start>2015-04-01</gen:start>
<gen:end>2015-05-01</gen:end>
</get:period>
</get:getTransactionsBORequest>
</soapenv:Body>
</soapenv:Envelope>
62
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactions/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionsResponse>
<get:transactions>
<gen:transaction>
<gen:authorizationDate>2015-04-09T11:15:35+04:00</gen:authorizationDate>
<gen:transactionType>774</gen:transactionType>
<gen:reversalType>0</gen:reversalType>
<gen:operationDirection>debit</gen:operationDirection>
<gen:amount>10000</gen:amount>
<gen:currency>643</gen:currency>
<gen:amountInAccountCurrency>0</gen:amountInAccountCurrency>
<gen:utrnno>2203248</gen:utrnno>
<gen:transactionDescription>POS purchase</gen:transactionDescription>
<gen:feeDirection>debit</gen:feeDirection>
<gen:acquireFeeAmount>0</gen:acquireFeeAmount>
<gen:feIssuerFeeAmount>0</gen:feIssuerFeeAmount>
<gen:boIssuerFeeAmount>0</gen:boIssuerFeeAmount>
<gen:mcc>5999</gen:mcc>
<gen:merchantCountry>RUS</gen:merchantCountry>
<gen:merchantCity>MOSCOW1234512345123451234512345</gen:merchantCity>
<gen:merchantName>PREDPRINIMATEL</gen:merchantName>
<gen:merchantId>M999101</gen:merchantId>
<gen:terminalAddress>MERCHANT2 RUS MOSCOW ZEMLYANOI VAL 50/A</gen:terminalAddress>
<gen:authorizationIdResponse>000000</gen:authorizationIdResponse>
</gen:transaction>
</get:transactions>
</get:getTransactionsResponse>
</soapenv:Body>
</soapenv:Envelope>
2.44. getTransactionStatus
Получить статус транзакции.
Запрос (getTransactionStatusRequest)
Элемент
utrnno
Тип
utrnnoType
extId
extIdType
reversal
reversalType
Описание
Идентификатор
транзакции
Внешний
идентификатор
транзакции
Флаг отмены операции
Обязательность
-
+
63
Ответ (getTransactionStatusResponse)
Элемент
utrnno
Тип
utrnnoType
responseCode
responseCodeType
responseCodeDescription
responseCodeDescription
Описание
Идентификатор
транзакции
Идентификатор
состояния запроса в
APIGATE.
Возможные значения:
-3 – Transaction not
found by SVFE
-2 – Unknown status
0 – транзакция не
завершена 99 –
транзакция завершена
75 – транзакция
прервана по внутренней
ошибке.
Описание кода ответа
SVFE
Обязательность
+
+
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionStatus/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionStatusRequest>
<get:utrnno>123456</get:utrnno>
<get:reversal>0</get:reversal>
</get:getTransactionStatusRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.bpc.ru/apigate/command/getTransactionStatus/">
<soapenv:Header/>
<soapenv:Body>
<get:getTransactionStatusResponse>
<get:utrnno>123456</get:utrnno>
<get:responseCode>99</get:responseCode>
<get:responseCodeDescription>Successful transaction</get:responseCodeDescription>
</get:getTransactionStatusResponse>
</soapenv:Body>
</soapenv:Envelope>
64
2.45. miniStatement
Получить мини-выписку.
Запрос (miniStatementRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Обязательность
-
Описание
Записи мини-выписки
Обязательность
-
+
Ответ (miniStatementResponse)
Элемент
miniStatementRecords
Тип
miniStatementRecordType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:min="http://www.bpc.ru/apigate/command/miniStatement/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<min:miniStatementRequest>
<min:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</min:cardIdentification>
</min:miniStatementRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:min="http://www.bpc.ru/apigate/command/miniStatement/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<min:miniStatementResponse>
<min:miniStatementRecords>
<min:miniStatementRecord>
<min:transactionDate>2016-01-01T09:01:01+04:00</min:transactionDate>
<min:transactionType>010000</min:transactionType>
<min:debitCreditIndicator>debit</min:debitCreditIndicator>
<min:amount>10000</min:amount>
<min:currency>643</min:currency>
<min:terminalIdentification>T00000000000001</min:terminalIdentification>
<min:cardAcceptorNameAndLocation>Lenina ave. 56a Volgograd
RU</min:cardAcceptorNameAndLocation>
<min:authorizationIdResponse>123456</min:authorizationIdResponse>
</min:miniStatementRecord>
</min:miniStatementRecords>
</min:miniStatementResponse>
</soap:Body>
</soap:Envelope>
65
66
2.46. p2pTransfer
Выполнить перевод между счетами двух карт.
Запрос (p2pTransferRequest)
Элемент
extId
Тип
extIdType
sourceCardIdentification
cardIdentificationType
destinationCardIdentification
cardIdentificationType
amount
currency
sourceAccountNumber
amountType
currencyN3CodeType
accountNumberType
destinationAccountNumber
accountNumberType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации
дебетуемой карты.
Необходимо указать
номер и срок действия
карты
Параметры
идентификации
кредитуемой карты.
Необходимо указать
номер карты
Сумма
Валюта
Номер счета
дебетуемой карты
Номер счета
кредитуемой карты
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
-
-
+
+
-
Ответ (p2pTransferResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
+
+
+
+
+
67
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:p2p="http://www.bpc.ru/apigate/command/p2pTransfer/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<p2p:p2pTransferRequest>
<p2p:sourceCardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</p2p:sourceCardIdentification>
<p2p:destinationCardIdentification>
<gen:cardNumber>4000010000000001</gen:cardNumber>
</p2p:destinationCardIdentification>
<p2p:amount>10000</p2p:amount>
<p2p:currency>643</p2p:currency>
</p2p:p2pTransferRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:p2p="http://www.bpc.ru/apigate/command/p2pTransfer/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<p2p:p2pTransferResponse>
<responseCode>00</responseCode>
<processingCode>490000</processingCode>
<systemTraceAuditNumber>584129</systemTraceAuditNumber>
<localTransactionDate>2017-03-15T18:25:10+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123456</authorizationIdResponse>
</p2p:p2pTransferResponse>
</soap:Body>
</soap:Envelope>
68
2.47. purchase
Оплатить покупку.
Запрос (purchaseRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
amount
currency
cardAcceptorParameters
pointOfServiceDataCode
amountType
currencyN3CodeType
cardAcceptorParametersType
pointOfServiceDataCodeType
pointOfServiceConditionCode
pointOfServiceConditionCodeType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Сумма
Валюта
Параметры терминала
Набор кодов,
определяющих
возможности
терминала, параметры
его окружения и
использование средств
защиты при проведении
транзакции.
Код, определяющий
условия проведения
транзакции в точке
обслуживания
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
+
-
-
Ответ (purchaseResponse)
Является элементом типа financialTransactionResponseType.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
+
+
+
+
+
69
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:pur="http://www.bpc.ru/apigate/command/purchase/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<pur:purchaseRequest>
<pur:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</pur:cardIdentification>
<pur:amount>10000</pur:amount>
<pur:currency>643</pur:currency>
</pur:purchaseRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:pur="http://www.bpc.ru/apigate/command/purchase/" xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<pur:purchaseResponse>
<responseCode>00</responseCode>
<processingCode>0</processingCode>
<systemTraceAuditNumber>584143</systemTraceAuditNumber>
<localTransactionDate>2017-03-15T18:39:06+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123456</authorizationIdResponse>
</pur:purchaseResponse>
</soap:Body>
</soap:Envelope>
70
2.48. resetPinCounter
Сбросить счетчик неверных попыток ввода PIN.
Запрос (resetPinCounterRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Необходимо указать
номер или
идентификатор карты
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
Ответ (resetPinCounterResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:res="http://www.bpc.ru/apigate/command/resetPinCounter/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<res:resetPinCounterRequest>
<res:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</res:cardIdentification>
</res:resetPinCounterRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:res="http://www.bpc.ru/apigate/command/resetPinCounter/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<res:resetPinCounterResponse>
<responseCode>00</responseCode>
</res:resetPinCounterResponse>
</soap:Body>
</soap:Envelope>
71
2.49. reversal
Отменить операцию.
Запрос (reversalRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
amount
currency
processingCode
systemTraceAuditNumber
transactionDate
rrn
amountType
currencyN3CodeType
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
serviceId
cardAcceptorParameters
pointOfServiceDataCode
serviceIdType
cardAcceptorParametersType
pointOfServiceDataCodeType
pointOfServiceConditionCode
pointOfServiceConditionCodeType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (маскированный
номер карты и
идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Сумма
Валюта
Код обработки
Номер записи аудита
Дата/время транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Идентификатор сервиса
Параметры терминала
Набор кодов,
определяющих
возможности
терминала, параметры
его окружения и
использование средств
защиты при проведении
транзакции.
Код, определяющий
условия проведения
транзакции в точке
обслуживания
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Обязательность
+
+
+
+
+
+
+
+
+
-
-
Ответ (reversalResponse)
Элемент
responseCode
Тип
responseCodeType
processingCode
systemTraceAuditNumber
transactionDate
processingCodeType
systemTraceAuditNumberType
transactionDateType
+
+
+
72
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:rev="http://www.bpc.ru/apigate/command/reversal/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<rev:reversalRequest>
<rev:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
<gen:expDate>202012</gen:expDate>
</rev:cardIdentification>
<rev:amount>10000</rev:amount>
<rev:currency>643</rev:currency>
<rev:processingCode>270000</rev:processingCode>
<rev:systemTraceAuditNumber>982923</rev:systemTraceAuditNumber>
<rev:transactionDate>2015-02-10T14:23:22</rev:transactionDate>
<rev:rrn>987654321987</rev:rrn>
<rev:authorizationIdResponse>123ABC</rev:authorizationIdResponse>
</rev:reversalRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:rev="http://www.bpc.ru/apigate/command/reversal/" xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<rev:reversalResponse>
<rev:responseCode>00</rev:responseCode>
<rev:processingCode>270000</rev:processingCode>
<rev:systemTraceAuditNumber>982923</rev:systemTraceAuditNumber>
<rev:transactionDate>2015-02-10T14:23:22+04:00</rev:transactionDate>
</rev:reversalResponse>
</soap:Body>
</soap:Envelope>
73
2.50. refund
Выполнить возврат средств.
Метод поддерживает возможность проверки статуса транзакции. Для проверки статуса необходимо
отправить запрос идентичный первому запросу инициирующему транзакцию, добавив элемент
originalTransactionParameters со значениями полученными в ответе на начальный запрос
Запрос (refundRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
amount
currency
accountNumber
accountType
originalTransactionParamete
rs
amountType
currencyN3CodeType
accountNumberType
accountTypeType
originalTransactionParametersTy
pe
cardAcceptorParameters
pointOfServiceDataCode
cardAcceptorParametersType
pointOfServiceDataCodeType
pointOfServiceConditionCode
pointOfServiceConditionCodeType
Описание
Параметры
идентификации карты.
Необходимо указать
срок действия карты, а
также (номер карты)
или (штрих-код) или
(маскированный номер
карты и номер
мобильного телефона)
Сумма
Валюта
Номер счета
Тип счета
Параметры
оригинальной
транзакции,
используемые в запросе
проверки статуса
Параметры терминала
Набор кодов,
определяющих
возможности
терминала, параметры
его окружения и
использование средств
защиты при проведении
транзакции.
Код, определяющий
условия проведения
транзакции в точке
обслуживания
Обязательность
+
Описание
Код завершения
операции SVFE. Список
возможных значений см.
в таблице Коды ответов в
колонке «Код ответа ISO»
Код обработки
Номер записи аудита
Дата транзакции
Идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
-
-
-
Ответ (refundResponse)
Элемент
responseCode
Тип
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
authorizationIdResponse
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponseType
+
+
+
+
+
74
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ref="http://www.bpc.ru/apigate/command/refund/" xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<ref:refundRequest>
<ref:cardIdentification>
<gen:cardNumberMask>4000010000000003</gen:cardNumberMask>
<gen:expDate>202012</gen:expDate>
</ref:cardIdentification>
<ref:amount>10000</ref:amount>
<ref:currency>643</ref:currency>
</ref:refundRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ref:refundResponse xmlns:ref="http://www.bpc.ru/apigate/command/refund/"
xmlns="http://www.bpc.ru/apigate/general/">
<responseCode>00</responseCode>
<processingCode>200000</processingCode>
<systemTraceAuditNumber>919715</systemTraceAuditNumber>
<localTransactionDate>2017-10-25T12:52:21+04:00</localTransactionDate>
<rrn>987654321987</rrn>
<authorizationIdResponse>123456</authorizationIdResponse>
</ref:refundResponse>
</soap:Body>
</soap:Envelope>
2.51. sendOtp
Создать одноразовый пароль и отправить его на телефон привязанный к карте.
Запрос (sendOtpRequest)
Элемент
cardIdentification
Тип
cardIdentificationType
Описание
Параметры
идентификации карты.
Необходимо указать
срок действия карты, а
также (номер карты)
или (штрих-код) или
(маскированный номер
карты и номер
мобильного телефона)
Обязательность
+
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
Ответ (sendOtpResponse)
Элемент
responseCode
Тип
responseCodeType
75
transactionId
sendOtpTransIdType
phoneMask
sendOtpPhoneMaskType
Идентификатор (только
если responseCode = 0
или 00).
Маскированный номер
телефона (только если
responseCode = 0 или
00).
-
-
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://www.bpc.ru/apigate/command/sendOtp/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<ser:sendOtpRequest>
<ser:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</ser:cardIdentification>
</ser:sendOtpRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://www.bpc.ru/apigate/command/sendOtp/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<ser:sendOtpResponse>
<responseCode>00</responseCode>
<transactionId>012345</transactionId>
<phoneMask>8903***1234</phoneMask>
</ser:sendOtpResponse>
</soap:Body>
</soap:Envelope>
2.52. serviceAction
Выполнить действие над сервисом.
Изменение сервиса производится в системе SVFE и выгружаются в систему SVBO в постинг файле.
Запрос (serviceActionRequest)
Элемент
extId
Тип
extIdType
serviceIdentification
serviceIdentificationType
actionCode
cardIdentification
actionCodeType
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Идентификационные
данные сервиса
Код действия
Параметры
идентификации карты.
Необходимо указать
Обязательность
-
+
+
+
76
accountNumber
serviceParameters
accountNumberType
serviceParametersType
срок действия карты, а
также (номер карты)
или (штрих-код) или
(маскированный номер
карты и номер
мобильного телефона)
Номер счета
Параметры сервиса
-
Ответ (serviceActionResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://www.bpc.ru/apigate/command/serviceAction/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<ser:serviceActionRequest>
<ser:serviceIdentification>
<gen:serviceType>7</gen:serviceType>
<gen:serviceId>300</gen:serviceId>
<gen:serviceObjectType>SERVICE_OBJECT_CARD</gen:serviceObjectType>
</ser:serviceIdentification>
<ser:actionCode>ACTION_CODE_ADD</ser:actionCode>
<ser:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</ser:cardIdentification>
</ser:serviceActionRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://www.bpc.ru/apigate/command/serviceAction/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<ser:serviceActionResponse>
<responseCode>00</responseCode>
</ser:serviceActionResponse>
</soap:Body>
</soap:Envelope>
77
2.53. validateCard
Смена статуса карты (разблокировка/активация, карта изначально должна иметь статус отличный от
«VALID CARD»).
Запрос (validateCardRequest)
Элемент
extId
Тип
extIdType
cardIdentification
cardIdentificationType
Описание
Внешний
идентификатор
транзакции
Параметры
идентификации карты.
Возможные варианты
идентификации карты:
(номер карты) или
(идентификатор карты)
или (маскированный
номер карты и
идентификатор
держателя карты) или
(маскированный номер
карты и номер
мобильного телефона)
Обязательность
-
Описание
Код завершения
операции SVFE. Список
возможных значений
см. в таблице Коды
ответов в колонке «Код
ответа ISO»
Обязательность
+
+
Ответ (validateCardResponse)
Является элементом типа simpleResponseType.
Элемент
Тип
responseCode
responseCodeType
Пример запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:val="http://www.bpc.ru/apigate/command/validateCard/"
xmlns:gen="http://www.bpc.ru/apigate/general/">
<soapenv:Header/>
<soapenv:Body>
<val:validateCardRequest>
<val:cardIdentification>
<gen:cardNumber>4000010000000003</gen:cardNumber>
</val:cardIdentification>
</val:validateCardRequest>
</soapenv:Body>
</soapenv:Envelope>
78
Пример ответа:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:val="http://www.bpc.ru/apigate/command/validateCard/"
xmlns="http://www.bpc.ru/apigate/general/">
<soap:Body>
<val:validateCardResponse>
<responseCode>00</responseCode>
</val:validateCardResponse>
</soap:Body>
</soap:Envelope>
79
3. Составные типы
3.1.
accountDataType
Параметры счета.
Элемент
number
currency
balance
customerId
cardAccountSequentialNum
ber
3.2.
Тип
accountNumberType
currencyN3CodeType
amountType
customerIdType
cardAccountSequentialNumberTy
pe
Обязательность
+
+
+
+
+
Описание
Перечень карт,
относящихся к данному
счету
Обязательность
+
Описание
Номер карты
Маскированный номер
карты
Срок действия карты
Идентификатор карты
Статус карты
Тип карты
Эмбоссированное имя
Идентификатор клиента
Идентификатор
держателя карты
Номер телефона
клиента
Количество неудачных
попыток ввода ПИНа
Номер пластика
Описание статуса карты
Признак того, является
ли карта основной
Признак того, привязана
ли карта к клиенту
Признак того, является
ли клиент держателем
карты
Обязательность
+ (один из двух
вариантов)
accountDataDetailedType
Детальные параметры счета. Расширяет тип accountDataType.
Элемент
Тип
cards
cardsType
3.3.
Описание
Номер счета
Валюта счета
Баланс счета
Идентификатор клиента
Порядковый номер
карточного счета
cardDataType
Параметры карты.
Элемент
cardNumber
cardNumberMask
Тип
cardNumberType
maskedCardNumberType
expiryDate
cardId
hotCardStatus
cardTypeName
embossedName
customerId
personId
cardExpDateType
cardIdType
hotCardStatusType
cardTypeNameType
embossedNameType
customerIdType
personIdType
phoneNumber
phoneNumberType
pinDenialCounter
pinDenialCounterType
plasticNumber
hotCardStatusDescription
cardIsPrimary
cardPlasticNumberType
hotCardStatusDescriptionType
boolean
cardBindToCustomer
boolean
customerIsCardholder
boolean
-
80
3.4.
cardDataDetailedType
Детальные параметры карты. Расширяет тип cardDataType
Элемент
Тип
accounts
accountsType
3.5.
cardNumberMask
maskedCardNumberType
cardId
expiryDate
embossedName
plasticNumber
phoneNumber
cardIdType
cardExpDateType
embossedNameType
cardPlasticNumberType
phoneNumberType
cardholderId
customerId
barCode
cvv2
cardholderIdType
customerIdType
barCodeType
cvv2Type
Тип
cardNumberType
maskedCardNumberType
expiryDate
authenticationFlag
cardExpDateType
string
Список карт.
Элемент
cardList
3.8.
Обязательность
- (один из трех
вариантов)
Описание
Номер карты
Маскированный номер
карты
Срок действия карты
Флаг аутентификации
карты
Обязательность
+ (один из двух
вариантов)
Описание
Список карт
Обязательность
-
-
+
cardListType
Тип
cardListElement
changeCardStatusRequestType
Расширяет тип simpleIsoRequestType.
Элемент
Тип
cardIdentification
cardIdentificationType
hotCardStatus
Описание
Номер карты
Последние цифры
номера карты
Маскированный номер
карты
Идентификатор карты
Срок действия карты
Эмбоссированное имя
Номер пластика
Номер телефона
клиента
Идентификатор клиента
Идентификатор клиента
Штрих-код
CVV2
cardListElement
Элемент списка карт.
Элемент
cardNumber
cardNumberMask
3.7.
Обязательность
+
cardIdentificationType
Параметры идентификации карты.
Элемент
Тип
cardNumber
cardNumberType
cardLastDigitMask
cardLastDigitMaskType
3.6.
Описание
Перечень счетов,
относящихся к данной
карте
hotCardStatusType
Описание
Параметры
идентификации карты
Статус карты
Обязательность
+
+
81
3.9.
customFieldsDataType
Параметры пользовательских полей карты.
Элемент
Тип
fieldName
customFieldNameType
fieldDescription
customFieldDescriptionType
dataType
customFieldsDataTypeType
value
customFieldValueType
Описание
Наименование поля
Описание поля
Тип данных
Значение поля
Обязательность
-
Описание
Параметры
пользовательских полей
карты
Обязательность
-
Тип
customerIdType
addressType
memorableWordType
phoneNumberType
emailType
Описание
Идентификатор клиента
Адрес
Секретное слово
Телефон
E-mail
Обязательность
+
+
-
Тип
string
decimal
Описание
Тип комиссии
Ставка комиссии
Обязательность
+
+
3.10. customFieldsType
Список пользовательских полей карты.
Элемент
Тип
customFields
customFieldsDataType
3.11. customerType
Параметры клиента.
Элемент
customerId
address
memorableWord
phone
Email
3.12. feeType
Параметры комиссии.
Элемент
feeType
feeValue
3.13. financialTransactionResponseType
Параметры финансовой транзакции.
Элемент
Тип
responseCode
responseCodeType
processingCode
systemTraceAuditNumber
localTransactionDate
rrn
processingCodeType
systemTraceAuditNumberType
transactionDateType
rrnType
authorizationIdResponse
authorizationIdResponseType
Описание
Код завершения
операции SVFE
Код обработки
Номер записи аудита
Дата транзакции
Внешний
идентификатор RRN
Идентификатор
авторизации
Обязательность
+
+
+
+
+
+
82
3.14. limitBaseDataType
Основные параметры лимита.
Элемент
Тип
name
limitNameType
startDate
limitEdgeDateType
endDate
limitEdgeDateType
value
currentValue
limitValueType
limitValueType
cycleType
cycleLength
currency
limitCycleTypeType
limitCycleLengthType
currencyN3CodeType
Описание
Имя лимита в SVBO
Дата начала действия
лимита
Дата окончания
действия лимита
Значение лимита
Текущее значение
лимита
Тип цикла
Длина цикла
Валюта
Обязательность
+
-
Описание
Имя лимита в SVBO
Дата начала действия
лимита
Дата окончания
действия лимита
Значение лимита
Тип цикла
Длина цикла
Обязательность
+
+
+
-
3.15. limitExceptionType
Параметры исключения лимита.
Элемент
Тип
limitName
limitNameType
startDate
limitEdgeDateType
endDate
limitEdgeDateType
value
cycleType
cycleLength
limitValueType
limitCycleTypeType
limitCycleLengthType
+
+
-
3.16. limitFullDataType
Детальные параметры лимита. Расширяет тип limitBaseDataType
Элемент
Тип
Описание
limitExceptions
limitExceptionType
Исключения лимита
Обязательность
+
3.17. limitsType
Перечень лимитов
Элемент
limit
Тип
limitFullDataType
Описание
Перечень лимитов
Обязательность
-
3.18. merchantType
Данные мерчанта
Элемент
id
status
name
contractId
contractDescription
contractStatus
Тип
merchantIdType
string
string
string
string
string
Описание
Идентификатор мерчанта
Статус мерчанта
Наименование мерчанта
Идентификатор контракта мерчанта
Описание контракта мерчанта
Статус контракта мерчанта
Обязательность
+
+
+
+
+
+
83
3.19. miniStatementRecordType
Запись мини-выписки
Элемент
transactionDate
transactionDate
debitCreditIndicator
amount
currency
terminalIdentification
Тип
transactionDateType
miniStatementTransactionTypeTy
pe
debitCreditIndicatorType
amountType
currencyN3CodeType
terminalIdentificationType
Описание
Дата транзакции
Тип транзакции
Обязательность
+
+
Направление операции
Сумма операции
Валюта транзакции
Идентификатор
терминала
Адрес терминала
+
+
+
+
cardAcceptorNameAndLoca
tion
authorizationIdResponse
cardAcceptorNameAndLocationT
ype
authorizationIdResponseType
Идентификатор
авторизации
+
Описание
Обязательность
+
+
Описание
Имя отправителя
Адрес
Город
Страна
Почтовый индекс
Обязательность
-
Описание
Идентификатор
держателя карты
Имя
Отчество
Фамилия
Дата рождения
Обязательность
+
Описание
Номер начальной строки
Номер конечной строки
Обязательность
+
+
+
3.20. personalDataType
Персональные данные
Элемент
firstName
lastName
Тип
firstNameType
surnameType
3.21. personMoneySendType
Элемент
name
street
city
country
postalCode
Тип
string
string
string
string
String
3.22. personType
Параметры держателя карты.
Элемент
Тип
personId
personIdType
firstName
secondName
surname
birthDate
firstNameType
secondNameType
surnameType
birthDateType
+
+
-
3.23. rowRangeType
Диапазон выборки данных.
Элемент
Тип
start
unsignedLong
End
unsignedLong
84
3.24. serviceIdentificationType
Параметры идентификации сервиса.
Элемент
Тип
serviceType
serviceTypeType
serviceId
serviceIdType
serviceObjectType
serviceObjectTypeType
Описание
Тип сервиса
Идентификатор сервиса
Объект, к которому может быть
привязан сервис
Обязательность
+
+
+
Описание
Номер телефона
E-mail
Номер телефона/Электронная
почта
Минимальная сумма для
нотификации
Валюта для нотификации
Обязательность
-
Описание
Идентификация сервиса
Номер телефона/Электронная
почта
Номер сервиса
Минимальная сумма для
нотификации
Валюта для нотификации
Обязательность
-
Описание
Параметры сервисов
Обязательность
-
3.25. serviceParametersType
Параметры сервиса.
Элемент
phoneNumber
email
extNumber
Тип
phoneNumberType
emailType
extNumberType
notificationLimitAmount
notificationLimitAmountType
notificationLimitCurrency
notificationLimitCurrencyType
-
3.26. servicesListDataType
Параметры сервисов, подключенных к карте.
Элемент
Тип
serviceIdentificationType serviceIdentificationType
extNumber
extNumberType
serviceNum
notificationLimitAmount
serviceNumType
notificationLimitAmountType
notificationLimitCurrency
notificationLimitCurrencyType
-
3.27. servicesListType
Список сервисов, подключенных к карте.
Элемент
Тип
servicesList
servicesListDataType
3.28. simpleIsoRequestType
ISO-запрос веб-сервиса.
Элемент
Тип
extId
extIdType
Описание
Внешний идентификатор транзакции
Обязательность
-
3.29. simpleResponseType
Простой ответ веб-сервиса.
Элемент
Тип
responseCode
responseCodeType
Описание
Код завершения операции SVFE. Список
возможных значений см. в таблице Коды ответов
в колонке «Код ответа ISO»
Обязательность
+
85
3.30. terminalType
Данные терминала.
Элемент
Тип
id
boTerminalIdType
type
string
registrationDate
date
address
string
status
string
feeValue
decimal
Описание
Идентификатор терминала
Тип терминала
Дата регистрации терминала
Адрес
Статус терминала
Ежемесячная комиссия за обслуживание
терминала
Обязательность
+
+
-
3.31. transactionBDataType
Параметры транзакции.
Элемент
cardNumber
expiryDate
cardSequenceNumber
utrnno
Тип
maskedCardNumberType
date
cardPlasticNumberType
utrnnoType
reversal
responseCode
transactionType
transmissionDate
reversalType
responseCodeInternalType
transactionTypeType
transactionDateType
trace
traceType
localTransactionDate
transactionDateType
referenceNumber
authorizationIdResponse
processingCode
amount
currency
accountNumber
mcc
referenceNumberType
authorizationIdResponseType
processingCodeType
amountType
currencyN3CodeType
accountNumberType
mccType
Описание
Маскированный номер карты
Срок действия карты
Номер пластика
Идентификатор транзакции в
SVFE
Флаг реверсала
Внутренний код ответа SVFE
Тип транзакции
Время отправки транзакции
устройством
Отметка, выставляемая сетью
или хостом
Время получения транзакции
SVFE
Идентификатор авторизации
Код обработки
Сумма транзакции
Код валюты транзакции
Номер счета
MCC
Обязательность
+
+
+
-
3.32. transactionDetailsBDataType
Детальные параметры транзакции. Расширяет тип transactionBDataType
Элемент
Тип
Описание
cardAcceptorTerminalId
string
Идентификатор терминала
cardAcceptorCode
string
Идентификатор мерчанта
cardAcceptorNameAndCode string
Страна мерчанта
Обязательность
-
86
3.33. transactionDataType
Параметры транзакции.
Элемент
boWriteOffDate
authorizationDate
transactionType
operationDirection
amount
currency
amountInAccountCurrency
utrnno
Тип
dateTime
dateTime
transactionTypeType
debitCreditIndicatorType
amountType
currencyN3CodeType
amountType
utrnnoType
transactionDescription
feeDirection
acquireFeeAmount
string
debitCreditIndicatorType
amountType
feIssuerFeeAmount
amountType
boIssuerFeeAmount
amountType
mcc
merchantCountry
merchantCity
merchantName
merchantId
terminalAddress
posDataCode
authorizationIdResponse
mccType
string
string
string
merchantIdType
string
posDataCodeType
authorizationIdResponse
Type
transactionDateType
reversalDate
Описание
Дата и время списания в SVBO
Дата и время авторизации
Тип транзакции
Направление транзакции
Сумма операции
Валюта операции
Сумма операции в валюте счета
Идентификатор транзакции в
SVFE
Описание транзакции
Направление комиссии
Сумма эквайерской комиссии,
расчитанная по операции в
SVFE
Сумма эмитентской комиссии,
расчитанная по операции в
SVFE
Сумма эмитентской комиссии,
расчитанная по операции в
SVBO
MCC
Страна мерчанта
Город мерчанта
Название мерчанта
Идентификатор мерчанта
Адрес терминала
Обязательность
+
+
+
+
+
+
+
-
-
-
Идентификатор авторизации
-
Дата и время реверсала
-
87
3.34. transactionBODataType
Параметры транзакции.
Элемент
boWriteOffDate
Тип
dateTime
authorizationDate
dateTime
authorizationStatus
reversalType
transactionType
authorizationStatus
reversalType
transactionTypeType
transactionTypeBO2
transactionTypeBO2Type
operationDirection
debitCreditIndicatorType
amount
currency
amountInAccountCurrency
amountType
currencyN3CodeType
amountType
utrnno
utrnnoType
transactionDescription
feeDirection
acquireFeeAmount
string
debitCreditIndicatorType
amountType
feIssuerFeeAmount
amountType
boIssuerFeeAmount
amountType
mcc
merchantCountry
merchantCity
merchantName
merchantId
mccType
string
string
string
merchantIdType
terminalAddress
posDataCode
authorizationIdResponse
string
posDataCodeType
authorizationIdResponseType
reversalDate
transactionDateType
Описание
Дата и время списания в
SVBO
Дата и время
авторизации
Статус авторизации
Флаг реверсала
Тип транзакции.
Обязательно
присутствует либо это
поле, либо
transactionTypeBO2.
Тип транзакции BO2.
Обязательно
присутствует либо это
поле, либо
transactionType.
Направление
транзакции
Сумма операции
Валюта операции
Сумма операции в
валюте счета
Идентификатор
транзакции в SVFE
Описание транзакции
Направление комиссии
Сумма эквайерской
комиссии, расчитанная
по операции в SVFE
Сумма эмитентской
комиссии, расчитанная
по операции в SVFE
Сумма эмитентской
комиссии, расчитанная
по операции в SVBO
MCC
Страна мерчанта
Город мерчанта
Название мерчанта
Идентификатор
мерчанта
Адрес терминала
Идентификатор
авторизации
Дата и время реверсала
Обязательность
+
-
-
+
+
+
+
+
-
-
-
-
3.35. transactionDatePeriodType
Диапазон дат с нестрогими границами.
Элемент
Тип
Описание
Обязательность
88
start
end
date
date
Дата начала
Дата окончания
-
3.36. transactionDateStrictPeriodType
Диапазон дат со строгими границами. Ограничивает тип transactionDatePeriodType.
Элемент
Тип
Описание
start
date
Дата начала
end
date
Дата окончания
Обязательность
+
+
3.37. transactionDateLowerBoundedPeriodType
Диапазон дат со строго ограниченным началом. Ограничивает тип transactionDatePeriodType.
Элемент
Тип
Описание
Обязательность
start
date
Дата начала
+
end
date
Дата окончания
-
3.38. transactionDateTimePeriodType
Временной диапазон с нестрогими границами.
Элемент
Тип
start
dateTime
end
dateTime
Описание
Дата/время начала
Дата/время окончания
Обязательность
-
3.39. transactionDateTimeStrictPeriodType
Временной диапазон со строгими границами. Ограничивает тип transactionDateTimePeriodType.
Элемент
Тип
Описание
Обязательность
start
dateTime
Дата/время начала
+
end
dateTime
Дата/время окончания
+
3.40. transactionDateTimeLowerBoundedPeriodType
Временной диапазон со строго ограниченным началом. Ограничивает тип transactionDateTimePeriodType.
Элемент
Тип
Описание
Обязательность
start
dateTime
Дата/время начала
+
End
dateTime
Дата/время окончания
-
3.41. transactionsType
Список транзакций.
Элемент
transaction
Тип
transactionDataType
Описание
Параметры транзакции
Обязательность
-
Описание
Параметры транзакции
Обязательность
-
Описание
Параметры транзакции
Обязательность
-
3.42. transactionsBOType
Список транзакций.
Элемент
transaction
Тип
transactionBODataType
3.43. transactionsBType
Список транзакций.
Элемент
transaction
Тип
transactionBDataType
89
90
3.44. virtualCardIdentificationType
Диапазон дат с нестрогими границами.
Элемент
Тип
cardNumber
cardNumberType
cardNumberMask
maskedCardNumberType
expiryDate
productType
barCode
cvv2
cardExpDateType
productTypeType
barCodeType
cvv2Type
Описание
Номер карты
Маскированный номер
карты
Срок действия карты
Тип продукта
Штрих-код
CVV2
Обязательность
-
Описание
Параметры счета
Обязательность
-
Описание
Идентификатор
терминала
Идентификатор
продавца
Код категории
продавца(MCC)
Адрес расположения
терминала
Обязательность
+
+
+
-
3.45. accountsType
Перечень счетов.
Элемент
accountData
Тип
accountDataType
3.46. cardAcceptorParametersType
Параметры терминала.
Элемент
terminalIdentification
merchantIdentification
Тип
cardAcceptorTerminalIdentificati
onType
merchantIdType
merchantType
mccType
nameAndLocation
cardAcceptorNameAndLocationT
ype
+
+
-
3.47. originalTransactionParametersType
Параметры оригинальной транзакции
Элемент
Тип
systemTraceAuditNumber
systemTraceAuditNumberType
localTransactionDate
rrn
transactionDateType
rrnType
Описание
Номер записи аудита
Обязательность
+
Дата транзакции
Внешний
идентификатор RRN
+
+
Описание
Параметры карты
Обязательность
+
3.48. cardsType
Перечень карт.
Элемент
cardData
Тип
cardDataType
91
4. Простые типы
Наименование
accountIndexType
Тип
Ограничения
Описание
unsignedS
hort
string
value = 0..9
Порядковый номер счета
length = 1..32
Номер счета
accountNumberLastDigitMaskT
ype
string
length = 4
accountStatusType
int
value = 1..9999
Маска номера счета,
представленная 4 последними
цифрами
Статус счета
accountTypeType
string
enumeration
actionCodeType
string
enumeration
addressType
string
Тип счета
 ACCOUNT_TYPE_DEFAULT
 ACCOUNT_TYPE_SAVING
 ACCOUNT_TYPE_CHECKING
 ACCOUNT_TYPE_CREDIT
 ACCOUNT_TYPE_FIRST_OTHERS
 ACCOUNT_TYPE_LOANS
 ACCOUNT_TYPE_ENVELOPE
 ACCOUNT_TYPE_ESCROW
 ACCOUNT_TYPE_MONEY_MARK
ET
 ACCOUNT_TYPE_LOYALTY
Код действия
 ACTION_CODE_ADD
 ACTION_CODE_UDPATE
 ACTION_CODE_DELETE
 ACTION_CODE_CHECK
 ACTION_CODE_CHANGE_ACCESS
 ACTION_CODE_CHECK_PARAME
TERS
 ACTION_CODE_RESTORE_PARA
METERS
 ACTION_CODE_INQUIRE
 ACTION_CODE_ACTION
Адрес
amountType
integer
Сумма
authorizationIdResponseType
string
authorizationStatus
string
barCodeType
string
birthDateType
date
boTerminalIdType
string
length = 0..8
Идентификатор терминала в BO
cardAcceptorNameAndLocation
Type
cardAccountSequentialNumber
Type
cardExpDateType
string
length = 0..30
Адрес терминала
int
value = 0..99
string
cardholderIdType
string
length = 6
pattern = (1|2)
[0-9]{3}((1[02])|(0[1-9]))
length = 1..20
Порядковый номер карточного
счета
Срок действия карты
accountNumberType
length = 0..6
Идентификатор авторизации
Статус авторизации
pattern = [0-9]
{1,15}
Штрих-код
Дата рождения
Идентификатор держателя карты
92
Наименование
Тип
Ограничения
Описание
cardIdType
string
Идентификатор карты
cardLastDigitMaskType
string
pattern = [1-9]
[0-9]{0,11}
length = 4
cardNumberType
string
cardPlasticNumberType
int
pattern = [0-9]
{13,19}
value = 0..999
cardTypeNameType
string
length = 0..32
Тип карты
checkOtpOtpType
string
length=6
One time pass (OTP)
currencyN3CodeType
int
value = 0..999
Код валюты
customerIdType
string
length = 1..20
Идентификатор клиента
customFieldDataTypeType
string
Тип данных
customFieldDescriptionType
string
Описание поля
customFieldNameType
string
Наименование поля
customFieldValueType
string
Значение поля
cvv2Type
string
debitCreditIndicatorType
string
pattern = [0-9]
{3}
enumeration
emailType
string
length = 0..100
Направление операции
 credit
 debit
 noop
E-mail
embossedNameType
string
length = 0..26
Эмбоссированное имя
encryptedPinDataType
string
Строка HEX-символов,
содержащая зашифрованный PIN
entitySelectionMode
string
pattern =
[AaBbCcDdEeFf
0-9]{16}
enumeration
extIdType
unsignedL
ong
extNumberType
string
length =
1..9999999999
99
length = 0..256
firstNameType
string
length = 0..32
hotCardStatusDescriptionType
string
hotCardStatusType
int
length = 2
Статус карты
limitCycleLengthType
length = 0..999
Длина цикла
value = 0..12
Тип цикла. См. Типы циклов
limitEdgeDateType
unsignedS
hort
unsignedS
hort
date
limitNameType
string
length = 0..10
limitCycleTypeType
Маска карты, представленная 4
последними цифрами
Номер карты
Номер пластика
CVV2
Режим выполнения операции при
выборке нескольких сущностей
 F - только для первой
зарегистрированной (по дате
созданий)
 L - только для последней
зарегистрированной (по дате
создания)
 A - для всех
Идентификатор транзакции
внешеней системы
Номер телефона/Электронная
почта
Имя
Описание статуса карты
Граничная дата лимита
Имя лимита
93
Наименование
Тип
Ограничения
limitValueType
unsignedL
ong
Величина лимита
maskedCardNumberType
string
mccType
memorableWordType
unsignedIn
t
string
value =
0..9999999999
99
pattern = [0-9*]
{11,19}
value = 0..9999
length = 0..24
Проверочное слово
merchantIdType
string
length = 1..16
Идентификатор мерчанта
miniStatementTransactionType
Type
notificationLimitAmountType
string
Тип транзакции в мини-выписке
notificationLimitCurrencyType
int
pattern = [0-9]
{6}
value <=
999999999999
value = 0..9999
personIdLastDigitMaskType
string
length = 8
personIdType
string
length = 1..20
Маска идентификатора держателя
карты, представленная 8
последними символами
Идентификатор держателя карты
phoneNumberType
string
pinDeliveryMethodType
string
pattern = \+?
[0-9]{4,20}
enumeration
pinDenialCounterType
int
value = 0..9999
pinValueType
string
posDataCodeType
string
pattern = [0-9]
{4}|[0-9]{2}
length = 1..12
processingCodeType
string
length = 0..6
productTypeType
string
length = 2
referenceNumberType
string
length = 0..13
responseCodeDescription
string
responseCodeInternalType
int
responseCodeType
string
reversalType
boolean
rrnType
string
secondNameType
long
Описание
Маскированный номер карты
Код категории мерчанта
Минимальная сумма для
нотификации
Валюта для нотификации
Номер телефона
Метод доставки пина
 SMS
 WS
 HALF_AND_HALF
 WS_ENCRYPTED
 NONE
Количество неудачных попыток
ввода PIN-кода
Значение ПИНа
Значение PosDataCode
Код обработки. См. Значения
processing code
Тип продукта
Код ответа SVFE описание
value = 999999..99999
9
length = 1..3
Внутренний код ответа SVFE
Код ответа SVFE, SVBO
Флаг реверсала
Внешний идентификатор RRN
string
pattern = [0-9azA-Z]{12}
length = 0..32
sendOtpPhoneMaskType
string
length = 0..32
sendOtpTransIdType
int
serviceIdType
string
value =
0..999999999
length = 1..8
Маска номера телефона при
отсылке ОТП
Идентификатор транзакции при
отсылке ОТП
Идентификатор сервиса
serviceNumType
string
Отчество
Номер сервиса
94
Наименование
Тип
Ограничения
Описание
serviceObjectTypeType
string
enumeration
serviceTypeType
string
length = 0..8
Тип объекта, к которому
прикреплен сервис
 SERVICE_OBJECT_CARD
 SERVICE_OBJECT_ACCOUNT
Тип сервиса
surnameType
string
length = 0..64
Фамилия
systemTraceAuditNumberType
int
Номер записи аудита
terminalIdentificationType
string
value =
0..999999
length = 0..15
traceType
string
length = 0..7
transactionDateType
dateTime
Отметка, выставляемая сетью или
хостом
Дата и время транзакции
transactionTypeType
int
value = 0..999
Тип транзакции
transactionTypeBO2Type
string
length = 8
Тип транзакции BO2
utrnnoType
long
Идентификатор транзакции SVFE
virtualCardDataDeliveryMethod
Type`
string
value <=
999999999999
enumeration
cardAcceptorTerminalIdentifica
tionType
pointOfServiceDataCodeType
String
Length=0..8
String
pattern = [0-9]
{3},
value = 0..999
pointOfServiceConditionCodeTy
pe
String
pattern = [0-9]
{2},
value = 0..99
Идентификатор терминала
Способ доставки данных
виртуальной карты
 WS
 HALF_AND_HALF
Идентификатор терминала
Набор кодов, определяющих
возможности терминала,
параметры его окружения и
использование средств защиты
при проведении транзакции.
Код, определяющий условия
проведения транзакции в точке
обслуживания.
95
5. Ошибки APIGate
5.1
serviceLevelFault
Данное сообщение возникает на уровне обработки шлюза.
serviceLevelFaultType
Элемент
errorCode
Тип
string
errorDesc
string
5.2
Описание
Код ошибки:
 UNSUPPORTED_OPERATION = 1000
 RUNTIME = 1001
 FE_ISO_ERROR = 1002
 FE_DB_ERROR = 1003
 BO_DB_ERROR = 1004
 NO_CARD_FOUND_ERROR = 1005
 DATA_NOT_FOUND = 1006
 TERMINATE_REQUEST_ERROR =
1007
 DUPLICATED_EXT_ID = 1008
Описание ошибки
Обязательность
+
-
svfeProcessingFault
Данное сообщение возникает в случае получения ошибочного кода ответа от фронтальной системы.
svfeProcessingFaultType
Элемент
responseCode
message
Тип
responseCodeTyp
e
string
Описание
Код ошибки
Описание ошибки
Обязательность
+
-
6. Справочники
6.1
Статусы карт
Зеленым цветом отмечены статусы, которые могут передаваться в параметре hotCardStatus запроса
blockCard.
Код
0
1
2
3
4
5
6
7
8
9
1
0
1
1
1
2
1
3
1
4
1
5
1
7
1
8
1
9
2
0
2
1
Обозначение
VALID CARD
CALL ISSUER
WARM CARD
DO NOT HONOR
HONOR WITH ID
NOT PERMITTED
LOST CARD, CAPTURE
STOLEN CARD, CAPTURE
CALL SECURITY, CAPTURE
INVALID CARD, CAPTURE
PICK UP CARD, SPECIAL CONDITION
CALL ACQUIRER SECURITY
CARD IS NOT ACTIVATED
PIN_ATTEMPTS_EXCEEDED
FORCED PIN CHANGE
CREDIT DEBTS
PIN ACTIVATION
INSTANT CARD PERSONIFICATION WAITING
FRAUD PREVENTION
TEMPRORY BLOCKED BY CLIENT
PERMANENT BLOCKED BY CLIENT
Типы циклов
6.2
Код
типа
длины
Комментарий
0
Days – день.
Цикл длиной в 1 день начинается каждый день в 00:00:00.
1
Weeks – неделя.
Цикл длиной в 1 неделю начинается каждые 7 дней в 00:00:00.
2
Weeks calendar –
календарная
неделя.
Month – месяц.
Цикл длиной в 1 календарную неделю начинается каждый
понедельник в 00:00:00.
3
4
5
6
7
8
9
6.3
Название типа
длины
Month calendar –
календарный
месяц.
Quarter – квартал
(3 месяца).
Quarter calendar –
календарный
квартал.
Year – год (12
месяцев).
Year calendar –
календарный год.
Month calendar
without public
holiday –
календарный
месяц без
нескольких
рабочих дней.
Цикл длиной в 1 месяц начинается в один и тот же день каждого
месяца в один и тот же момент времени.
Цикл длиной в 1 календарный месяц начинается в 00:00:00 первого
числа каждого месяца.
Цикл длиной в 1 квартал начинается в один и тот же день через
каждые 3 месяца в один и тот же момент времени.
Цикл длиной в 1 календарный квартал начинается 1 января, 1
апреля, 1 июля, 1 октября в 00:00:00.
Цикл длиной в 1 год начинается в один и тот же день и в один и тот
же момент времени ровно через год.
Цикл длиной в 1 календарный год начинается 1 января в 00:00:00.
Длина цикла задается в календарных месяцах. По умолчанию
выходными днями считаются субботы и воскресенья, а рабочими –
остальные дни. Для определения статуса дня (рабочий/выходной)
используется справочник исключений, в котором рабочему дню
можно присвоить признак выходного дня (например, для
общегосударственного праздника), а выходному дню (субботе или
воскресенью) – признак рабочего дня.
Значения processing code
Код
Обозначение
00xxnn
Purchase
01xxnn
Cash Advance
17xxnn
Debit Account with presentment
20xxnn
Return or Refund
21xxnn
Cash Deposit
27xxnn
Credit Account with presentment
40xxnn
Funds Transfer
47xxnn
Transfer to Foreign Account
48xxnn
Payment from Account
49xxnn
P2P transfer
83xxnn
Pre-Payment Payment
84xxnn
Payment
85xxnn
Direct-Debit, credit repayment
86xxnn
Direct-Debit, fee repayment
99xxnn
All other transactions
6.4
Коды ответов
Код
ответа
SVFE
Код
ответа
ISO
Описание
-1
00
Successful transaction
803
01
Call issuer
941
03
Invalid Merchant ID
909
04
Invalid card, capture
827
05
Do not honor transaction
826
08
Approve with identification
807
12
Transaction needs to be entered again
913
12
Invalid transaction – retry
903
13
Cannot process amount. This code is only for truly erroneous amounts, i.e,
exceeds machine capabilities or $0 cash withdrawal. No limits involved.
914
14
Invalid account – retry
934
14
Forced post: No card on file
883
15
The card is already active
812
30
The message received was not within standards
802
31
Issuer inoperative
840
31
SmartVista not permitted to stand in
819
33
Card expired, capture card
818
36
Account restricted, capture card
824
37
Call Security – Capture
822
41
Lost Card – Capture
823
43
Stolen Card – Capture
915
51
Insufficient funds – retry
901
55
Incorrect PIN, foreign.
804
57
Not permitted
806
57
Transaction not permitted by law
928
57
Account restricted
817
61
Negative auth usage cycle limit exceeded
917
61
Card’s ATM or EPAY cycle limit exceeded
938
61
Account’s ATM or EPAY cycle limit exceeded
905
62
Bad card (on_us)
814
65
Limit reached for total number of txns in cycle, independent of transaction
category.
801
68
Timer time out (used generally for issuers other than networks, i.e. a host)
10
0
Код
ответа
SVFE
Код
ответа
ISO
Описание
820
75
Excessive pin failures
821
76
Wrong Pin, Excessive pin failures
884
77
The card has NOT ANY accounts
940
78
Original transaction could not be found
292
90
Response status unknown
988
91
Service not available
965
92
Invalid Payment Parameter
977
93
Service blocked
811
94
Duplicate transmission
813
95
This can mean several things i.e. did not receive a tx amount being reversed
greater than orig.
805
96
Error (usually in pinblock translation)
902
96
Cannot process transaction
932
96
Forced post: no account on file
959
96
System Malfunction
997
97
Service not allowed for client
998
98
Invalid insurance number
308
A1
Service is already binded
277
A2
Service is not binded
307
A3
Invalid service data
858
A4
MAC error
895
A5
Debts absence.
287
A6
Invalid payment data
253
A7
Additional information required
251
A8
No such object in system
250
A9
Object is not created in system
249
AA
Object is already created in system
871
AB
Invalid CVV2
100
AC
Invalid Password
953
AD
Card is restricted
10
1
7. Редакции
Версия
Автор
Дата
Описание
1.00
Bezverkhny Evgeny
06.08.2019
Начальная версия
1.10
Bezverkhny Evgeny
12.08.2019
Добавлен метод changeExceedLimit
1.20
Bezverkhny Evgeny
14.08.2019
Улучшено форматирование
1.21
Bezverknhy Evgeny
05.11.2019
Изменен формат метода getTransactionsB
1.22
Melnik Leonid
07.11.2019
1.23
Bezverkhny Evgeny
07.11.2019
1.24
Bezverkhny Evgeny
17.12.2019
Поправлен формат метода getCardData (поле
expDate – обязательно в запросе)
Изменен формат метода changeExceedLimit
(expDate – обязательное поле).
Добавлено поле extId для всех ISO-запросов.
1.25
Bezverkhny Evgeny
20.12.2019
Добавлено поле currentValue для лимитов
1.27
Melnik Leonid
05.03.2020
1.28
Melnik Leonid
07.08.2020
Поправлен формат метода getCardData (поиск
по cardId или cardNumber+expDate) и
обязательность полей для типа
cardIdentificationType(cardNumber –
conditional)
Добавлен метод generateCVC2. Для метода
getTransactionsB добавлено в ответ поле MCC.
1.29
Melnik Leonid
16.10.2020
Добавлен метод refund, информацию по
дефолтному институту и поля
pointOfServiceDataCode,
pointOfServiceConditionCode,
cardAcceptorParameters для методов reversal и
purchase
1.30
Melnik Dmitriy
03.11.2020
Добавлено поле transactionTypeBO2 в ответе
метода getTransactionsBO. Изменена
обязательность поля transactionType в ответе
на опциональное.
1.31
Chikin Konstantin
01.02.2021
Добавлены методы sendOtp и checkOtp
1.32
Melnik Dmitriy
02.02.2021
Изменена обязательность входных
параметров у метода ChangeExceedLimit
(добавлена возможность прохождения
операции по cardId)
10
2