Skip to main content

Package transfer status

This method allows retrieving the status of a document package and all individual documents status by a package unique ID.

Query params​

keyrequiredinteger

An unique ID of the document in the business online..

GET api/documents/bulk/status/{key}

Response​

Statusstring

A document status.

DocumentStatusesstring

A document array from a package transfer with the following attributes:

UniqueId globally unique identifier

An unique ID of the document in the external (caller) system (Guid).

UniqueKey integer

An unique ID of the document in the business online.

Statusstring

A document status.

BulkLineStatusstring

Is used in case of the package transfer.

RejectCodestring

A rejection code.

ResultCodeinteger

A result code of an operation. (With a link to the ResultCode page).

Matchinteger

For the internal transfers a matched coefficient of provided recipient name. For legal entities a match of an owner of a provided IBAN to the entity name is being checked, while for the individuals - to the name and surname. A match coefficient in percent will be shown as a result of such a comparison. 

{
  "Status": "sample string 1",
  "DocumentStatuses": [
    {
      "UniqueId": "54079737-2913-48d5-a0ed-f22895c33116",
      "UniqueKey": 1,
      "Status": "sample string 2",
      "BulkLineStatus": "sample string 3",
      "RejectCode": 1,
      "ResultCode": 1,
      "Match": 1.0
    },
    {
      "UniqueId": "54079737-2913-48d5-a0ed-f22895c33116",
      "UniqueKey": 1,
      "Status": "sample string 2",
      "BulkLineStatus": "sample string 3",
      "RejectCode": 1,
      "ResultCode": 1,
      "Match": 1.0
    }
  ]
}