Versions Compared

Key

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

...

Service for Providing Discounts on UBCH Services for Your Clients

...

Info

The discount is provided by

UBKI

UBCH. For the partner, requests to set discounts for clients are free of charge.

...

Http Method

POST

Headers

Accept: application/json

Content-Type: application/json

Request URL

https://nr.

ubki

UBCH.ua/bonusservice/discount

Request JSON

( ** parameters are passed optionally)

Expand
title body:

{

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

"reptype" : "Service code",

"inn": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)",

"**email": "Email of the individual for SKI notification"

}

Опис параметрів запиту

...

Параметр

...

Опис

...

Description of request parameters

Parameter

Description

Format

sessid

Session key (obtained from the authorization API)

[TEXT,250] variable length text format, up to 250 characters

reptype

Service code (ALB - Credit history, BLC - Credit Score, SKN - StatusControl for a year, SKN_3 - StatusControl for 3 months)

[TEXT,10] variable length text format, up to 10 characters

inn

Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)

[N,10] 10 numeric characters

email

Email of the individual for SKI notification

[TEXT,250] variable length text format, up to 250 characters

Response JSON:

Expand
titlebody:

{

"result_code": "Result code of the operation",

"message": "Text message about the operation status",

"details": ["Details in case of an error"],

"partner": {

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

"userid": "User ID",

"bankid": "Organization ID",

"bankokpo": "Organization's EDRPOU",

"bankname": "Organization name"

},

"client": {

"inn": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)",

"email": "Email of the individual for SKI notification"

},

"service": {

"reptype": "Service code",

"reptyperef": "Service name",

"def_price": "Default service price",

"sale_price": "Service price with discount",

"discount_term": "Number of days the discount is valid",

"discount_start_date": "Discount start date",

"discount_end_date": "Discount end date"

}

}

Description of

...

response parameters

ПараметрParameter

ОписDescription

Формат Format

result_code

Result code of the operation (0 - success, other - error)

[N,10] 10 numeric characters

message

Text message about the operation status

[TEXT,40] variable length text format, up to 40 characters

details

Details in case of an error

[TEXT,1000] variable length text format, up to 1000 characters

partner

sessid

Session key (obtained from the authorization API)

[TEXT,250] variable length text format, up to 250 characters

userid

User ID

[TEXT,40] variable length text format, up to 40 characters

bankid

Organization ID

[TEXT,40] variable length text format, up to 40 characters

bankokpo

Organization's EDRPOU

[TEXT,8] variable length text format, up to 8 characters

bankname

Organization name

[TEXT,250] variable length text format, up to 250 characters

client

inn

Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)

[N,10] 10 numeric characters

email

Email of the individual for SKI notification

[TEXT,250] variable length text format, up to 250 characters

service

reptype

Service code (ALB - Credit history, BLC - Credit Score, SKN - StatusControl for a year, SKN_3 - StatusControl for 3 months)

[TEXT,10] variable length text format, up to 10 characters

reptyperef

Service name (ALB - Credit history, BLC - Credit Score, SKN - StatusControl for a year, SKN_3 - StatusControl for 3 months)

[TEXT,250] variable length text format, up to 250 characters

def_price

Default service price

ALB - 90.00

BLC - 70.00

SKN - 900.00

SKN_3 - 250.00

[N,15,2], floating point number format, 2 digits after the point

sale_price

Service price with discount

ALB - 70.00

BLC - 50.00

SKN - 700.00

SKN_3 - 192.00

[N,15,2], floating point number format, 2 digits after the point

discount_term

Number of days the discount is valid

[N,10] 10 numeric characters

discount_start_date

Discount start date

Date format [2024-14-01 12:00:00]

discount_end_date

Discount end date

Date format [2024-14-01 12:00:00]

...

result_code

message

0

Operation successful. UBKI UBCH Support Service: 0445851196.

Invalid or expired session key. UBKI UBCH Support Service: 0445851196.

Request denied - the StatusControl service is active. UBKI UBCH Support Service: 0445851196.

3

Subject data for report generation is absent in the bureau's database. UBKI UBCH Support Service: 0445851196.

4

Missing or invalid required attributes. UBKI UBCH Support Service: 0445851196.

System error. UBKI UBCH Support Service: 0445851196.

...