Malipo Merchant Payments API

Javascript Link

Initiating the payment

The parameter to pass in the open function

Example request

                   
    window.Malipo.open(
    {
        "merchantAccount": "111903104",
        "currency": "MWK",
        "amount": 50
        "order_id": "131",
        "description": "Subscription payment",
        "onSuccess": (result) => {
            document.getElementById('checkout-modal').style.display = 'none';
        },
        "onError": (error) => {
            console.error('Payment failed:', error);
        },
     });
    

Example Code

POST Request Payment

Payment Request

This endpoint allows you to make a POST request to initiate a payment request.

Request Body

• merchantTrxId(string, required): The unique identifier for the merchant transaction.
• customerPhone (string, required): The phone number of the customer.
• bankId(integer, required): The ID of the bank.
• amount(integer, required): The amount of the payment.

Response

• Status: 201
• Content-Type: application/json
• message(string): A message related to the payment request.
• data(object):
• transaction_id(string): The Unique Id of the transaction in MobiPay system.
• merchant_trx_id(string): The unique merchant transaction ID.
• account_number(string): The account number/projectId under which the payment is made.
• wallet(string): The wallet used for the transaction. Same as customerPhone number.
• amount(integer): The amount of the transaction.
• narration (string): Additional information or description of the transaction.
• transaction_type_id(integer): The ID of the transaction type.
• payment_channel_id (integer): The ID of the payment channel used.

Headers

Body json raw

                   
    
    {
        "merchantTrxId": "111903104",
        "customerPhone": "265994791131",
        "bankId": 1,
        "amount": 50
     }
     
    

POST Refund

This HTTP POST request is used to initiate a refund for a specific transaction by providing the transaction ID in the URL. Upon successful execution, the API returns a 200 status with a JSON response containing the status of the refund, the reversal transaction ID, and the customer reference.

The response body includes the following fields:

• status: Indicates the status of the refund process.
• reversal_trans_id:Represents the Unique MobiPay ID of the reversal transaction.
• customer_ref:Denotes the reference included in the notification sent to the customer.

This endpoint allows users to efficiently process refunds for transactions and retrieve essential information related to the refund operation.

Headers

PATH VARIABLES

POST Disbursement

Withdrawal Payment

This endpoint allows you to execute a withdrawal payment.

Request Body

• merchantTrxId(string, required): The merchant transaction ID.
• customerPhone (string, required): The user's wallet phone number.
• bankId(integer, required): The ID of the bank.
• amount(integer, required): The withdrawal amount.

Response

Upon successful execution, the API returns a JSON response with the following structure:

                   
    
    
     {
        "message": "string",
        "data": {
            "transaction_id": {
                "merchantTrxId": "string",
                "transaction_id": "string",
                "account_number": "string",
                "customerPhone": "string",
                "bankId": 0,
                "amount": 0,
                "transaction_type_id": 0
            }
        }
    }
     
    

• message(string): A message indicating the status of the withdrawal request.
• data(object):The data object containing the transaction details.
• transaction_id(object): The transaction details.
  • merchantTrxId(string): The merchant transaction ID.
  • transaction_id(string): The unique transaction ID.
  • account_number(string): The account number for the withdrawal.
  • amount(string): The customer's phone number.
  • customerPhone (integer): The ID of the bank.
  • amount(integer): The withdrawal amount.
  • transaction_type_id (integer): The ID representing the transaction type.

Headers

Body json raw

                   
    
    {
        "merchantTrxId": "111903106",
        "customerPhone": "265994791131",
        "bankId": 1,
        "amount": 50
     }
     
    

POSTInstant Payment Notification (IPN)/Callback

The URL endpoint is provided by merchant and is where MobiPay will post a transaction status updated of what transpired when the customer was delivered a payment request.

Request Body

• status Can either be Completed or Failed.
• merchant_trx_id Transaction reference originated.
• transaction_idMobiPay transaction reference.
• customer_reference Third-Party system transacton ID delivered to he customer for their reference.

Response

This request does not expect any response and will not be affected by anything the merchant responds with.

Body json raw

                   
    
    
     {
        "status":"Completed",
        "merchant_trx_id":"56527573",
        "transaction_id":"IP0028938",
        "customer_reference":"MP20240612.76368683"
    }
     
    

POST Prepare Invoice

Invoice Preparation

This endpoint allows you to prepare an invoice which can be paid via the web by making an HTTP POST request to

Request Body

• merchantTrxId(string, required): The unique identifier (e.g Order number) from the merchant system.
• amount (number, required, greater than 1): The amount for the invoice.
• redirect_url (string, required): The URL to redirect after the invoice has been paid for on the web.

Headers

Body raw(json)

                   
    

     {
        "merchantTrxId": "TEST00299976",
        "amount": 50,
        "redirect_url":"https://example.com/path/to/order0023/product"
     }
     
     
    

GET Bank List

This endpoint makes an HTTP GET request to retrieve a list of banks from the specified URL. The response will be in JSON format and will include an array of objects, each representing a bank with its id, name, type, and logo URL

Example Response:

                   
    
[
    {
        "id": 0,
        "name": "",
        "type": "",
        "logo_url": null
    }
]
     
    

Headers

GET Transaction Enquiry

This endpoint allows you to retrieve payment details for a specific transaction by providing the transaction ID in the URL.

The response will be in JSON format with a 200 status code. The response includes various details such as application name, app ID, transaction ID, merchant transaction ID, customer reference, payment provider, currency, customer wallet, narration, amount, fee, status, and timestamp.

Add documentation.

Headers

Path Variables

GET Get Balance

This endpoint retrieves the balance information for the account/application.

Request

• Method: GET
• URL: https://app.malipo.mw/api/v1/accounts/balance

Response

• Status: 200
• Content-Type: application/json

                   
    
    {
        "status": "",
        "data": {
            "balance": "",
            "currency": ""
        }
    }
    

Headers