Versions Compared

Old Version 5

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version Current

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Http Method

POST

Request URL

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

Request JSON
( ** параметри передаються опціонально при наявністі кредитної історії по даному клієнту від Вашої організації)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "РНОКПП (ІПН) фізособи",

"lname": "**Прізвище",

"fname": "**Ім'я",

"mname": "**По батькові",

"bdate": "**Дата народження"

},

"contacts": {

"cont": {

"ctype": "**Тип контакту (Код із дов.10)",

"cval": "**Значення контакту"

}

},

"docs": {

"doc": {

"dtype": "**Тип документа (Код із дов.7)",

"dser": "**Серія документа",

"dnom": "**Номер документа"

}

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Індивідуальний кредитний звіт' - 48",

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

},

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

},

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

},

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

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Найменування кроку",

"stm": "Дата штамп старту кроку",

"ftm": "Дата штамп фінішу кроку"

}

},

"error": {

"errtype": "Код помилки(Код із дов.0)",

"errtext": "Текст помилки(Значення із дов.0)"

},

"reqinfo": {

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

},

"billing": {

"balance": {

"value": "Сума балансу",

"date": "Дата",

"time": "Час" }

} },

"compbilldetails": {

"crdealshortfreemon": {

"inn": "РНОКПП (ІПН) СКІ",

"dlds": "Дата початку угоди",

"dldpf": "Дата закінчення угоди за договором",

"dlamt": "Сума (початкова) угоди",

"dlcurr": "Валюта угоди (Код із дов.12)",

"typedeal": "Тип угоди, одне з 2 значень: CC - кредитна картка, PL - не кредитна картка",

"statedeal": "Статус угоди, "Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)",

"freemonref": "Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"

}

}

},

"comp": {

"crdealshort": {

"inn": "РНОКПП (ІПН) СКІ",

"dlds": "Дата початку угоди",

"dldpf": "Дата закінчення угоди за договором",

"dlamt": "Сума (початкова) угоди",

"dlcurr": "Валюта угоди (Код із дов.12)",

"typedeal": "Тип угоди, одне з 2 значень: CC - кредитна картка, PL - не кредитна картка",

"statedeal": "Статус угоди, одне з 2 значень: OPEN - відкрита або пролонгована угода, CLOSE - всі інші статуси",

"dldateclc": "Дата розрахунку",

"dlamtexpuah": "Сума поточної простроченої заборгованості в грн",

"dldayexp": "Поточна кількість днів прострочення",

"dlflstat": "Статус угоди в поточному періоді (Код із дов.16)",

"ex60y3uah": "Максимальна сума прострочки 60+ днів за останні 36 місяців в грн",

"ex90y3uah": "Максимальна сума прострочки 90+ днів за останні 36 місяців в грн",

"paymuah": "Сума обов’язкового платежу в грн. Поле розраховується за логікою ануїтету, якщо кредит відкритий, а платіж не вказаний",

"dlamtcuruah": "Сума поточної заборгованості в грн" },

"idreqyear": "71"Кількість запитів за рік"

},

"id": "71",

"descr": "Назва компоненти"

},

{

"person": {

"bdate": "Дата народження",

"lngref": "Мова надання блоку (Значення із дов.23)",

"lng": "Мова надання блоку (Код із дов.23)",

"mname": "По батькові",

"fname": "Ім'я",

"lname": "Прізвище",

"inn ": "РНОКПП (ІПН) СКІ",

},

"id": "72",

"descr": "Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)"

}

]

}

}

...

Response XML

Expand
titlebody:

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

<ubkidata>

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

<tech>

<trace>

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

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

</step>

</trace>

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

</error>

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

</reqinfo>

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

<billing>

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

</billing>

</tech>

<!-- Індивідуальний кредитний звіт -->

<comp id="71" descr="Назва компоненти">

<crdealshort inn="РНОКПП (ІПН) СКІ"

dlds="Дата початку угоди"

dldpf="Дата закінчення угоди за договором"

dlamt="Сума (початкова) угоди"

