Bulk Transaction API

Download data of all your successful transactions for a given date

Introduction

Bulk Transaction API is used to fetch transaction details which were performed on a particular date with pagination and authorization. Authorization has to be done using API key which can be generate via Merchant Dashboard.

Request Type - POST
Request Url - /api/v1/fetchtxn

Request Header

Header Name

Value

X-API-Key

xxx39ad7bc6f4xxxb1d9010d06485xxx

Request Parameter

Parameters

Optional (O)/Mandatory(M)

Validation

Allowed Value

txnDate

M

Date format yyyy-MM-dd

status

M

Status of transaction

success

pageNumber

O

Numeric

pageSize

O

Numeric

Maximum page size allowed is 500

Response Parameter

Parameter

Description

txnInitiatedDate

Date on which Transaction was initiated in yyyy-MM-dd HH:mm:ss format

txnSuccessDate

Date on which Transaction was successful in yyyy-MM-dd HH:mm:ss format

orderid

Unique transaction identifier for merchant

txnid

Zaakpay internal unique transaction ID

amount

Transaction amount in Rupees

paymentSource

Source from where transaction done like Net Banking, Debit Card, Credit Card

brand

Brand or card network eg: MASTERCARD

cardType

Type of Card used for transaction
eg: DEBIT/CREDIT

buyerName

As received with the request

buyerEmail

As received with the request

status

Status of transaction i.e Success or Failure

approvalCode

Numeric Code provided by bank

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 Zaakpay on all above response parameters

bankName

Issuing Bank name

cardNumber

Encrypted Card Number which is used in transaction

ipAddress

IP Address of the system from where transaction was initiated

refundDetail

Refund Details object with refundReferenceNumber, createdAt and amount

Sample Request

curl --location --request POST 'http://localhost:8080/api/v1/fetchtxn' \
--header 'checksum: 4b52cb6dfaafe30e0643d402c2f2c7a3b2107420ca722bdae8af029a20fcc150' \
--header 'X-API-Key: 13d61fb095f243089b6f1e00ad5e1df' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=7031070B2527EE9F4F28FE42B932F164' \
--data-raw '{
"txnDate" : "2020-06-18",
"status" : "success",
"pageNumber":1,
"pageSize":500
}'

Sample Response

{
  "success": true,
  "data": [
    {
      "txnInitiatedDate": "2020-06-18 11:06:21",
      "txnSuccessDate": "2020-06-18 11:06:21",
      "orderid": "ZPLive1592458553138",
      "txnid": "ZP5a8552818842c",
      "amount": 1.02,
      "paymentSource": "Card",
      "brand": "MASTERCARD",
      "cardType": "DEBIT",
      "buyerName": " ",
      "buyerEmail": null,
      "status": "Success",
      "approvalCode": 434221,
      "productDescription": "Zaakpay subscription fee",
      "productDescription1": "",
      "productDescription2": "",
      "productDescription3": "",
      "productDescription4": null,
      "bankName": "STATE BANK OF INDIA",
      "cardNumber": "559601xxxxxx8105",
      "ipAddress": "127.0.0.1",
      "refundDetail": [
        {
          "refundReferenceNumber": "REF5a8553524aeba",
          "createdAt": "2020-06-18 11:10:00",
          "amount": 1.02
        }
      ]
    },
    {
      "txnInitiatedDate": "2020-06-18 10:53:05",
      "txnSuccessDate": "2020-06-18 10:53:05",
      "orderid": "ZPLive1592500977149",
      "txnid": "ZP5a85f078523dd",
      "amount": 3.18,
      "paymentSource": "Net Banking",
      "brand": null,
      "cardType": null,
      "buyerName": "Abhshek Negi",
      "buyerEmail": null,
      "status": "Success",
      "approvalCode": 34567,
      "productDescription": "Zaakpay subscription fee",
      "productDescription1": "",
      "productDescription2": "",
      "productDescription3": "",
      "productDescription4": null,
      "bankName": "Kotak Bank",
      "cardNumber": null,
      "ipAddress": "127.0.0.1",
      "refundDetail": [
        {
          "refundReferenceNumber": "REF90d6518e13ec",
          "createdAt": "2020-06-18 11:04:17",
          "amount": 1
        }
      ]
    }
  ]
}
{
  "success": false,
  "message": {
    "code": "100",
    "text": "Validation Failed"
  }
}
{
  "success": true,
  "data": "No Transaction found"
}

📘

Note:-

  1. If page number is not provided in the request parameter then by default page number will be 1.
  2. If page size is not provided in the request parameter then by default page size will be 10.
  3. Maximum page size allowed is 500.
  4. Date format - yyyy-MM-dd
  5. This API will only return successful transactions for the date in the request. If there is any refund initiated for the transaction then details regarding refund will be present in the refund array.

Did this page help you?