PAY HERO DOCS
  • Introduction-Pay Hero Developer APIs
  • Creating Account
  • Authorization
  • GET: Service Wallet Balance
  • GET: Payments Wallet Balance
  • POST: Service Wallet Top Up
  • POST: Initiate MPESA STK Push Request
  • Payment Button
  • Lipwa Link
  • POST: Pay Hero Wallet- Withdraw To Mobile
  • GET: Account Transactions
  • GET: Transaction Status
  • WooCommerce Plugin
    • Plugin Installation
  • Shopify
  • Videos
  • Other Integrations
  • Email API Reference
    • Register SMTP
    • Send Email
    • Mail status
  • WhatsApp API Reference
    • Introduction
    • Getting Started
    • Send API Whats App Text
    • Bulk WhatsApp API Messaging
    • Bulk WhatsApp Using UI/CSV File
Powered by GitBook
On this page

Was this helpful?

Lipwa Link

How to Use Your Unique Lipwa Link on Pay Hero

When you create an account on Pay Hero, you are provided with a unique Lipwa link. This link allows you to receive payments directly into your linked MPESA Paybill, Till, or bank account. You can share this link with your customers online, making it easy and seamless for them to pay you.

Customizing Your Lipwa Link

Your Lipwa link can be customized to include pre-filled payment details, saving your customers from the hassle of manually entering the information. To customize your link, you can pass the following parameters:

  • amount: The payment amount to be pre-filled on the payment form.

  • phone: The customer's phone number.

  • name: The customer's name.

  • channel_id: The payment channel ID from your Pay Hero payment channels.This will be the channel to receive payments

  • reference: A reference or description for the payment, helping you identify the purpose of the payment.

  • success_url: A URL where the customer will be redirected after a successful payment.

  • failed_url: A URL where the customer will be redirected in case the payment fails.

By including these parameters in your Lipwa link, the payment form will automatically populate with the relevant details. This ensures a smooth and efficient payment process for your customers, eliminating the need for manual data entry.

Example

Here’s an example of a customized Lipwa link:

https://app.payhero.co.ke/lipwa/5?amount=500&phone=254712345678&name=JohnDoe&channel_id=100&reference=Invoice123&success_url=https://yourwebsite.com/success&failed_url=https://yourwebsite.com/failed

With this link:

  • The amount is pre-filled as 500.

  • The customer's phone number is set to 254712345678.

  • The name is set to John Doe.

  • The payment channel is identified as 12345.

  • The reference is set to Invoice123.

  • The customer will be redirected to https://yourwebsite.com/success after a successful payment.

  • In case of a failed payment, the customer will be redirected to https://yourwebsite.com/failed.

Using this approach, you can provide a hassle-free payment experience to your customers while maintaining control over the payment process.

PreviousPayment ButtonNextPOST: Pay Hero Wallet- Withdraw To Mobile

Last updated 4 days ago

Was this helpful?

You can use a service like: to create a short URL and share it

https://www.shorturl.at/