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:
Generate a Bearer Token
Create a Payment Link
Share the Payment Link
Monitor Payment Status
Integration steps
Generate a Bearer Token
Obtain a token by sending a POST request to the Token endpoint. Use this token for authentication in subsequent API calls.
POST
{{env_url}}/
auth/account/v2/login
Request Body
Name | Type | Description |
---|---|---|
username* | username | |
password* | password |
Create a Payment Link
Make a POST request to the Payment Link API, including necessary headers like Authorization
(Bearer token) and x-auth-token
(Merchant public key). The request body should contain details such as sub-merchant ID, description, currency, and amount.
Authorization
(Bearer token) and x-auth-token
(Merchant public key). The request body should contain details such as sub-merchant ID, description, currency, and amount.POST
{{env_url}}
/
merchant/api/v1/paylink/create
Make a POST call to the Payment link to generate a payment link. See an example of the plain json payload to send.
No need for an encryption of the plain json payload.
You’d need to pass, as header the x-auth-token
. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.
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. |
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 paylinkUrl page below.
Monitor Payment Status
Klasha sends payment status updates to your configured webhook URL. Monitor this to track payment outcomes.
Last updated