Service provider directory

The directory lists every active service provider on UniPay. Use it to build a “who can I pay?” list, to find a provider’s number or short code for account payments, or to check which currencies it accepts before offering them. Scope: unipay:directory.

List providers

GET /api/app/directory/service-providers

Query	Notes
filter	Partial, case-insensitive match on name, number, short code or TIN.
country, town	Exact match (case-insensitive).
currency	Only providers that can be settled in this currency.
sorting, skipCount, maxResultCount	Paging.

{
  "totalCount": 12,
  "items": [
    {
      "number": "4444",
      "shortCode": "MUT1",
      "name": "City of Mutare",
      "town": "Mutare",
      "country": "Zimbabwe",
      "phoneNumber": "+263…",
      "email": "billing@…",
      "tin": "2001234567",
      "defaultCurrency": "USD",
      "acceptedCurrencies": ["USD", "ZWG"]
    }
  ]
}

Providers change rarely: cache the list and refresh it daily rather than calling it per customer.

One provider

GET /api/app/directory/service-providers/{providerRef} — by number or short code. With the unipay:directory.settlement scope, the answer includes the provider’s settlement bank accounts, with account numbers masked (**** **** **** 1234).

If you initiate the bank transfers that settle payments, the unipay:directory.settlement.reveal scope lets you reveal an account’s full number. Every reveal is audited. Ask for this scope only if you need it.