dlcurr="Валюта угоди (Код із дов.12)"

typedeal="Тип угоди, одне з 2 значень: CC - кредитна картка, PL - не кредитна картка"

statedeal="Статус угоди, одне з 2 значень: OPEN - відкрита або пролонгована угода, CLOSE - всі інші статуси"

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

dlamtexpuah="Сума поточної простроченої заборгованості в грн"

dldayexp="Поточна кількість днів прострочення"

dlflstat="Статус угоди в поточному періоді (Код із дов.16)"

ex60y3uah="Максимальна сума прострочки 60+ днів за останні 36 місяців в грн"

ex90y3uah="Максимальна сума прострочки 90+ днів за останні 36 місяців в грн"

paymuah="Сума обов’язкового платежу в грн. Поле розраховується за логікою ануїтету, якщо кредит відкритий, а платіж не вказаний"

dlamtcuruah="Сума поточної заборгованості в грн">

<!--Даний блок повинен складатись з 0 .. * елементів-->

</crdealshort>

</comp>

<!-- Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)-->

<comp id="72" descr="Пошук по ПІБ+ДР при результаті більше 1 особи">

<person bdate="Дата народження"

lngref="Мова надання блоку (Значення із дов.23)"

lng="Мова надання блоку (Код із дов.23)"

mname="По батькові"

fname="Ім'я"

lname="Прізвище"

inn="РНОКПП (ІПН) СКІ" />

</comp>

</ubkidata>

Приклад

Request JSON

