Your organisation and its configuration

GET

/api/app/tenant-config

curl --request GET \
  --url https://test.unipay.co.zw/api/app/tenant-config \
  --header 'Authorization: Bearer <token>'

• Test

Authorizations

• bearer

Responses

200

OK

Media typeapplication/json

object

tenant

object

name

string

nullable

type

string

nullable

status

string

nullable

entity

object

id

string format: uuid

name

string

nullable

number

string

nullable

shortCode

string

nullable

address

string

nullable

email

string

nullable

phoneNumber

string

nullable

features

object

eCommerce

boolean

payroll

boolean

paymentsInstruction

boolean

capabilities

Array<object>

nullable

object

paymentType

integer format: int32

Allowed values: 1 2 3 4

currency

string

nullable

reconciliation

object

bankFeeBearer

integer format: int32

Allowed values: 1 2

Example

{
  "capabilities": [
    {
      "paymentType": 1
    }
  ],
  "reconciliation": {
    "bankFeeBearer": 1
  }
}

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