zipNACH API

Simplify Integration, Maximize Productivity
Our platform offers a convenient solution where you can seamlessly integrate and experience the convenience, reliability, and efficiency of our APIs services.

API References

  • Physical Mandate
  • Aadhaar Mandate
  • e-Mandate
  • UPI Autopay
  • zipKollect

Purpose of Physical Mandate API

zipNACH API is, platform independent and can be used in any Application including but not limited to mobile applications. This enables Corporates to use their interface or application with the benefits of zipNACH platform.

Step 1 – Create Physical Mandate

Method Type: ‘POST’

 Request Headers:  Content-type: “JSON”;
                      // or
                      Request Body: { {
                        "AppID": "xxxxxx", (Encrypted value)
                        "MerchantKey": "xxxxxxxxxx", ", (Encrypted value)
                        "MDate": "2019/07/04",
                        "SpBankCode": "KKBK0RTGSMI",
                        "UTLSCode": "NACH000000000XXXX",
                        "TDebit": "SB",
                        "BankAc": "5XXXXXXXXXX ", (Encrypted value)
                        "IFSC": "CITI0100000",
                        "MICR": "", (Blank)
                        "Amt": "1.00", (Encrypted value)
                        "Frequency": "Q",
                        "DType": "M",
                        "Ref1": "21532482219",
                        "Ref2": "",
                        "Phone": "9179440373", (Encrypted value)
                        "Email": "cust@gmail.com ", (Encrypted value)
                        Private & Confidential
                        Page | 5
                        "PFrom": "2019/07/04",
                        "PTo": "2020/08/04",
                        "UntlCancel": "",
                        "Cust1": "Fateh Singh",
                        "Cust2": "",
                        "Cust3": "",
                        "ProductId":"CD",
                        "BranchId":"Bandra",
                        "EMIdate":"17",
                        "CategoryCode":"L001",
                        “BankCode”:”KKBK”
                        "FirstCollectionDate": “”,
                        "CollectionAmt":"" (If present then-Encrypted value)
                        }
                        Sample Response- Failure
                        
                        {
                        "Message": "Invalid Merchant Key",
                        "Status": "Failure"
                        "ResCode": “PhErr001",
                        }
                        Sample Response- Success
                        
                        {
                        "MdtID": "300002119071900005", (Encrypted value)
                        "Message": “Physical",
                        "Status": "Success"
                        "ResCode": “PhRes001",
                        “PDFBase64": "Base64 PDF”,
                        } }  ;

Authentication/Security

SSL Certificates: These will be used to establish a peer-to-peer trust relationship. By means of these certificates all incoming and outgoing XML messages will be encrypted/decrypted and sent by way of HTTPS for efficiency.

IP Whitelisting:This is mandatory for authorised server access.

LDAP Authentication:For using the ZipNACH API, application ID (AppID) and merchant key (MerchantKey) needs to be sent along with request for each and every time whenever the API is being called. AppID and MerchantKey will be provided by setup team.

API-2a

Upload signed scanned image of mandate. Please note triplicate image and single mandate image are accepted through different API’s. If triplicate image is uploaded system will auto-crop and convert image as per NPCI and if single mandate image is uploaded, system will just convert image specifications as per NPCI. Please note corporate can re-upload the image until image is approved/submitted in the system. Once image is uploaded, corporate will receive converted image in jpg and tiff format

Step 2 –For Triplicate Image

Headers:

    Content-type: “JSON”;
                    // or
                    Request Body:  {
                      {
                        "AppID":"xxxx", (Encrypted value)
                        "MerchantKey":"xxxxx", (Encrypted value)
                        "MdtID":"300002119071900005" (Encrypted value)
                        “ScannedImage”: “ScannedImage in Base64”,
                        }
                      Sample Response- Failure
                      
                      {
                        "Message": “Mandate already submitted for processing",
                        "Status": "Failure"
                        "ResCode": “PhErr007"
                      }
                      Sample Response- Success
                      
                      {
                        "Message": “Image Uploaded ",
                        "Status": "Success",
                        "ResCode": “PhRes002",
                        "MdtID":"300002119071900005" (Encrypted value)
                        “JpgImage”: “Base64”,
                        “TifImage”: “Base64”,
                      } }  ;

API-2b

Step 2 –For Single mandate Image:

Headers:

    Content-type: “JSON”;
            // or
            Request Body:  {
              {
                "AppID":"xxxx", (Encrypted value)
"MerchantKey":"xxxxx", (Encrypted value)
"MdtID":"300002119071900005" (Encrypted value)
“ScannedImage”: “ScannedImage in Base64”,
                }
              Sample Response- Failure
              
              {
                "Message": “Mandate already submitted for processing",
                "Status": "Failure"
                "ResCode": “PhErr007"
              }
              Sample Response- Success
              
              {
                "Message": “Image Uploaded ",
                "Status": "Success",
                "ResCode": “PhRes002",
                "MdtID":"300002119071900005" (Encrypted value)
                “JpgImage”: “Base64”,
                “TifImage”: “Base64”,
              } }  ;

API-3

This step require corporate to approve uploaded image for processing. Please note once images are approved, corporate cannot re-upload image/download mandate pdf.

Step 3 –

Headers:

    Content-type: “JSON”;
                    // or
                    Request Body:  {
                      {
                        "AppID":"xxxx", (Encrypted value)
                        "MerchantKey":"xxxxx", (Encrypted value)
                        "MdtID":"300002119071900005" (Encrypted value)
                        }
                      Sample Response- Failure
                      
                      {
                        "Message": “Mandate Image not found",
                        "Status": "Failure"
                        "ResCode": “PhErr008",

                      }
                      Sample Response- Success
                      
                      {
                        "Message": “Image approved",
 "Status": "Success",
 "ResCode": “PhRes003",
 "MdtID":"300002119071900005" (Encrypted value)
                      } }  ;

Seamless NACH Mandate Management: Empower Efficiency, Eliminate Errors, and Embrace Automation with zipNACH!

Copyright © 2023. All rights reserved by Yoeki Soft Pvt. Ltd.