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 | 7="Captured", 8="Canceled", 14="Refunded", |
updateReason | M | Description of the reason for update. min5, max30 | Examples: you want to |
Amount | O(during Full- Refund), | Amount Paid.Amount | example Re1 is 100 paisa, |
Checksum | M | Checksum Calculated on all | |
merchantRefId | O | Unique refund |
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 4 months ago