Skip to main content

​
Star-Pay ERP API overview

This API reference helps you integrate your ERP software with the Star-Pay gateway. You can use these endpoints to fetch institutions, validate customer accounts, initiate payment, and verify OTP-based payment flows.

​
Available ERP endpoints

  • GET /erp/get-institutions
    Get the list of supported institutions and payment capabilities.
  • POST /erp/account-lookup
    Validate account details and get a message ID for OTP payment flows.
  • POST /erp/initiate-payment
    Create a payment request for methods such as USSD push, OTP, card, QR, and more.
  • POST /erp/verify-otp-payment
    Complete OTP account payment using OTP code, account number, and bill reference.

​
Authentication headers

All ERP endpoints require the x-api-secret header. For OTP verification flow, you also pass x-message-id where required.

​
Typical ERP integration flow

  1. Fetch institutions using GET /erp/get-institutions.
  2. Run account validation using POST /erp/account-lookup.
  3. Initiate payment using POST /erp/initiate-payment.
  4. If payment type is OTP, verify payment using POST /erp/verify-otp-payment.
This flow gives you one GET endpoint and three POST endpoints to support ERP checkout and collection use cases.

OpenAPI Specification

Access the full API contract with detailed endpoints, parameters, and request/response structures for StarPay ERP integration.