List Wallets

A vendor can request a list of their wallet details.

Request

GET /api/wallets

Response

[
  {
    "Currency": "ZWG",
    "Balance": 18874.19,
    "LowBalance": 2000.0,
    "MinimumBalance": 0.0,
    "Status": "Open"
  },
  {
    "Currency": "USD",
    "Balance": -431.0,
    "LowBalance": 0.0,
    "MinimumBalance": -10000.0,
    "Status": "Open"
  }
]

note

In the example above, the vendor is permitted $10,000 overdraft on their USD wallet, hence the minimum balance is shown as -10,000.

tip

A "Low Wallet Balance" notification can be generated by BillPay and emailed to your specified "Accounts Department Email". Request the BillPay operations team to set the "Low Balance Threshold" per wallet for your vendor.

Wallet Status

Code	Status	Description
1	Open	Normal. Vendor can transact
2	Suspended	Wallet has been suspended by Paynow BillPay administration (temporarily)
3	Closed	Wallet has been emptied and closed permanently