Zaakpay Payment Links S2S

Send one time payment links to your customers

Introduction

Payment links allow merchants to collect payment from user quickly without the need of integrating Zaakpay. Users get to choose from a variety of payment modes and complete payment accordingly. Merchants can pre set details such as amount, link expiry time, etc before sending it across to the customer via SMS or email and accept payments directly in your bank account.

👍

Have you generated the keys?

For the payment link transaction it is mandatory to generate the API keys. Please follow steps below to generate API keys:

  • Login to the Zaakpay dashboard.
  • Go to Configurations
  • Click on API keys tab under that you'll find the API Keys section. Kindly refer to the screenshot below for clear understanding.

Create Payment Link Using Dashboard

You can easily create payment links from the Zaakpay dashboard and can customise it according to your needs. Follow the below steps carefully in order to generate a payment link through the dashboard.
There are two options provided by Zaakpay in payment links

  • Single Payment Links
  • Bulk Payment Links

Single Payment Links

Single payment links are useful when you need to send a single payment link to a customer and accept payment. In order to create a Single payment link follow following steps.

  • Log into your zaakpay dashboard.
  • Go to "Payment links" section.
  • If you want to create a single payment link go to Create Single Payment Links section and fill all the necessary details

After clicking on generate link you can send the link through any convenient channel and accept payments.

Bulk Payment Links

Bulk Payment links is a feature provided by Zaakpay where you can create multiple payment links just by uploading a CSV or XLSX file containing the information of the customer. In order to create a Bulk payment links follow following steps.

  • Log into your zaakpay dashboard.
  • Go to "Payment links" section.
  • If you want to create a bulk payment links go to Create Bulk Payment links section and upload the necessary files.

❗️

Note!

It is mandatory to follow the predefined format to upload a CSV or XLSX in order to have bug free payment links creation.

Create Payment Link Using API

With this API you’ll be able to create single or multiple payment links through the API. Read the documentation carefully for thorough understanding of the functionality of API.

❗️

WARNING!

Please ensure that this API should be integrated at server side only because it works with API-Key provided to the merchant and that API-Key should be stored in a secure and safe manner on the server.

Enviornment details:

Staging domain : https://pay-stg.zaakpay.com
Production Domain : https://pay.zaakpay.com

API endpoint : /pl/api/v1/create
Request Method : POST

Request Headers

Below mentioned is the header that will be required to call the API through a cURL request.

Fields DataType Mandatory Description
X-API-KEY String Y This key will be used to authorise the API request , merchant can generate API KEY on the same panel on which secret key was generated. For eg :5d5adbadf57246b1925a9afca08c05fa

Request Body

Below is the thorough description of what all to be added in the body of curl request.

Fields DataType Mandatory Description
batchId String Y This will be used as the Batch Id.For eg : Test
details Array Of
Request Parameters of each link
Y This includes the details of each link. For eg :
[
  {
   "orderId": "onido9d4hd4",
  "invoiceNumber": "INV5",
  "amount": 11,
   "internalNotes": "testing purpose",
   "linkExpireBy": "25/09/2021 14:39:31",
  "productDescription": "lan",
  "customerEmail":"[email protected]",
  "customerMobile": 8171225761
 }
]

Request Attributes For Each Link

Below contains an in detail description of request parameters in the cURL request. These request parameters will be different for every link that you are generating in the same curl request.

Fields DataType Mandatory Description
orderId String Y Order Id must be unique whenever request is raised and should be a maximum length of 30 characters. For eg : onido9d4hd4
invoiceNumber String Y Free text (max 20 character). For eg: INV5
amount String Y Value in rupees. Min 1 rupee Max 100000 rupees. Amount limit saved under Transaction Limit in your Zaak-pay panel.
internalNotes String Y The sole purpose of internal notes is Internal testing
linkExpireBy String (dd/mm/yyyy hh:mm:ss) Y Value should be greater than the current date
customerEmail String Y Email entered should be valid For eg : [email protected]
customerMobile String Y All valid mobile numbers i:e 10 digit mobile number. For eg : 2456823475
productDescription String Y Text description of what you are selling At Least one product. For eg : Lan
sendFlag String N It will decide whether to send Link or not. For eg : True ( Optional )

