Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

(Тимчасово не надається)

Оцінка кредитного ризику з використанням скоринг-моделі Visa.

Звіт містить такі компоненти:

Шифрування

Налаштування шифрування

Ключ для шифрування

Http Method

POST

Request URL

https://secure.ubki.ua/b2_api_xml/ubki/xml

Request JSON

  body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "РНОКПП (ІПН)"

},

"additionaldata": {

"pan": "Кодований ідентифікатор карти (Шифрується публічним ключем VISA, що надається за запитом)"

},

"reqlng": "Мова критеріїв пошуку (Код із дов.23)"

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Transaction Underwriting Score' - 07",

"reqsubtype": "Код підшаблону (1 - отримання скорингу та атрибутів; 2 - отримання атрибутів; або не заповнюється у разі отримання тільки скорингу)",

"reqreason": "Мета подання запиту (Код із дов.24)"

},

"descr": "Об’єкт запиту"

},

"descr": "Конверт запиту"

},

"sessid": "Сесійний ключ отримуємо із API авторизації)"

}

}

}

Request XML

  body:

<?xml version="1.0" encoding="utf-8" ?>

<doc>

<ubki sessid="Сесійний ключ отримуємо із API авторизації)">

<req_envelope descr="Конверт запиту">

<req_xml descr="Об’єкт запиту">

<request version="1.0"

reqtype="Код шаблону (Код із дов.49): Звіт 'Transaction Underwriting Score' - 07"

reqsubtype="Код підшаблону (1 - отримання скорингу та атрибутів; 2 - отримання атрибутів; або не заповнюється у разі отримання тільки скорингу)"

reqreason="Мета подання запиту (Код із дов.24)">

<i reqlng="Мова критеріїв пошуку (Код із дов.23)">

<ident okpo="РНОКПП (ІПН)"/>

<additionaldata pan="Кодований ідентифікатор карти (Шифрується публічним ключем VISA, що надається за запитом)"/>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

 body:

<?xml version="1.0" encoding="UTF-8"?>

<ubkidata>

<!-- Блок системної інформації -->

<tech>

<trace>

<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку">

<!-- Блок trace містить метрики таймінгу кроків формування компонентів -->

</step>

</trace>

<error errtype="Код помилки(Код із дов.0)" errtext="Текст помилки (Значення із дов.0)" />

<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ" />

<!-- Блок інформації щодо поточного стану рахунку припейд-->

<billing>

<balance value="Сума балансу" date="Дата" time="Час" />

</billing>

</tech>

<!-- Блок інформації щодо скорингу карти VISA-->

<comp id="7" descr="Скоринг карти VISA">

<scorevisa pan="Кодований ідентифікатор карти"

score="Значення скорингу (0-1), де 1 - високий рівень кредитного ризику, 0 - низький рівень кредитного ризику"

recordeddate="Дата розрахунку"

cardtype="Тип картки (DEBIT - дебетова, CREDIT - кредитна)"

countrycode="Числовий код країни"

modelversion="Номер версії моделі" />

</comp>

<!-- Блок інформації щодо атрибутів VISA-->

<comp id="61" descr="Атрибути VISA">

<visaCardholderSpendProfile>

<spendSummary spendVolume="Сума"

numberOfTransactions="Кількість"

timePeriod="Період" />

<cardEngagement monthOnBook="Термін користування карткою, місяців"

activeMonths="Кількість місяців з транзакціями"

lastTransactionDate="Остання дата транзакції" />

<spendType categoryType="Тип транзакцій"

spendVolume="Сума"

timePeriod="Період" />

<authorizationDeclines categoryType="Тип відмови"

numberOfDeclines="Кількість"

timePeriod="Період" />

<categorySpend categoryType="Категорія транзакцій"

spendVolume="Сума"

numberOfTransactions="Кількість"

timePeriod="Період" />

</visaCardholderSpendProfile>

<!--Даний блок може складатися з 1 .. * елементів-->

</comp>

</ubkidata>

Приклад

Request JSON

{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "2111118724"
							},
							"additionaldata": {
								"pan": "PAN_01"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "07",
						"reqsubtype": "(1, 2 або не заповнений)",
						"reqreason": "2"
					}
				}
			},
			"sessid": "F55A3F9B47894C8B86724C290AEC178A"
		}
	}
}

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<doc>
   <ubki sessid="F55A3F9B47894C8B86724C290AEC178A">
      <req_envelope>
         <req_xml>
            <request version="1.0" reqtype="07" reqsubtype="(1, 2 або не заповнений)" reqreason="2">
               <i reqlng="1">
                  <ident okpo="2111118724" />
                  <additionaldata pan="PAN_01" />
               </i>
            </request>
         </req_xml>
      </req_envelope>
   </ubki>
</doc>

