List service providers

GET

/api/app/directory/service-providers

curl --request GET \
  --url 'https://test.unipay.co.zw/api/app/directory/service-providers?PaymentType=1' \
  --header 'Authorization: Bearer <token>'

• Test

Authorizations

• bearer

Parameters

Query Parameters

Filter

string

Country

string

Town

string

Currency

string

PaymentType

integer format: int32

Allowed values: 1 2 3 4

Sorting

string

SkipCount

integer format: int32

<= 2147483647

MaxResultCount

integer format: int32

>= 1 <= 2147483647

Responses

200

OK

Media typeapplication/json

object

items

Array<object>

nullable

object

id

string format: uuid

name

string

nullable

number

string

nullable

shortCode

string

nullable

address1

string

nullable

address2

string

nullable

country

string

nullable

town

string

nullable

phoneNumber

string

nullable

email

string

nullable

tin

string

nullable

companyNumber

string

nullable

capabilities

Array<object>

nullable

object

paymentType

integer format: int32

Allowed values: 1 2 3 4

currency

string

nullable

defaultCurrency

string

nullable

presentationCurrencies

Array<string>

nullable

acceptedCurrencies

Array<string>

nullable

acceptedCurrenciesDeclared

boolean

currencyPolicy

integer format: int32

Allowed values: 1 2

allocationRateToleranceDays

integer format: int32

nullable

totalCount

integer format: int64

Example

{
  "items": [
    {
      "capabilities": [
        {
          "paymentType": 1
        }
      ],
      "currencyPolicy": 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"
        ]
      }
    ]
  }
}