X-Pay Merchant Public Api
  1. Payments
X-Pay Merchant Public Api
  • Payments
    • Introduction to the X-Pay API
    • Integration Guide - Quick Start
    • Integration Guide - Payments
    • X-Pay WooCommerce
    • X-Pay Flutter Plugin
    • .NET SDK
  • XPayMerchant Public API
    • Get Token Sandbox
      POST
    • Get Token Production
      POST
    • Get Currencies
      GET
    • Get Banks
      GET
    • Get Payment intervals
      GET
    • Payment Calculator
      POST
    • Test Webhook Sandbox
      POST
    • Test Webhook Production
      POST
    • Pay Visa Sandbox
      POST
    • Pay Visa Production
      POST
    • Pay Mastercard Sandbox
      POST
    • Pay Mastercard Production
      POST
    • Pay Mastercard Sandbox Bulk
      POST
    • Pay Mastercard Production Bulk
      POST
    • Pay Visa Sandbox Bulk
      POST
    • Pay Visa Production Bulk
      POST
    • Payment Status Visa Sandbox
      GET
    • Payment Status MasterCard Sandbox
      GET
    • Payment Status Visa Production
      GET
    • Payment Status Mastercard Production
      GET
    • Generate Payment Token Sandbox
      POST
    • Generate Payment Token Production
      POST
    • Card Token Payment Sandbox
      POST
    • Card Token Payment Production
      POST
    • Delete Card Token Sandbox
      DELETE
    • Fast Checkout
      POST
    • Fast Checkout Sandbox
      POST
  1. Payments

Integration Guide - Payments

📄 Contents#

Payments
Create Payment Profile
Add Beneficiaries
Create Payment Link
Receive Payment

Payments#

This payment gateway is extremely user-friendly, that is, merchants can customise how payments are handled. Merchants can create payment links and can either cover all the service charges or forward those to the customer. Here is how:

Step 1: Create Payment Profile#

Merchant can create multiple payment profiles linking them to multiple bank accounts added during account registration in a variety of currencies.
Screenshot 2024-10-16 170652.png
Screenshot 2024-10-17 094355.png

Step 2: Add Beneficiaries#

Merchant can add beneficiaries to each payment profile. When a payment is received it is split according to the percentages of each beneficiary. When payment is processed successfully the transaction is recorded in all of the beneficiaries' profiles.
Screenshot 2024-10-16 171932.png

Step 3: Create Payment Link#

The customer needs a platform with the details of the product they desire to make a payment for. A payment link contains the details required by the customer to make the payment. A merchant creates a payment link that generates a qrcode aswell that is shared with the customers. When a customer follows the link, they will be redirected to a payment form with various payment methods.
Screenshot 2024-10-17 100920.png

Step 4: Receive Payment#

Customers can select a payment method of choice. Customers can make payment with Innbucks
Screenshot 2024-10-17 110255.png
Customers can make payment with ZimSwitch
Screenshot 2024-10-17 110343.png
Customers can make payment with Ecocash
Screenshot 2024-10-17 110415.png
In some cases the payment might not complete processing immediately, the payment status of the transacion can be retrieved.
Screenshot 2024-10-17 111932.png
When the customer makes a payment, they might want to make the same payment regularly. The recurring payment feature enables the payment to be initiated automatically.
Screenshot 2024-10-17 112825.png
The recurring payment can be canceled at any time
Screenshot 2024-10-17 112943.png
The customer might select the Buy Now Pay Later option so that they can receive their desired product before thaey have made the full payment. This is also known as Credit Application. Which needs approval from the employer, microfinance and merchant.
Modified at 2025-11-17 18:35:01
Previous
Integration Guide - Quick Start
Next
X-Pay WooCommerce
Built with