Report a fiscalisation result

POST

/api/app/service-provider/fiscalization-result

curl --request POST \
  --url https://test.unipay.co.zw/api/app/service-provider/fiscalization-result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "billNo": "example", "qrCodeUrl": "example", "verificationCode": "example", "currency": "example", "paymentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Test

Authorizations

• bearer

Request Body

Media typeapplication/json

object

billNo

required

string

>= 1 characters <= 100 characters

qrCodeUrl

required

string

>= 1 characters

verificationCode

required

string

>= 1 characters <= 50 characters

currency

string

nullable <= 3 characters

paymentId

string format: uuid

nullable

Example^generated

{
  "billNo": "example",
  "qrCodeUrl": "example",
  "verificationCode": "example",
  "currency": "example",
  "paymentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

successful

boolean

message

string

nullable

isNewRecord

boolean

status

string

nullable

errorCode

string

nullable

Example^generated

{
  "successful": true,
  "message": "example",
  "isNewRecord": true,
  "status": "example",
  "errorCode": "example"
}

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