1. Authorization
ZamuPay API Documentation
  • Introduction
  • Definitions
    • Data Types
  • Authorization
    • Overview
    • Token Request
      POST
    • Find Transaction Routes
      GET
    • Health Check
      GET
  • Checkout Request
    • Overview
    • Checkout Order Request
      POST
    • Query Checkout Request
      GET
    • Checkout Callback Request
      POST
  • Payment Request
    • Payment Order Request
      POST
    • Reject Order By OriginatorConversationId
      POST
    • Find Payment Order By OriginatorConversationId
      GET
  • Collection Request
    • Find Express Deposit By OriginatorConversationId
      GET
    • Express Deposit Request
      POST
  • Bill Payments
    • Bill Number
      POST
    • Find Bill Number By Service Id and Account Number
      GET
    • Bill Request
      POST
    • Find Bill Request By Originator Converstion Id
      GET
    • Find Bill Services
      GET
  • KYC
    • Account Number Validation Request
      POST
    • KYC Validation
      POST
    • KYC Validation
      GET
    • Find Account Validation Status by SystemTraceAuditNumber
      GET
  • Payment Links
    • Find Payment Links By Id
    • Create Payment Link
    • Update Payment Link
  • Customer Accounts
    • Balance Check
    • Find Charges By TransactionTypeId
  • Airtime Purchase
    • Airtime Purchase
    • Find Airtime Purchases By OriginatorConversationId
  1. Authorization

Overview

Authorization#

ZamuPay™ Gateway uses the industry-standard OAuth 2.0 (Client Credentials Grant) protocol to secure all API communication.
Before you can interact with our endpoints, you must obtain a temporary Access Token using your merchant credentials.

[!IMPORTANT]

🔐 Protect your Credentials#

Your client_secret is a sensitive piece of information. Never share it in public repositories, client-side code, or insecure communication channels.

🏗️ The Auth Flow#

All requests to the ZamuPay API must include an Authorization header containing a valid Bearer Token.

🚦 Step-by-Step Integration#

1. Retrieve your Credentials#

Log in to the ZamuPay Dashboard and navigate to Settings > API Keys. You will find:
Client ID: Your public identifier.
Client Secret: Your private key (keep this secret!).

2. Obtain an Access Token#

Send a POST request to our identity server.
EndpointMethod
https://api-sandbox.zamupay.com/v1/oauth/tokenPOST
Request Body:
{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "grant_type": "client_credentials"
}

3. Use the Bearer Token#

Once you receive the access_token, include it in every subsequent API request using the Bearer scheme.
Header Example:

🚥 Token Expiry & Errors#

IssueReasonSolution
401 UnauthorizedInvalid ID or SecretDouble-check your credentials in the dashboard.
Token ExpiredToken duration exceededImplement a refresh logic to request a new token.
403 ForbiddenValid token, but no permissionsEnsure your account has the correct scopes enabled.

🆘 Need Help?#

If you're having trouble authenticating, please contact our technical team at support@zamupay.com.
Modified at 2026-01-30 12:25:35
Previous
Data Types
Next
Token Request
Built with