1. Checkout Request
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. Checkout Request

Overview

This document describes how to handle checkout flows, including callbacks, return, and cancellation endpoints.

URL TypeMethodPayload TypeNotes
callbackUrlPOSTJSONAsynchronous notification of transaction status. Respond with HTTP 200.
returnUrlPOSTForm URL EncodedRedirect user after payment. Include secure hash as query string.
cancelUrlPOSTOptionalRedirect user if transaction is canceled.

Security:
Secure your returnUrl with a special hash or signature passed as a query string to validate the integrity of the request.
Example:
https://checkout.merchant.com/return?hash=abcd1234
Usage:
Contains the same transaction data as the callbackUrl, allowing your system to confirm checkout details.
Modified at 2026-01-30 08:37:26
Previous
Health Check
Next
Checkout Order Request
Built with