Service provider guide
As a service provider you raise bills, and UniPay lets every connected payment processor collect against them — banks, mobile-money operators, fintechs — without an integration with each. Your part of the payment lifecycle:
flowchart LR
B[(Your billing<br/>or ERP system)] -- "1 · publish bills" --> U[UniPay]
PP[Payment processors] -- "look up · pay" --> U
U -- "2 · payments feed" --> B
U -. "3 · settlement" .-> K[(Your bank account)]
class U unipay
- Publish your bills so processors can find them, and republish them as they change — Publish bills. Optionally, publish your account balances and exchange rates too — Accounts and exchange rates.
- Collect the payments made against them into your own system, and apply any reversals — Collect payments.
- The money is settled to your bank account, separately from the API.
UniPay never calls you: your system publishes and pulls on its own schedule.
The Axis Sync Engine
Section titled “The Axis Sync Engine”Most service providers don’t call the API themselves. The Axis Sync Engine, installed beside your billing system (Promun, Sage and others), publishes your bills and collects your payments for you — get it and the bridge for your ERP from Downloads. These pages describe what it does on your behalf — and what to build if you integrate directly.
What you can call
Section titled “What you can call”Everything lives under /api/app/service-provider/ and /api/app/bill-import/. Your token needs unipay:bills, plus unipay:payments
to read payments.
| Task | Endpoint | Reference |
|---|---|---|
| Publish one bill | POST /api/app/service-provider/bill |
publishBill |
| Publish up to 500 bills | POST /api/app/service-provider/bills |
publishBills |
| Import up to 5,000 bills | POST /api/app/bill-import/submit |
submitBillImport |
| Publish up to 500 account balances | POST /api/app/service-provider/accounts |
publishAccounts |
| Finish an account balance snapshot | POST /api/app/service-provider/finalize-account-sync |
finalizeAccountSync |
| Publish up to 1,000 exchange rates | POST /api/app/service-provider/currency-rates |
publishCurrencyRates |
| Read your exchange rates | GET /api/app/service-provider/currency-rates |
listCurrencyRates |
| Currencies you accept | GET /api/app/service-provider/accepted-currencies |
acceptedCurrencies |
| Read new payments | GET /api/app/service-provider/payments |
listPayments |
| Read reversals | GET /api/app/service-provider/payment-reversals |
listPaymentReversals |
| Read processors’ day settlements | GET /api/app/service-provider/processor-settlements |
listProcessorSettlements |
The Service Provider API reference lists every endpoint and field, including some used only by the Axis Sync Engine.
UniPay API v1 · build e1eb5c49 · Powered by Axis Solutions