Import up to 5,000 bills

POST

/api/app/bill-import/submit

curl --request POST \
  --url https://test.unipay.co.zw/api/app/bill-import/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "bills": [ { "uniqueNo": "example", "billNo": "example", "serviceProvider": "example", "accountNo": "example", "name": "example", "description": "example", "billDate": "2026-04-15T12:00:00Z", "dueDate": "2026-04-15T12:00:00Z", "currency": "example", "amount": 1, "expiryDate": "2026-04-15T12:00:00Z" } ], "idempotencyKey": "example" }'

• Test

Authorizations

• bearer

Request Body

Media typeapplication/json

object

bills

required

Array<object>

>= 1 items <= 5000 items

object

uniqueNo

required

string

>= 1 characters

billNo

required

string

>= 4 characters <= 50 characters /^[a-zA-Z0-9]+$/

serviceProvider

Obsolete: ignored. Kept so older integrations keep working.

string

nullable

accountNo

string

nullable

name

string

nullable

description

required

string

>= 1 characters

billDate

string format: date-time

dueDate

string format: date-time

currency

required

string

>= 3 characters <= 3 characters

amount

number format: double

>= -999999999999.9999 <= 999999999999.9999

expiryDate

string format: date-time

nullable

idempotencyKey

string

nullable <= 64 characters

Example^generated

{
  "bills": [
    {
      "uniqueNo": "example",
      "billNo": "example",
      "serviceProvider": "example",
      "accountNo": "example",
      "name": "example",
      "description": "example",
      "billDate": "2026-04-15T12:00:00Z",
      "dueDate": "2026-04-15T12:00:00Z",
      "currency": "example",
      "amount": 1,
      "expiryDate": "2026-04-15T12:00:00Z"
    }
  ],
  "idempotencyKey": "example"
}

Responses

200

OK

Media typeapplication/json

object

batchId

string format: uuid

acceptedRows

integer format: int32

status

integer format: int32

Allowed values: 0 1 2 3 4

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"
        ]
      }
    ]
  }
}