Zippie Icon

# Introduction

Welcome to the Zippie Pay API Documentation

These docs will help you to quickly get up and running with the Zippie Pay API. The documentation includes information you need to know about the API as well as detailed examples to quickly get you going

# Supported Currencies

Zippie Pay API supports the following currencies at the moment.

  • Kenyan shillings (KSH)

# Getting Started

You can start collecting payments from customers who use Zippie Wallet or M-Pesa.

Once your customer taps "Pay" in your webpage or app, a Zippie payment dialogue pops up and guides the customer through the payment process.

You can set up the service in four steps:

  1. Installing the package
  2. Create Forms
  3. Configure Inputs
  4. Call API

# Installation

You can include the Zippie Pay API through the cdn or the npm:

    # Creating your forms

      # Configuring your forms

        # Parameters

        merchantId [string]

        Zippie will provide you a unique Merchant ID which you insert here. If you don't have a Merchant ID yet, contact your Zippie support person.

        orderId [string]

        An Order ID is a unique number which you'll need to identify and track your orders. If you don't have an Order ID, you can use the customer's email address.

        amount [string]

        Input the amount you wish charge your customer. (supports up to 6 decimal e.g. 0.123456)

        email [string]

        The email parameter is where the payment receipt would be sent. Usually your customer's email address.

        # Calling the API

          # Webhooks

          Webhooks are coded like a phone number that Zippie uses to notify you of any activity in your Zippie account, e.g. incoming payments or payout of funds to your bank account. The notification is carried out by calling the configured webhook URL.

          Note: Not all Zippie Pay integrations require webhooks.

          # Getting started

          Before we get started setting up your webhook, you must obtain a secret key from Zippie. Contact your Zippie Support person for your secret key.

          # Setting up your webhook to listen for incoming payments (server side)

          Once your server is up and running, your server would be listening for incoming post request. The secret key is used to verify the header signature in order to make sure the request is coming from Zippie servers.

          # Installation

            # Example

              # Payment data example

              This payment data serves as an example of C2B or Customer to Business (Zippie Wallet to Merchant Wallet)

                # Support

                If you are missing any examples in your preferred programming language, don't hesitate to Contact Us and we will do our best to help.