Code Block{ "ubkidata": { "tech": { "trace": { "step": [ { "name": "build report", "stm": "2023-09-20 11:43:48.711", "ftm": "2023-09-20 11:43:48.748" } ] }, "error": [], "reqinfo": { "reqid": "req2#0000029119201" } }, "comp": [ { "id": "71", "descr": "Індивідуальний кредитний звіт", "crdealshort": [ { "inn": "3278508288", "dlds": "2016-08-25", "dldpf": "2116-09-25", "dlamt": "0.00", "dlcurr": "980", "typedeal": "CC", "statedeal": "CLOSE", "dldateclc": "2019-08-28", "dlamtexpuah": "0.00", "dldayexp": "0", "dlflstat": "2", "ex60y3uah": "0.00", "ex90y3uah": "0.00", "paymuah": "0.00", "dlamtcuruah": "0.00" }, { "inn": "3278508288", "dlds": "2019-12-23", "dldpf": "2021-04-23", "dlamt": "0.00", "dlcurr": "980", "typedeal": "PL", "statedeal": "CLOSE", "dldateclc": "2020-05-03", "dlamtexpuah": "0.00", "dldayexp": "0", "dlflstat": "2", "ex60y3uah": "0.00", "ex90y3uah": "0.00", "paymuah": "0.00", "dlamtcuruah": "0.00" } ] } ]

<billdetails freemon="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)"

freemonref="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"/>

</billing>

</tech>

<!-- Індивідуальний кредитний звіт -->

<comp id="71" descr="Назва компоненти">

<crdealshort inn="РНОКПП (ІПН) СКІ"

dlds="Дата початку угоди"

dldpf="Дата закінчення угоди за договором"

dlamt="Сума (початкова) угоди"

dlcurr="Валюта угоди (Код із дов.12)"

typedeal="Тип угоди, одне з 2 значень: CC - кредитна картка, PL - не кредитна картка"

statedeal="Статус угоди, одне з 2 значень: OPEN - відкрита або пролонгована угода, CLOSE - всі інші статуси"

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

dlamtexpuah="Сума поточної простроченої заборгованості в грн"

dldayexp="Поточна кількість днів прострочення"

dlflstat="Статус угоди в поточному періоді (Код із дов.16)"

ex60y3uah="Максимальна сума прострочки 60+ днів за останні 36 місяців в грн"

ex90y3uah="Максимальна сума прострочки 90+ днів за останні 36 місяців в грн"

paymuah="Сума обов’язкового платежу в грн. Поле розраховується за логікою ануїтету, якщо кредит відкритий, а платіж не вказаний"

dlamtcuruah="Сума поточної заборгованості в грн"

reqyear="Кількість запитів за рік">

<!--Даний блок повинен складатись з 0 .. * елементів-->

</crdealshort>

</comp>

<!-- Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)-->

<comp id="72" descr="Пошук по ПІБ+ДР при результаті більше 1 особи">

<person bdate="Дата народження"

lngref="Мова надання блоку (Значення із дов.23)"

lng="Мова надання блоку (Код із дов.23)"

mname="По батькові"

fname="Ім'я"

lname="Прізвище"

inn="РНОКПП (ІПН) СКІ" />

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"bdate": "1989-10-05",
								"mname": "ВАСИЛІВНА",
								"fname": "ІРІНА",
								"lname": "ГАРНА",
								"okpo": "3278508288"
							},
							"docs": {
								"doc": {
									"dtype": "1",
									"dser": "АМ",
									"dnom": "578072"
								}
							},
							"contacts": {
								"cont": {
									"cval": "+380962134234",
									"ctype": "3"
								}
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "48",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-09 19:08:22.647",
					"ftm": "2022-01-09 19:08:22.734"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002007797"
			}
		},
		"comp": {
			"crdealshort": [
				{
					"inn": "3278508288",
					"dlds": "2018-02-23",
					"dldpf": "2019-06-23",
					"dlamt": "0.00",
					"dlcurr": "980",
					"typedeal": "CC",
					"statedeal": "CLOSE",
					"dldateclc": "2018-08-03",
					"dlamtexpuah": "0.00",
					"dldayexp": "0",
					"dlflstat": "2",
					"ex60y3uah": "0.00",
					"ex90y3uah": "0.00",
					"paymuah": "0.00",
					"dlamtcuruah": "0.00",
					"reqyear": "0"
				},
				{
					"inn": "3278508288",
					"dlds": "2014-11-25",
					"dldpf": "2113-11-25",
					"dlamt": "0.00",
					"dlcurr": "980",
					"typedeal": "CC",
					"statedeal": "CLOSE",
					"dldateclc": "2017-11-30",
					"dlamtexpuah": "0.00",
					"dldayexp": "0",
					"dlflstat": "2",
					"ex60y3uah": "0.00"2",
					"ex60y3uahex90y3uah": "0.00",
					"ex90y3uahpaymuah": "0.00",
					"paymuahdlamtcuruah": "0.00",
					"dlamtcuruahreqyear": "0.00"
				}
			],
			"id": "71",
			"descr": "Індивідуальний кредитний звіт"
		}
	}
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2023-09-20 11:42:31.427" ftm="2023-09-20 11:42:31.464"/>
        </trace>
        <reqinfo reqid="req2#000002911801"/>
    </tech>
    <comp id="71" descr="Індивідуальний кредитний звіт">
        <crdealshort inn="3278508288" dlds="2016-08-25" dldpf="2116-09-25" dlamt="0.00" dlcurr="980" typedeal="CC" statedeal="CLOSE" dldateclc="2019-08-28" dlamtexpuah="0.00" dldayexp="0" dlflstat="2" ex60y3uah="0.00" ex90y3uah="0.00" paymuah="0.00" dlamtcuruah="0.00" reqyear="0"/>
        <crdealshort inn="3278508288" dlds="2019-12-23" dldpf="2021-04-23" dlamt="0.00" dlcurr="980" typedeal="PL" statedeal="CLOSE" dldateclc="2020-05-03" dlamtexpuah="0.00" dldayexp="0" dlflstat="2" ex60y3uah="0.00" ex90y3uah="0.00" paymuah="0.00" dlamtcuruah="0.00" reqyear="0"/>
    </comp>
</ubkidata>

XSD Schema request

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

Test URL

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

Test data

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

  • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"

  • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3"

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"

  • bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" ctype="3"

<comp id="72" descr="Пошук по ПІБ+ДР при результаті більше 1 особи">

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА"