...
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2/handsent/sentreestr |
Request |
| ||
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 inthemode todo="BIL" mode=”BIL” indate=”2023-12-01” grp=”PACK” |
| ||
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 |
| ||
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 |
...