Data transfer register reception API
- Оксана Нечепоренко
This service is intended to receive a data transfer register.
Http Method | POST |
|---|---|
Request URL | https://secure.ubki.ua/b2/handsent/sentreestr |
Request | <?xml version="1.0" encoding="utf-8"?>
<doc>
<prot todo="Request type"
idout="UBKI request ID"
idalien="Partner’s request ID"
indate="The date for which data reception protocols will be downloaded (by default, yesterday's date)"
grp="Grouping type"
sessid="Session key" />
</doc> |
Request params | |
todo* | Request type - BIL – Billing (getting counter values with a breakdown into "Total", "New", "Corrected", "Errors", "Global duplicates", "Local duplicates", "Deleted" categories) REP – Register (getting the register of messages and errors) |
|---|---|
grp* | Grouping type (only for the todo="BIL" mode), only a single type is specified in the request - PACK – up to the batch (grouping is performed by the batch ID, all the counter values are summed up) COMP – to component (grouping is done by component ID, all counter values are summed up) ITEM – to the item (grouping is done by item ID, all counter values are summed up) |
idout | UBKI request ID (upon each data transfer the UBKI service generates idout, a unique transfer batch ID. This ID allows the receiving of an effective register) |
idalien | Partner’s request ID (the reqidout attribute of the request tag, contained in a data transfer request, allows to transfer any ID. Specify this attribute in the service, to receive an effective register) |
indate | The date for which data reception protocols will be downloaded (by default, yesterday's date) |
sessid* | Session key (must be acquired here) |
Response in mode todo=”BIL” indate=”2023-12-01” grp=”PACK”
| <?xml version='1.0' encoding='UTF-8'?>
<doc>
<prot indate="20231201" idout="IN#M4C1723443317" idalien="c9a961b0-0b82-45b9-af6d-686e863d9db1" state="r" oper="u" todo="BIL" al="1" nw="0" ed="1" er="0" db="0" lb="0" dl="0" cl="0" clTr="0" erCr="0" erNt="0" nd="0" ndTr="0" nt="0" nwTr="0" sessid=""/>
<prot indate="20231201" idout="IN#94C1I12244626" idalien="c9a961b0-0b82-45b9-af6d-686e863d9db1" state="r" oper="u" todo="BIL" al="1" nw="0" ed="1" er="0" db="0" lb="0" dl="0" cl="0" clTr="0" erCr="0" erNt="0" nd="0" ndTr="0" nt="0" nwTr="0" sessid=""/>
</doc> |
Request params | |
state | Transfer batch status (r – processed, n – transferred, i – generated, b – rejected, e – error writing to the database) |
oper | Type of the transfer operation (specified if the request tag is transferred in the reqtype attribute (`i` – transfer, `u` – correction, `d` – deleting)) |
compid | ID of the component transferred (currently the following ones are supported: 1 – Identification of the individual, 2 – Credit history, 10 – Contacts |
item | Subcomponent (IDENT, URIDENT, LINKED, WORK, DOC, ADDR, FOTO, CRDEAL, SUSD, CONT) |
al | Total versions transferred |
nw | New versions |
ed | Modified versions |
er | Errors with versions |
db | Duplicate versions in the Bureau’s database |
lb | Duplicate versions in the transferred batch |
dl | Deleted from the Bureau’s database |
clTr | Closed deals transferred transactionally |
ndTr | New agreements transferred transactionally |
nwTr | New deal records transferred transactionally |
Response in the todo="REP" mode | <?xml version="1.0" encoding="utf-8"?>
<doc>
<prot todo="REP" idout="IN#0000018427" idalien="X000000000001" indate="2023-02-01" sessid="A1F593950A8F4562AE5A5DB1914D658A" state="r" oper="i"
compid="1" item="IDENT" ertype="NW" crytical="" inn="1234567890" remark="OK. Язык: 1. ФИО: Іванова Любов Ярославівна. Дата версии: 23.05.2014" />
</doc> |
Request params | |
state | Transfer batch status (r – processed, n – transferred, i – generated, b – rejected, e – error writing to the database) |
oper | Type of the transfer operation (specified if the request tag is transferred in the reqtype attribute (`i` – transfer, `u` – correction, `d` – deleting)) |
compid | ID of the component transferred (currently the following ones are supported: 1 – Identification of the individual, 2 – Credit history, 10 – Contacts |
item | Subcomponent (IDENT, URIDENT, LINKED, WORK, DOC, ADDR, FOTO, CRDEAL, SUSD, CONT) |
ertype | Register type |
crytical | Error severity (SYSTEM – system error, transfer of all the batches is stopped, CRITICAL – critical error, the batch is rejected, NOTICE – the data are accepted, but with a notification for the partner, IGNORED – ignored data, one component in the batch is ignored.) |
inn | Subject’s TIN |
remark | Text of a remark |
See also in this section