Bill import progress

GET

/api/app/bill-import/status/{batchId}

curl --request GET \
  --url https://test.unipay.co.zw/api/app/bill-import/status/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Test

Authorizations

• bearer

Parameters

Path Parameters

batchId

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

batchId

string format: uuid

status

integer format: int32

Allowed values: 0 1 2 3 4

totalRows

integer format: int32

processedRows

integer format: int32

successCount

integer format: int32

alreadyExistsCount

integer format: int32

updatedCount

integer format: int32

blockedCount

integer format: int32

failureCount

integer format: int32

pendingRows

integer format: int32

creationTime

string format: date-time

completedAt

string format: date-time

nullable

Example

{
  "status": 0
}

400

Bad Request

Media typeapplication/json

object

error

object

code

string

nullable

message

string

nullable

details

string

nullable

data

object

key

additional properties

validationErrors

Array<object>

nullable

object

message

string

nullable

members

Array<string>

nullable

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "data": {
      "additionalProperty": "example"
    },
    "validationErrors": [
      {
        "message": "example",
        "members": [
          "example"
        ]
      }
    ]
  }
}

401

Unauthorized: token missing, invalid or expired. Empty body.

403

Forbidden: the token lacks the scope this call needs. Empty body. (Refusals specific to your organisation use the error object.)

404

Not found: wrong path. Empty body.

500

Internal Server Error

Media typeapplication/json

object

error

object

code

string

nullable

message

string

nullable

details

string

nullable

data

object

key

additional properties

validationErrors

Array<object>

nullable

object

message

string

nullable

members

Array<string>

nullable

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "data": {
      "additionalProperty": "example"
    },
    "validationErrors": [
      {
        "message": "example",
        "members": [
          "example"
        ]
      }
    ]
  }
}