Skip to content

Publish a bill

POST
/api/app/service-provider/bill
curl --request POST \
--url https://test.unipay.co.zw/api/app/service-provider/bill \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "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" }'
Media typeapplication/json
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
Examplegenerated
{
"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"
}

OK

Media typeapplication/json
object
successful
boolean
message
string
nullable
isNewRecord
boolean
status
string
nullable
errorCode
string
nullable
Examplegenerated
{
"successful": true,
"message": "example",
"isNewRecord": true,
"status": "example",
"errorCode": "example"
}

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
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example",
"data": {
"additionalProperty": "example"
},
"validationErrors": [
{
"message": "example",
"members": [
"example"
]
}
]
}
}

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

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

Not found: wrong path. Empty body.

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
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example",
"data": {
"additionalProperty": "example"
},
"validationErrors": [
{
"message": "example",
"members": [
"example"
]
}
]
}
}

UniPay API v1 · build e1eb5c49 · Powered by Axis Solutions