Versions Compared

Old Version 4

changes.mady.by.user Zlata

Saved on

compared with

New Version 5

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

XML

JSON

Expand
title body:

{

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

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request parameters -->

<request version="1.0"

reqtype="Template code (code from ref.49):'Transaction Underwriting Score' report – 07"

reqsubtype="Sub-template code (1 - get scoring and attributes; 2 - get attributes; or not filled in if only scoring is received)"

reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

<i reqlng= "doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Tax/Taxpayer Identification Number (INN-RNUKPN)"

},

"additionaldata": {

"pan": "Encrypted card ID (Encrypted with the VISA public key provided on request)"

},

"reqlng": "Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN)" />

<!-- Subject identification parameters-->

<additionaldata pan="Encrypted card ID (Encrypted with the VISA public key provided on request)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand

},

"version": "1.0",

"reqtype": "Template code (code from ref.49):'Transaction Underwriting Score' report – 07",

"reqsubtype": "Sub-template code (1 - get scoring and attributes; 2 - get attributes; or not filled in if only scoring is received)",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

Request XML

Expand
title body:

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

<ubkidata>

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!--

System information part <error errtype="Error

Request parameters -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<request version="1.0"

reqtype="Template code (code from ref.

0)" errtext="Error text (value from ref.0

49):'Transaction Underwriting Score' report – 07"

reqsubtype="Sub-template code (1 - get scoring and attributes; 2 - get attributes; or not filled in if only scoring is received)"

reqreason="Request objective (code from ref.24)">

<

/error> <reqinfo reqid="Outgoing request ID generated by UBKI

!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<

/reqinfo> <

!--

Information about the current status of the prepaid account part </tech>

Subject identification parameters-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN)" />

<!--

VISA card scoring information block <scorevisa

Subject identification parameters-->

<comp id="7" descr="VISA card scoring">

<additionaldata pan="Encrypted card ID

"

score="Scoring value (0-1) - 0 - low credit risk, 1 - high credit risk"

recordeddate="Score calculation date"

cardtype="Card type (DEBIT/CREDIT)"

countrycode="Numerical code representing country code"

modelversion="Model Version Number" />

</comp>

<!-- Block of information about VISA attributes-->

<comp id="61" descr="VISA atributes">

<visaCardholderSpendProfile>

<spendSummary spendVolume="Amount"

numberOfTransactions="Quantity"

timePeriod="Period" />

<cardEngagement monthOnBook="Card expiration date, months"

activeMonths="Number of months with transactions"

lastTransactionDate="Last transaction date" />

<spendType categoryType="Transaction type"

spendVolume="Amount"

timePeriod="Period" />

<authorizationDeclines categoryType="Rejection type"

numberOfDeclines="Quantity"

timePeriod="Period" />

<categorySpend categoryType="Transaction category"

spendVolume="Amount"

numberOfTransactions="Quantity"

timePeriod="Period" />

</visaCardholderSpendProfile>

<!-- This block can consist of 1 .. * elements -->

</comp>

</ubkidata>

Example

Request

(Encrypted with the VISA public key provided on request)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- System information part -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Error code (code from ref.0)" errtext="Error text (value from ref.0)">

</error>

<reqinfo reqid="Outgoing request ID generated by UBKI">

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

</tech>

<!-- VISA card scoring information block-->

<comp id="7" descr="VISA card scoring">

<scorevisa pan="Encrypted card ID"

score="Scoring value (0-1) - 0 - low credit risk, 1 - high credit risk"

recordeddate="Score calculation date"

cardtype="Card type (DEBIT/CREDIT)"

countrycode="Numerical code representing country code"

modelversion="Model Version Number" />

</comp>

<!-- Block of information about VISA attributes-->

<comp id="61" descr="VISA atributes">

<visaCardholderSpendProfile>

<spendSummary spendVolume="Amount"

numberOfTransactions="Quantity"

timePeriod="Period" />

<cardEngagement monthOnBook="Card expiration date, months"

activeMonths="Number of months with transactions"

lastTransactionDate="Last transaction date" />

<spendType categoryType="Transaction type"

spendVolume="Amount"

timePeriod="Period" />

<authorizationDeclines categoryType="Rejection type"

numberOfDeclines="Quantity"

timePeriod="Period" />

<categorySpend categoryType="Transaction category"

spendVolume="Amount"

numberOfTransactions="Quantity"

timePeriod="Period" />

</visaCardholderSpendProfile>

<!-- This block can consist of 1 .. * elements -->

</comp>

</ubkidata>

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "2111118724"
							},
							"additionaldata": {
								"pan": "PAN_01"
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "07",
						"reqsubtype": "(1, 2 or not filled)",
						"reqreason": "2"
					}
				}
			},
			"sessid": "F55A3F9B47894C8B86724C290AEC178A"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
   <ubki sessid="F55A3F9B47894C8B86724C290AEC178A">
      <req_envelope>
         <req_xml>
            <request version="1.0" reqtype="07" reqsubtype="(1, 2 or not filled)" reqreason="2">
               <i reqlng="4">
                  <ident okpo="2111118724" />
                  <additionaldata pan="PAN_01" />
               </i>
            </request>
         </req_xml>
      </req_envelope>
   </ubki>
</doc>

Example of scoring and attributes (reqsubtype = "1")

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-08-25 10:16:53.815" ftm="2022-08-25 10:16:54.045" />
    </trace>
    <reqinfo reqid="req2#000002459427" />
  </tech>
  <comp id="7" descr="VISA card scoring">
    <scorevisa pan="PAN_01" score="0.1" recordeddate="202105" cardtype="CREDIT" countrycode="804" modelversion="2.0" />
  </comp>
  <comp id="61" descr="VISA Attributes">
    <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>

Example of getting attributes (reqsubtype = "2")

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-25 10:17:45.369" ftm="2022-08-25 10:17:45.733"/>
        </trace>
        <reqinfo reqid="req2#000002459431"/>
    </tech>
    <comp id="61" descr="VISA Attributes">
        <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>

Example of scoring (reqsubtype = "")

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-25 10:18:14.207" ftm="2022-08-25 10:18:14.299"/>
        </trace>
        <reqinfo reqid="req2#000002459434"/>
    </tech>
    <comp id="7" descr="VISA card scoring">
        <scorevisa pan="PAN_01" score="0.1" recordeddate="202105" cardtype="CREDIT" countrycode="804" modelversion="2.0"/>
    </comp>
</ubkidata>

...