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

Refund Transaction API

Introduction

The purpose of this API is to refund the transaction.

Test Server:

https://sandbox.zaakpay.com/updateTxn

Live Server:

https://api.zaakpay.com/updateTxn

Request Parameters

Parameter

Optional O/Mandatory M

Validation

Allowed Values

merchantIdentifier

M

alphanumeric

MobiKwik Payment Gateway unique merchant identifier for your website

orderId

M

Max 20 alphanumeric, must be unique per website, we do not accept duplicate

Your unique transaction identifier

Mode

M

1 digit only, numeric

0

updateDesired

M

Numeric max 1 digit,values
predefined by MobiKwik Payment Gateway

7="Captured", 8="Canceled", 14="Refunded",
22=”Partial Refund”.
Note:If you request a state update to "Refunded" we will issue the full amount refund to the user.

updateReason

M

Description of the reason for update. min5, max30
alphanumeric characters. no
special characters or ashes

Examples: you want to
cancel a transaction, your user wants a refund,you want to settle a transaction

Amount

O(during Full- Refund),
M(for Partial-Refund)

Amount Paid.Amount
which needs to be refunded in case of partial refunds.
In case of full refund this can be omitted.

example Re1 is 100 paisa,
Rs 777.50 is 77750 paisa. Pass this parameter if the merchant wants a partial refund.

Checksum

M

Checksum Calculated on all
above request parameters

merchantRefId

O

Unique refund
transaction id sent by
merchant

Response Parameters

Parameters

Description

Merchantid

MobiKwik Payment Gateway’s unique identifier for your website

Ordered

Your unique transaction identifier

Responsecode

Numeric, max 3 digits example 100 for success

Description

Alphanumeric max 30 description of the response

Checksum

Checksum calculated by MobiKwik Payment Gateway on all above response parameters

merchantRefId

Unique refund transaction id sent by merchant

Sample Request

curl --location --request POST 'https://zaakstaging.zaakpay.com/updateTxn' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={"merchantIdentifier":"b19e8f103bce406cbd3476431b6b7973","orderDetail":{"orderId":"ZPLive1602500556069","amount":"100","productDescription":"test product"},"mode":"0","updateDesired":"14","updateReason":"test reason","merchantRefId":"TESTING3"}' \
--data-urlencode 'checksum=35c8677663806211a9c170d5f9263adc22934507b84081918df4a7930b5f794b'
<?xml version="1.0" encoding="utf-8"?>
<zaakpay_response>
    <response_element>
        <merchantid>b19e8f103bce406cbd3476431b6b7973</merchantid>
        <orderid>ZPLive1595916746770</orderid>
        <responsecode>200</responsecode>
        <description>Transaction already refunded.</description>
        <checksum>caa5c4f71677042ac25e4d6a73085128ef16a3c8813628faa19944d3acf586ed</checksum>
    </response_element>
</zaakpay_response>

Sample Response

{
    "merchantIdentifier": "b19e8f103bce406cbd3476431b6b7973",
    "orderDetail": {
        "orderId": "ZPLive1602500556069"
    },
    "responseCode": "230",
    "responseDescription": "Transaction Refund Initiated",
    "merchantRefId": "TESTING3"
}

Checksum For Request

Form the concatenated string using the request parameters i.e merchantIdentifier, orderId, mode, updateDesired, updateReason & amount in the same order in which they are posted to MobiKwik Payment Gateway's server.

Input Parameter string :
'b19e8f103bce406cbd3476431b6b7973''99998''0''8''you want to cancel transaction''100'

Secret Key (staging) : 0678056d96914a8583fb518caf42828a

Checksum: 9e67318db8ee257532d134354d185d9ea15f0408d413e97ce7fd1e2b973ed2e6

Checksum For Response

Form the concatenated string using all the response parameters i.e merchantid, orderid, responsecode, description.

Input Parameter string:
'b19e8f103bce406cbd3476431b6b7973''99802312''190''Order Id either not Processed or Rejected'

Secret Key (staging): 0678056d96914a8583fb518caf42828a

Checksum: a1da918361410088071ad5d6f12f57dfbdb3261f70eedec743f86db4e75db33f

📘

NOTE:

Only 3 kinds of updates are possible using Update API:

  • Authorized to Cancel
  • Authorized to Capture
  • Capture to Refund Before Payout Initiated
  • Capture to Partial Refund Before Payout Initiated
  • Payout Initiated to RefundInitiated
  • Payout Initiated to Partial RefundInitiated
  • Payout Completed to RefundInitiated
  • Payout Completed to Partial RefundInitiated

Updated 9 days ago


Refund Transaction API


Suggested Edits are limited on API Reference Pages

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