Skip to content

List long-running operations

GET
/api/app/operation
curl --request GET \
--url https://test.unipay.co.zw/api/app/operation \
--header 'Authorization: Bearer <token>'
operationId
string format: uuid

OK

Media typeapplication/json
object
operationId
string format: uuid
operationType
string
nullable
status
integer format: int32
Allowed values: 0 1 2 3 4
serviceProviderId
string format: uuid
nullable
total
integer format: int32
processed
integer format: int32
succeeded
integer format: int32
alreadyExists
integer format: int32
updated
integer format: int32
blocked
integer format: int32
failed
integer format: int32
creationTime
string format: date-time
completedAt
string format: date-time
nullable
correlationId
string
nullable
Example
{
"status": 0
}

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