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

Version 1 Current »


Service for Providing Discounts on UBCH Services for Your Clients


The discount is provided by UBKI. 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.ua/bonusservice/discount

Request JSON

( ** parameters are passed optionally)

  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"

}

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

Параметр

Опис

Формат 

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:

 body:

{

"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 request parameters

Параметр

Опис

Формат 

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]

Directory of Notifications and Errors

result_code

message

0

Operation successful. UBKI Support Service: 0445851196.

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

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

3

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

4

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

System error. UBKI Support Service: 0445851196.

Example

Request JSON

{
"sessid": "98D0069895B34892A264845F71167FEF",
"reptype" : "ALB",
"inn": "3241500301",
"email": "o.limarenko@gmail.com"
}

Response JSON

{
    "result_code": "0",
    "message": "Операцію успішно виконано. Служба підтримки УБКІ: 0445851196.",
    "partner": {
        "sessid": "98D0069895B34892A264845F71167FEF",
        "userid": "29120",
        "bankid": "1826",
        "bankokpo": "01982523",
        "bankname": "КВІТЕНЬ"
    },
    "client": {
        "inn": "3241500301",
        "email": "o.limarenko@gmail.com"
    },
    "service": {
        "reptype": "ALB",
        "reptyperef": "Кредитна історія",
        "def_price": "90",
        "sale_price": "70",
        "discount_term": "7",
        "discount_start_date": "2024-09-04 14:39:13",
        "discount_end_date": "2024-09-11 14:39:13"
    }
}

  • No labels