Welcome to the Zaakpay developer hub!

You'll find comprehensive guides and documentation to help you start integrating Zaakpay Payment gateway as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides would be the best place to start.
Checkout "Discussions" forum for frequently asked questions or simply use the search option if you're unsure of where to look.
Api Endpoints provides the specification on our APIs with an option to explore the API

Guides    Discussions

Check Transaction Status API

API to check status of any transaction

Introduction

The purpose of this API is to enable websites to check the latest status of their transaction at
any time

Method Type: POST
Test Server: http://zaakstaging.zaakpay.com/checkTxn?v=5
Live Server: https://api.zaakpay.com/checkTxn?v=5

Request Parameters

Parameter

Optional O, Mandatory M

Validation

Allowed Values

merchant Identifier

M

alphanumeric

orderId

M

Transaction id for which you want to check the status

Your unique transaction identifier

mode

M

1 digit only, numeric

0

checksum

M

Checksum Calculated On All above request parameters

Response Parameters

Parameters

Description

merchantid

MobiKwik Payment Gateway’s unique identifier for your website

orderid

Your unique transaction identifier

responsecode

Numeric, max 3 digits example 100 for success

description

Numeric, max 3 digits example 100 for success

paymentmethod

Payment Method ID for Card and Net Banking transactions. For Card txns, payment Method ID starts with C and N for NetBanking.It is an alphanumeric value with max length 6.First letter is C or N, followed by 5 digits max.

cardhashid

Unique id for each card number used in transaction. For Net banking txns, value will be “NA”.

amount

Txn amount in paisa,Integer

paymentmode

mode of payment

txnid

MobiKwik Payment Gateway txn ID

timestamp

Time stamp of txn

status

Status of txn i.e Success or Failure

productdescription

As received with the request

product1description

As received with the request

product2description

As received with the request

product3description

As received with the request

product4description

As received with the request

checksum

Checksum calculated by MobiKwik Payment Gateway on all above response parameters

Sample Request

curl --location --request POST 'https://zaakstaging.zaakpay.com/checkTxn?v=5' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: JSESSIONID=A4C211B0FC1F713C69DD79521963AAD2' \
--data-urlencode 'data={"merchantIdentifier":"b19e8f103bce406cbd3476431b6b7973","mode":"0","orderDetail":{"orderId":"ZPLive1602500556069"}}' \
--data-urlencode 'checksum=e0a8a4080fc661dbd23119309d9a45817bd01cc9264b1fde9b26a1dac7e1da50'
<?xml version="1.0" encoding="utf-8"?>
<zaakpay_response>
    <response_element>
        <merchantid>b19e8f103bce406cbd3476431b6b7973</merchantid>
        <orderid>5ab197d8ab87c</orderid>
        <responsecode>400</responsecode>
        <description>Your Bank has declined this transaction, please Retry this payment with another pay method.</description>
        <paymentmethod>Not Found</paymentmethod>
        <cardhashid>NA</cardhashid>
        <amount>100</amount>
        <paymentmode>unknown</paymentmode>
        <txnid>ZP5ab197eb7a427</txnid>
        <timestamp>2020-07-23 16:11:11</timestamp>
        <status>Failure</status>
        <productdescription>Online Wallet</productdescription>
        <product1description>NA</product1description>
        <product2description>NA</product2description>
        <product3description>NA</product3description>
        <product4description>NA</product4description>
        <checksum>b1649f85eaee09dd03591e05012d7acad969929a7e10eca01ee6d8c137408157</checksum>
    </response_element>
</zaakpay_response>

Sample Response

{
    "success": true,
    "merchantIdentifier": "b19e8f103bce406cbd3476431b6b7973",
    "orders": [
        {
            "orderDetail": {
                "orderId": "ZPLive1602500556069",
                "txnId": "ZP5b1773d1f776b",
                "amount": "100",
                "productDescription": "Zaakpay subscription fee",
                "createDate": "2020-10-12 16:32:47",
                "product1Description": "NA",
                "product2Description": "NA",
                "product3Description": "NA",
                "product4Description": "NA"
            },
            "paymentInstrument": {
                "paymentMode": "Credit Card",
                "card": {
                    "cardToken": "4012 XXXX XXXX 1112",
                    "cardId": "25157d8564f730461489ea3102c393fd3bf13cfed94966f44815714d57170f4c~273",
                    "cardScheme": "Visa",
                    "first4": "4012",
                    "last4": "1112",
                    "bank": "HDFC",
                    "cardHashId": "CH373",
                    "paymentMethod": "401200"
                }
            },
            "responseCode": "230",
            "responseDescription": "Transaction Refund Initiated",
            "txnDate": "2020-10-12 16:44:43",
            "txnStatus": "3",
            "userAccountDebited": true
        }
    ],
    "version": "5"
}

CheckAPItxnStatus

Parameters

Description

0

Success

1

Failure

2

ending

3

Refund

4

Partial Refund

5

Chargeback Reverted

6

Chargeback

7

Partial Chargeback Reverted

8

Partial Chargeback

Checksum For Request

Create a list of data parameter which you’re passing to the API. Parameters used in checksum calculation are (in no particular order):

  • merchantIdentifier
  • mode
  • orderId

The data parameter is taken for checksum calculation, surrounded with single quotes.

Calculate the checksum using the HMAC SHA-256 algorithm using the data parameter and your generated secret key.

The resulting checksum calculated should be posted to the Zaakpay API along with other data.
For example: Let’s suppose we need to post the following data to the API.We calculate "checksum" with the parameters mentioned below:

  • merchantIdentifier-b19e8f103bce406cbd
  • mode -0
  • orderId -ZPK12345

Now, we have to create a concatenated string of all the values, in the order in which they’ll be sent to the API, with single quotes around each item. The string therefore will be:

Input Parameter string:' { "merchantIdentifier":"b19e8f103bce406cbd", "mode":"0", "orderDetail": { "orderId":"ZPK12345" } } '

Secret Key (staging): 0678056d96914a8583fb518caf42828a

Checksum: 625e20fbf1269c721d29e4d2650cd87a58e1c722e8b410bd5e6e3b88cff7d2d5

Updated about 19 hours ago


Check Transaction Status API


API to check status of any transaction

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.