Look up a bill or account

POST

/api/app/payment-processor/lookup

curl --request POST \
  --url https://test.unipay.co.zw/api/app/payment-processor/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "billNo": "example", "serviceProvider": "example", "accountNumber": "example", "currency": "example" }'

• Test

Authorizations

• bearer

Request Body

Media typeapplication/json

object

billNo

string

nullable

serviceProvider

string

nullable

accountNumber

string

nullable

currency

string

nullable

Example^generated

{
  "billNo": "example",
  "serviceProvider": "example",
  "accountNumber": "example",
  "currency": "example"
}

Responses

200

OK

Media typeapplication/json

object

successful

boolean

message

string

nullable

isNewRecord

boolean

status

integer format: int32

Allowed values: 0 1 2 3 4

errorCode

string

nullable

bill

object

uniqueNo

string

nullable

billNo

string

nullable

serviceProviderNumber

string

nullable

serviceProviderName

string

nullable

billDate

string format: date-time

accountNumber

string

nullable

name

string

nullable

description

string

nullable

totalAmount

number format: double

standing

integer format: int32

Allowed values: 0 1 2

totalPaid

number format: double

remainingBalance

number format: double

currency

string

nullable

dueDate

string format: date-time

nullable

expiryDate

string format: date-time

nullable

serviceProvider

string

nullable

accountNo

string

nullable

amount

number format: double

otherCurrenciesAvailable

Array<string>

nullable

amountDueNow

number format: double

nullable

payableNow

number format: double

nullable

balanceAsAt

string format: date-time

nullable

balanceSource

string

nullable

balanceIsStale

boolean

accountBalances

Array<object>

nullable

object

currency

string

nullable

amountDue

number format: double

asAt

string format: date-time

isStale

boolean

acceptedCurrencies

Array<string>

nullable

requestedCurrencyAccepted

boolean

nullable

requestedCurrency

string

nullable

conversionApplied

boolean

convertedTotalAmount

number format: double

nullable

convertedRemainingBalance

number format: double

nullable

rate

number format: double

nullable

rateDate

string format: date-time

nullable

rateIsStale

boolean

conversionIsIndicative

boolean

Example

{
  "status": 0,
  "bill": {
    "standing": 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"
        ]
      }
    ]
  }
}