Free UBCH service for the client (partner pays)
- Оксана Нечепоренко
Service for Providing UBCH Services Paid by Your Organization for Your Clients.
The payment for the service provided to the client is made by the partner according to the established tariffs.
Http Method | POST |
|---|---|
Headers | Accept: application/jsonContent-Type: application/json |
Request URL | https://nr.UBCH.ua/bonusservice/free |
Request JSON( ** parameters are passed optionally) { "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", "**phone": "Mobile phone in the format +380…. (Mandatory parameter for connecting SKN/SKN_3 services)" } |
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 of the individual for SKI notification | [TEXT,250] variable length text format, up to 250 characters | |
phone | Mobile phone in the format +380… | [TEXT,250] variable length text format, up to 250 characters |
Response JSON:{ "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", "phone": "Mobile phone in the format +380…" }, "service": { "reptype": "Service code", "reptyperef": "Service name", "def_price": "Default service price", "sale_price": "Service price with discount" }, "billing": { "reqid": "Request ID", "price": "Service cost for partner" } } |
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 of the individual for SKI notification | [TEXT,250] variable length text format, up to 250 characters | |
phone | Mobile phone in the format +380… | [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 | [N,15,2], floating point number format, 2 digits after the point |
billing | ||
reqid | Request ID | [TEXT,250] variable length text format, up to 250 characters |
price | Service cost for partner ALB - 66.00 BLC - 54.00 SKN - 600.00 SKN_3 - 180.00 | [N,15,2], floating point number format, 2 digits after the point |
Directory of Notifications and Errors
result_code | message |
|---|---|
0 | Operation successful. UBCH Support Service: 0445851196. |
1 | Invalid or expired session key. UBCH Support Service: 0445851196. |
2 | Request denied - the StatusControl service is active. UBCH Support Service: 0445851196. |
3 | Subject data for report generation is absent in the bureau's database. UBCH Support Service: 0445851196. |
4 | Missing or invalid required attributes. UBCH Support Service: 0445851196. |
5 | System error. UBCH Support Service: 0445851196. |
6 | There are insufficient funds in the account. UBCH support service: 0445851196. |
Example |
|---|
Request JSON | {
"sessid": "98D1069523B34892A264845F762675TF",
"reptype" : "SKN",
"inn": "3241500301",
"email": "o.limarenko@gmail.com",
"phone": "+380635030101"
} |
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",
"phone": "+380635030101"
},
"service": {
"reptype": "SKN",
"reptyperef": "СтатусКонтроль на рік",
"def_price": "900",
"sale_price": "0"
},
"billing": {
"reqid": "req2#000982180057",
"price": 600
}
} |