Приклад отримання скорингу та атрибутів (reqsubtype="1")

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ubkidata>
   <tech>
      <trace>
         <step name="build report" stm="2022-01-09 18:52:43.675" ftm="2022-01-09 18:52:43.752" />
      </trace>
      <reqinfo reqid="req2#000002007718" />
   </tech>
   <comp id="7" descr="Скоринг карти VISA">
      <scorevisa pan="pan" score="0.1" recordeddate="202201" cardtype="CREDIT" countrycode="804" modelversion="2.0" />
   </comp>
   <comp id="61" descr="Атрибути VISA">
      <visaCardholderSpendProfile>
         <spendSummary spendVolume="18139.5" numberOfTransactions="80255" timePeriod="3M" />
         <spendSummary spendVolume="56321.85" numberOfTransactions="10182" timePeriod="12M" />
         <cardEngagement monthOnBook="15" activeMonths="3" lastTransactionDate="2021-09-10" />
         <spendType categoryType="CNP" spendVolume="2821.85" timePeriod="12M" />
         <spendType categoryType="ATM" spendVolume="3919.8" timePeriod="12M" />
         <spendType categoryType="CASH_OR_XBORDER" spendVolume="5605.65" timePeriod="12M" />
         <authorizationDeclines categoryType="TOTAL" numberOfDeclines="473" timePeriod="3M" />
         <authorizationDeclines categoryType="INSUFFICIENT_FUNDS" numberOfDeclines="1" timePeriod="3M" />
         <categorySpend categoryType="FOOD_AND_GROCERY" spendVolume="1079.93" numberOfTransactions="10170" timePeriod="12M" />
         <categorySpend categoryType="FUEL" spendVolume="247.96" numberOfTransactions="21791" timePeriod="12M" />
         <categorySpend categoryType="HEALTH_CARE" spendVolume="1266.0" numberOfTransactions="13854" timePeriod="12M" />
         <categorySpend categoryType="TRAVEL" spendVolume="34218.75" numberOfTransactions="58888" timePeriod="12M" />
         <categorySpend categoryType="TELECOM_UTILITIES_INSURANCE" spendVolume="25508.0" numberOfTransactions="25701" timePeriod="12M" />
         <categorySpend categoryType="RESTAURANTS_QSR" spendVolume="704.7" numberOfTransactions="11615" timePeriod="12M" />
      </visaCardholderSpendProfile>
   </comp>
</ubkidata>

Приклад отримання атрибутів (reqsubtype="2")

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ubkidata>
   <tech>
      <trace>
         <step name="build report" stm="2022-01-09 18:52:07.765" ftm="2022-01-09 18:52:07.836" />
      </trace>
      <reqinfo reqid="req2#000002007713" />
   </tech>
   <comp id="61" descr="Атрибути VISA">
      <visaCardholderSpendProfile>
         <spendSummary spendVolume="18139.5" numberOfTransactions="80255" timePeriod="3M" />
         <spendSummary spendVolume="56321.85" numberOfTransactions="10182" timePeriod="12M" />
         <cardEngagement monthOnBook="15" activeMonths="3" lastTransactionDate="2021-09-10" />
         <spendType categoryType="CNP" spendVolume="2821.85" timePeriod="12M" />
         <spendType categoryType="ATM" spendVolume="3919.8" timePeriod="12M" />
         <spendType categoryType="CASH_OR_XBORDER" spendVolume="5605.65" timePeriod="12M" />
         <authorizationDeclines categoryType="TOTAL" numberOfDeclines="473" timePeriod="3M" />
         <authorizationDeclines categoryType="INSUFFICIENT_FUNDS" numberOfDeclines="1" timePeriod="3M" />
         <categorySpend categoryType="FOOD_AND_GROCERY" spendVolume="1079.93" numberOfTransactions="10170" timePeriod="12M" />
         <categorySpend categoryType="FUEL" spendVolume="247.96" numberOfTransactions="21791" timePeriod="12M" />
         <categorySpend categoryType="HEALTH_CARE" spendVolume="1266.0" numberOfTransactions="13854" timePeriod="12M" />
         <categorySpend categoryType="TRAVEL" spendVolume="34218.75" numberOfTransactions="58888" timePeriod="12M" />
         <categorySpend categoryType="TELECOM_UTILITIES_INSURANCE" spendVolume="25508.0" numberOfTransactions="25701" timePeriod="12M" />
         <categorySpend categoryType="RESTAURANTS_QSR" spendVolume="704.7" numberOfTransactions="11615" timePeriod="12M" />
      </visaCardholderSpendProfile>
   </comp>
</ubkidata>

Приклад отримання скорингу (reqsubtype="")

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ubkidata>
   <tech>
      <trace>
         <step name="build report" stm="2022-01-09 18:51:18.003" ftm="2022-01-09 18:51:18.08" />
      </trace>
      <reqinfo reqid="req2#000002007707" />
   </tech>
   <comp id="7" descr="Скоринг карти VISA">
      <scorevisa pan="pan" score="0.1" recordeddate="202201" cardtype="CREDIT" countrycode="804" modelversion="2.0" />
   </comp>
</ubkidata>

XSD Schema request

https://secure.ubki.ua/b2/js/xsd/request07.xsd

XSD Schema response

https://secure.ubki.ua/b2/js/xsd/response07.xsd

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test data

  • okpo="2111118724" pan="PAN_01"

  • okpo="3233312116" pan="PAN_05"

  • okpo="2972566397" pan="PAN_09"

  • No labels