Payment Link API

Collect payments from your customers using payment link.

Summary

The Payment Link API allows merchants to generate payment links for their sub-merchants to easily collect payments. Follow these steps to integrate:

1. Generate a Bearer Token

2. Create a Payment Link

3. Share the Payment Link

4. Monitor Payment Status

5. Fetch payment link transactions via paylinkId

Before you begin!

Integration steps

Generate a Bearer Token

Obtain a token by following the authentication guide here. Use this token as your Bearer token in subsequent API calls.

Create a Payment Link

POST - {{env_url}}/merchant/api/v1/paylink/create

This api generates a payment link that can be given to your customers to make payments.

NB: No need for an encryption of the plain json payload.

Headers

Name	Value
Authorization	Bearer {{token}}
x-auth-token	{{MERCHANT PUBLIC KEY}}

Request Body

Name	Type	Description
name*	String	Sub-Merchant Name
subMerchantId*	String	Sub-Merchant Identification
description*	String	Intending product or service.
currency*	String	NGN
amount*	Decimal	Amount to accept for the product or service.

See an example of the plain json payload to send.

Sample Request

{
    "name": "Klash",
    "subMerchantId": "sub-klasha-23456",
    "description": "Payment for 1000 naira purchase",
    "currency": "NGN",
    "amount": 1000
}

Response

200: OK

{
    "message": "success",
    "error": null,
    "data": {
        "paylinkId": "b8d0aab0-5974-45a6-ae4a-8b6d519b4da2",
        "paylinkUrl": "https://dev.d2qotb20wbiarg.amplifyapp.com/?token=b8d0aab0-5974-45a6-ae4a-8b6d519b4da2",
        "businessId": "111"
    }
}

Share the Payment Link

Distribute the generated payment link URL to your sub-merchants for them to receive payments. The link directs customers to a payment page (See sample of the page below).

Paylink page for the customer to fill and click Pay with klasha button to proceed.

Monitor Payment Status

We would send payment status updates to your configured webhook URL. Monitor this to track payment outcomes. See webhook details here.

Fetch payment link transactions

GET - {{env_url}}/nucleus/paymentLinkTransaction/id/{{paylinkId}}

This api fetches all transactions associated to the paylinkId generated above.

Headers

Name	Value
Authorization*	Bearer {{token}}
x-auth-token*	{{MERCHANT PUBLIC KEY}}

Params

Name	Type	Description
paylinkId*	String	paylink id generated while creating the link

Response

200: OK

{
    "message": "success",
    "error": null,
    "data": [
        {
            "id": 155,
            "amount": 305.00,
            "currency": "KES",
            "sourceAmount": 305.000000,
            "sourceCurrency": "KES",
            "paymentLinkId": "10df0c84-11ec-434c-9020-33d79c0c7a5a",
            "subMerchantId": "89989aa6-7b59-429b-b855-27c289f02fb0",
            "status": "successful",
            "message": "Transaction Successful",
            "tnxRef": "paylink-87858e5b-8eba-4ebe-8cf4-7883f92c5c10",
            "gateRef": "3378988429",
            "paymentType": "MOBILE_MONEY",
            "customerEmail": "[email protected]"
        },
        {
            "id": 154,
            "amount": 1724.03,
            "currency": "NGN",
            "sourceAmount": 305.000000,
            "sourceCurrency": "KES",
            "paymentLinkId": "10df0c84-11ec-434c-9020-33d79c0c7a5a",
            "subMerchantId": "89989aa6-7b59-429b-b855-27c289f02fb0",
            "status": "failed",
            "message": "payment not authorised",
            "tnxRef": "paylink-bf1e85d5-f6e4-475f-b466-87693311a8c7",
            "gateRef": "",
            "paymentType": "BANK_TRANSFER",
            "customerEmail": "[email protected]"
        }
    ]
}