Sample Request and Response

Below are the sample request and response for your reference.
###Sample Request
Below contains a sample request for generating a payment link based on all the parameters mentioned above.

curl --location --request POST 'https://pay-stg.zaakpay.com/pl/api/v1/create' \
--header 'X-API-Key: 67d5ef83ba1840f8984741471b761717' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
   "batchId": "batch1",
   "details": [
       {
           "orderId": "onido9d4hd4",
           "invoiceNumber": "INV5",
           "amount": 11,
           "internalNotes": "testing purpose",
           "linkExpireBy": "25/09/2021 14:39:31",
           "productDescription": "lan",
           "customerEmail": "[email protected]",
           "customerMobile": 8171225761
       },
       {
           "orderId": "onido9d4hssd4",
           "invoiceNumber": "INV5",
           "amount": 10.99,
           "internalNotes": "testing purpose",
           "linkExpireBy": "25/09/2021 14:39:31",
           "productDescription": "lan",
           "customerEmail": "[email protected]",
           "customerMobile": 8171225761
       }
   ]
}'

Sample Response

This is a sample response after you hit the above cURL request.

{
    "success": true,
    "statusCode": 200,
    "errorMessage": null,
    "data": [
        {
            "amount": 11.0,
            "productDescription": "lan",
            "customerMobile": "8171225761",
            "customerEmail": "[email protected]",
            "invoiceNumber": "INV5",
            "internalNotes": "testing purpose",
            "linkExpireBy": "2021-09-25 14:39:00",
            "link": "https://pay-stg.zaakpay.com/pl/p6UiLBc",
            "errorDescription": null,
            "orderId": "onido9d4hd4"
        },
        {
            "amount": 10.99,
            "productDescription": "lan",
            "customerMobile": "8171225761",
            "customerEmail": "[email protected]",
            "invoiceNumber": "INV5",
            "internalNotes": "testing purpose",
            "linkExpireBy": "2021-09-25 14:39:00",
            "link": "https://pay-stg.zaakpay.com/pl/p747ylU",
            "errorDescription": null,
            "orderId": "onido9d4hssd4"
        }
    ]
}
{
   "success": true,
   "statusCode": 200,
   "errorMessage": null,
   "data": [
       {
           "amount": 1100000.0,
           "productDescription": "lan",
           "customerMobile": "8171225761",
           "customerEmail": "[email protected]",
           "invoiceNumber": "INV5",
           "internalNotes": "testing purpose",
           "linkExpireBy": "2022-09-25 14:39:31",
           "link": null,
           "errorDescription": "Invalid Amount",
           "orderId": "onido9d4hd4"
       }
   ]
}

Request Validation Error Messages

A few possible errors against each parameter are mentioned below. Please go through it carefully in order to debug your request in the most efficient way.

Field Message Expected Scenario
orderId Order Id maximum length exceeded If length exceeds 255 characters
orderId Order Id is mandatory If orderId is empty
invoiceNumber Invoice Number maximum length exceeded If length exceeds 45 characters
amount Invalid Amount If amount contains invalid character or amount range is invalid
amount Amount is mandatory If amount is empty
internalNotes Internal Notes maximum length exceeded If length exceeds 255 characters
productDescription Product Description is Invalid If length exceeds 255 characters
productDescription Product Description is mandatory If productDescription is empty
customerEmail Customer Email is Invalid If email is of invalid format
customerMobile Customer Mobile Number is Invalid If mobile number is of invalid format
customerMobile And customerEmail Email or Mobile Number missing One of the two fields is mandatory

Did this page help you?