PayZippy Java SDK

Structure of SDK

• com.payzippy.sdk

     ChargingRequest.java
     ChargignRequestBuilder.java
     ChargingResponse.java
     Constants.java
     QueryRequest.java
     QueryRequestBuilder.java
     RefundRequest.java
     RefundRequestBuilder.java
     RefundResponse.java
  

• com.payzippy.sdk.utils

    HashUtils.java
    RequestUtil.java
    ValidityCheck.java
    WebClient.java
  

API Usage

• ChargingRequest

To create a ChargingRequest first get the instance of ChargingRequestBuilder using ChargingRequest.getBuilder() then set the parameters using setters - builder.setMerchantId("merchant_id") or if setter is not present for some parameter use putParams - builder.putParams(parameterKey,parameterValue). After setting the parameters use build method on ChargingRequestBuilder to get instance of ChargingRequest(build will create hash for you and validate your parameters). Once you have ChargingRequest you can call getUrl on it to get the request Url.

Example :

ChargingRequest chargingRequest = (ChargingRequest.getBuilder()).setMerchantId(MERCHANT_ID)
.setMerchantKeyId(MERCHANT_KEY_ID)
.setMerchantTransactionId(request.getParameter("merchant_transaction_id"))
.setBuyerEmailId(request.getParameter("buyer_email_address"))
.setTransactionAmount(request.getParameter("transaction_amount"))
.setPaymentMethod(request.getParameter("payment_method"))
.setCurrency(request.getParameter("currency"))
.setUiMode(request.getParameter("ui_mode")).setHashMethod("sha256")
.setTransactionType(request.getParameter("transaction_type"))
.putParams("callback_url", "http://localhost:8080/payzippy-api-test/chargingResp.jsp")
.build(SECRET_KEY);

String Url_to_hit=chargingRequest.getUrl(CHARGING_BASE_URL);

• ChargingResponse

To create ChargingResponse object pass the response parameter map to its constructor.

ChargingResponse chargingResponse=new ChargingResponse(requestParams);

• QueryRequest

Building QueryRequest is very similar to ChargingRequest. Get the builder, set the parameters and then use build method to create QueryRequest instance. Once you have QueryRequest instance you can call getUrl on it to get the request Url. Make the call to the url yourself or use our WebClient to do the same. See utils/WebClient.

Example :

QueryRequest queryRequest = QueryRequest.getBuilder()).setMerchantId(MERCHANT_ID)
.setMerchantKeyId(MERCHANT_KEY_ID)
.setHashMethod("SHA256")
.setMerchantTransactionId("merchantTransactionId_to_query")
.build(SECRET_KEY);

String Url_to_hit=queryRequest.getUrl(QUERY_BASE_URL);

• QueryResponse

To create QueryResponse pass the response string (which will be json) to the constructor.

QueryResponse queryResponse = new QueryResponse(json_response_string);

• RefundRequest

Similar to QueryRequest

Example :

RefundRequest refundRequest = (RefundRequest.getBuilder()).setHashMethod("SHA256")
.setMerchantId(MERCHANT_ID).setMerchantKeyId(MERCHANT_KEY_ID)
.setPayzippySaleTransactionId(payzippy_sale_transaction_id).setRefundAmount(refund_amount)
.build(SECRET_KEY);

String Url_to_hit=refundRequest.getUrl(REFUND_BASE_URL)

• RefundResponse

Similar to QueryResponse.

• Utils/WebClient

In order to hit url for query and refund case(as these are server to server calls) you can use WebClient from utils package.

Example :

QueryResponse queryResponse = new QueryResponse(WebClient.INSTANCE.doQuery(queryRequest.getRequestParams(), QUERY_BASE_URL));
RefundResponse refundResponse = new RefundResponse(WebClient.INSTANCE.doRefund(refundRequest.getRequestParams(), REFUND_BASE_URL));

For sample integration : Java SDK Examples