Skip to main content

Online Payment SDK - Java

Overview​

This guide is written for application developers who want to integrate the PayBy payment solution.

SDK Download​

https://github.com/PayBy/PayBy-java

Prerequisites​

JDK Requirements​

JDK versions ≥ 1.8 are required.

Execute the validation command on the command line: java -version

Expected output:

java version "1.8.0_191"
Java(TM) SE Runtime Environment (build 1.8.0_191-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.191-b12, mixed mode)

Maven Requirements​

Maven versions ≥ 3.0 are required.

Execute the validation command on the command line: mvn –version

Expected output:

Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-25T02:41:47+08:00)
Maven home: D:\apache-maven-3.6.0\bin\..
Java version: 1.8.0_191, vendor: Oracle Corporation, runtime: C:\Program Files\Java\jdk1.8.0_191\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Maven Repository Setup​

Choose between importing a local library or remote library according to your development environment.

Download Dependencies​

Clone the repository:

git clone https://github.com/PayBy/PayBy-java.git

Navigate to the download directory: PayBy-java/dependency

Install Local Repository​

Move to the PayBy-java/dependency subdirectory and execute:

mvn install:install-file -Dfile=payby-openapi-1.0.17.jar -DpomFile=payby-openapi-1.0.17.pom
mvn install:install-file -Dfile=payby-sdk-1.3.21.jar -DpomFile=payby-sdk-1.3.21.pom

Deploy Remote Repository​

mvn deploy:deploy-file -Durl=company maven repository url path -DrepositoryId=repository name -Dfile=payby-openapi-1.0.17.jar -DpomFile=payby-openapi-1.0.17.pom
mvn deploy:deploy-file -Durl=company maven repository url path -DrepositoryId=repository name -Dfile=payby-sdk-1.3.21.jar -DpomFile=payby-sdk-1.3.21.pom

Project Maven Dependency​

Add the following dependency to your project:

<dependency>
    <groupId>com.payby.gateway</groupId>
    <artifactId>payby-sdk</artifactId>
    <version>1.3.21</version>
</dependency>

SDK Cascade Dependencies​

To view the specific dependency tree, execute at the project root:

mvn dependency:tree

Expected results:

com.payby.gateway:payby-sdk:jar:1.3.21
 +- com.payby.gateway:payby-openapi:jar:1.0.17:compile
 +- commons-io:commons-io:jar:2.4:compile
 +- commons-codec:commons-codec:jar:1.13:compile
 +- org.projectlombok:lombok:jar:1.18.8:provided
 +- org.bouncycastle:bcprov-jdk15on:jar:1.64:compile
 +- org.bouncycastle:bcpkix-jdk15on:jar:1.64:compile
 +- com.alibaba:fastjson:jar:1.2.58:compile
 +- org.slf4j:slf4j-api:jar:1.7.26:compile
 +- org.apache.commons:commons-lang3:jar:3.9:compile
 +- com.squareup.okhttp3:okhttp:jar:3.11.0:compile
 |  \- com.squareup.okio:okio:jar:1.14.0:compile
 +- org.apache.httpcomponents:httpclient:jar:4.5.6:compile
 +- org.apache.httpcomponents:httpcore:jar:4.4.10:compile
 |  \- commons-logging:commons-logging:jar:1.2:compile
 +- com.madgag.spongycastle:bcpkix-jdk15on:jar:1.58.0.0:compile
 |  +- com.madgag.spongycastle:core:jar:1.58.0.0:compile
 |  \- com.madgag.spongycastle:prov:jar:1.58.0.0:compile
 |     \- junit:junit:jar:4.12:compile
 |        \- org.hamcrest:hamcrest-core:jar:1.3:compile
 +- ch.qos.logback:logback-classic:jar:1.2.3:compile
 |  \- ch.qos.logback:logback-core:jar:1.2.3:compile
 \- com.squareup.okhttp3:logging-interceptor:jar:3.11.0:compile

Bouncycastle Version Notes​

Due to multiple versions of the Bouncycastle Library, we use the following versions:

<dependency>
    <groupId>org.bouncycastle</groupId>
    <artifactId>bcprov-jdk15on</artifactId>
    <version>1.64</version>
    <scope>compile</scope>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.bouncycastle</groupId>
    <artifactId>bcpkix-jdk15on</artifactId>
    <version>1.64</version>
    <scope>compile</scope>
    <optional>true</optional>
</dependency>

Users can switch to other equivalent Maven library dependencies according to their specific requirements.

Use mvn dependency:tree to view dependencies. If your host project uses BC dependencies and conflicts arise, consider using Maven's exclude method to remove the old version.

Digital Signature​

Preparing Keys​

Recommended operations for private key generation:

### Generate private key
# PayBy_key.pem Private key file name
# 2048 Private key size, at least 2048
openssl genrsa -out PayBy_key.pem 2048

### Export public key
# PayBy_key.pem Private key generated in the previous step # PayBy_key_public.pem Exported public key name
openssl rsa -in PayBy_key.pem -out PayBy_key_public.pem -pubout

### Export private key for Java
# PayBy_key.pem Private key generated in the 1st step
# PayBy_key_Private.pem
openssl pkcs8 -in PayBy_key.pem -topk8 -nocrypt -out PayBy_key_private.pem

Signature Algorithm​

  1. Uses SHA256WithRSA for signature algorithm. The merchant issues the private key.
  2. Original signature rule: Requesting the original content of the body.
  3. Uses UTF-8 to encode the original content.
  4. Uses Base64 to encode the resulting signature.

Encryption Algorithm​

  1. The encryption algorithm uses RSA public-key encryption, and PayBy issues the public key.
  2. The encrypted field should not be too large, generally more than 200 bytes.
  3. Encryption rules: RSA (encrypted original encryption).
  4. UTF-8 encoding is used for plaintext.
  5. The encryption result is encoded with Base64.

Verify Signature Algorithm​

  1. Uses SHA256WithRSA to verify the signature algorithm. The RSA public key is downloaded from the PayBy merchant console.
  2. Uses Base64 to decode the signature, i.e., decoded_sign_data.
  3. Uses UTF-8 to decode the original content, i.e. decoded_content_data.
  4. Verify signature using parameters as listed (rsa_public_key, decoded_sign_data, decoded_content_data).

API Description​

Function Descriptions​

1. PayByClient​

public static PayByClient getPayByClient()
    throws InvalidKeySpecException, SignatureException, InvalidKeyException, IOException, URISyntaxException {
    ApiConfig apiConfig = new ApiConfig();
    // setting interface url
    apiConfig.setDomain("https://uat.test2pay.com/sgs/api");

    // setting pkcs8 privateKey path
    String merchantPrivateKey = new String(Files.readAllBytes(
        Paths.get(PayByDemo.class.getClassLoader().getResource("merchant_demo_private.pem").toURI())));

    // setting publicKey path
    String payByPubKey = new String(Files
        .readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));

    apiConfig.setCert(new KeyCert(merchantPrivateKey, payByPubKey));

    // setting http header params
    apiConfig.setFixHeaders(getFixHeaders());

    HttpLoggingInterceptor logInterceptor = new HttpLoggingInterceptor();
    logInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

    ClientConfig config =
        new OkHttpClientConfig.Builder().interceptor(new OkHttpClientConfig.SignInterceptor(apiConfig.getCert()))
            .interceptor(logInterceptor).apiConfig(apiConfig).build();

    PayByClient client = new PayByClient(config);
    return client;

}

public static List<Pair<String, String>> getFixHeaders() {
    List<Pair<String, String>> pairs = new ArrayList<>();
    // setting Partner-Id
    pairs.add(new ImmutablePair<>("partner-id", "200000042607"));
    // setting group-name Optional
    pairs.add(new ImmutablePair<>("group-name", ""));
    // setting branch-name Optional
    pairs.add(new ImmutablePair<>("branch-name", ""));
    return pairs;
}

2. Order Creation​

    PayByClient client = getPayByClient();

    PlaceOrderRequest placeOrderRequest = new PlaceOrderRequest();
    // Merchant order number Required
    placeOrderRequest.setMerchantOrderNo("M202005120001");
    // Product name Required
    placeOrderRequest.setSubject("ipad");
    // Order totalAmount Required
    ExternalMoney totalAmount = new ExternalMoney(new BigDecimal("0.1"), "AED");
    placeOrderRequest.setTotalAmount(totalAmount);
    // Payment scenario code Required
    placeOrderRequest.setPaySceneCode("DYNQR");
    // Notification URL Optional
    placeOrderRequest.setNotifyUrl("http://yoursite.com/api/notification");
    // Accessory content Optional
    AccessoryContent accessoryContent = new AccessoryContent();
    // Amount detail Optional
    AmountDetail amountDetail = new AmountDetail();
    // Vat amount Optional
    amountDetail.setVatAmount(new ExternalMoney(new BigDecimal("0.1"), "AED"));
    // Goods detail Optional
    GoodsDetail goodsDetail = new GoodsDetail();
    goodsDetail.setBody("gifts");
    goodsDetail.setGoodsName("candy flower");
    goodsDetail.setGoodsId("GI1005");
    // Terminal detail Optional
    TerminalDetail terminalDetail = new TerminalDetail();
    terminalDetail.setMerchantName("candy home");
    accessoryContent.setAmountDetail(amountDetail);
    accessoryContent.setGoodsDetail(goodsDetail);
    accessoryContent.setTerminalDetail(terminalDetail);
    placeOrderRequest.setAccessoryContent(accessoryContent);
    SgsRequestWrap<PlaceOrderRequest> wrap = SgsRequestWrap.wrap(placeOrderRequest);

    System.out.println("placeOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<PlaceOrderResponse> responseWrap = client.execute(SgsApi.PLACE_ACQUIRE_ORDER, wrap);
    System.out.println("placeOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    PlaceOrderResponse body = responseWrap.getBody();
    System.out.println("placeOrder body=>" + JSON.toJSONString(body));

3. Order Cancellation​

By Merchant Order No

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Merchant order number Required
    orderIndexRequest.setMerchantOrderNo("M202005120001");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("cancelOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetPlaceOrderResponse> responseWrap = client.execute(SgsApi.CANCEL_ACQUIRE_ORDER, wrap);
    System.out.println("cancelOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetPlaceOrderResponse body = responseWrap.getBody();
    System.out.println("cancelOrder body=>" + JSON.toJSONString(body));

By Order No

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Order number Required
    orderIndexRequest.setOrderNo("190000000001");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("cancelOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetPlaceOrderResponse> responseWrap = client.execute(SgsApi.CANCEL_ACQUIRE_ORDER, wrap);
    System.out.println("cancelOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetPlaceOrderResponse body = responseWrap.getBody();
    System.out.println("cancelOrder body=>" + JSON.toJSONString(body));

4. Order Query​

By Merchant Order No

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Merchant order number Required
    orderIndexRequest.setMerchantOrderNo("M202005120001");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetPlaceOrderResponse> responseWrap = client.execute(SgsApi.GET_ACQUIRE_ORDER, wrap);
    System.out.println("getOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetPlaceOrderResponse body = responseWrap.getBody();
    System.out.println("getOrder body=>" + JSON.toJSONString(body));

By Order No

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    //order number Required
    orderIndexRequest.setOrderNo("13000000023101");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetPlaceOrderResponse> responseWrap = client.execute(SgsApi.GET_ACQUIRE_ORDER, wrap);
    System.out.println("getOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetPlaceOrderResponse body = responseWrap.getBody();
    System.out.println("getOrder body=>" + JSON.toJSONString(body));

5. Order Refund​

By Origin Merchant Order No

    PayByClient client = getPayByClient();

    PlaceRefundOrderRequest placeRefundOrderRequest = new PlaceRefundOrderRequest();
    // Refund refund amount Required
    placeRefundOrderRequest.setAmount(new ExternalMoney(new BigDecimal("0.1"), "AED"));
    // Merchant order number Required
    placeRefundOrderRequest.setRefundMerchantOrderNo("M80000000001");
    // Original merchant order number
    placeRefundOrderRequest.setOriginMerchantOrderNo("M220000000001");
    // Refund operator name Optional
    placeRefundOrderRequest.setOperatorName("JACKMA");
    // Refund reason name Optional
    placeRefundOrderRequest.setReason("reason123");
    // Notification URL Optional
    placeRefundOrderRequest.setNotifyUrl("http://yoursite.com/api/notification");

    SgsRequestWrap<PlaceRefundOrderRequest> wrap = SgsRequestWrap.wrap(placeRefundOrderRequest);
    System.out.println("refundOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<PlaceRefundOrderResponse> responseWrap = client.execute(SgsApi.PLACE_REFUND_ORDER, wrap);
    System.out.println("refundOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    PlaceRefundOrderResponse body = responseWrap.getBody();
    System.out.println("refundOrder body=>" + JSON.toJSONString(body));

By Origin Order No

    PayByClient client = getPayByClient();

    PlaceRefundOrderRequest placeRefundOrderRequest = new PlaceRefundOrderRequest();
    // Refund refund amount Required
    placeRefundOrderRequest.setAmount(new ExternalMoney(new BigDecimal("0.1"), "AED"));
    // Merchant order number Required
    placeRefundOrderRequest.setRefundMerchantOrderNo("M80000000001");
    // Original order number
    placeRefundOrderRequest.setOriginOrderNo("19000000001");
    // Refund operator name Optional
    placeRefundOrderRequest.setOperatorName("JACKMA");
    // Refund reason name Optional
    placeRefundOrderRequest.setReason("reason123");
    // Notification URL Optional
    placeRefundOrderRequest.setNotifyUrl("http://yoursite.com/api/notification");

    SgsRequestWrap<PlaceRefundOrderRequest> wrap = SgsRequestWrap.wrap(placeRefundOrderRequest);
    System.out.println("refundOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<PlaceRefundOrderResponse> responseWrap = client.execute(SgsApi.PLACE_REFUND_ORDER, wrap);
    System.out.println("refundOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    PlaceRefundOrderResponse body = responseWrap.getBody();
    System.out.println("refundOrder body=>" + JSON.toJSONString(body));

6. Order Refund Query​

By Merchant Order No

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Merchant order number Required
    orderIndexRequest.setMerchantOrderNo("M80000000001");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getRefundOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetRefundOrderResponse> responseWrap = client.execute(SgsApi.GET_REFUND_ORDER, wrap);
    System.out.println("getRefundOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetRefundOrderResponse body = responseWrap.getBody();
    System.out.println("getRefundOrder body=>" + JSON.toJSONString(body));

By Order No

    PayByClient client = getPayByClient();


    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // order number Required
    orderIndexRequest.setOrderNo("1900000000001");
    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getRefundOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetRefundOrderResponse> responseWrap = client.execute(SgsApi.GET_REFUND_ORDER, wrap);
    System.out.println("getRefundOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetRefundOrderResponse body = responseWrap.getBody();
    System.out.println("getRefundOrder body=>" + JSON.toJSONString(body));

7. Transfer​

    PayByClient client = getPayByClient();

    PlaceTransferOrderRequest placeTransferOrderRequest = new PlaceTransferOrderRequest();

    // Merchant order number Required
    placeTransferOrderRequest.setMerchantOrderNo("M320000000001");
    // Beneficiary Identity Type Required
    placeTransferOrderRequest.setBeneficiaryIdentityType("PHONE_NO");
    String payByPubKey = new String(Files
        .readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));
    // Beneficiary Identity
    placeTransferOrderRequest
        .setBeneficiaryIdentity(RsaUtil.encrypt("971-585812341", Charset.forName("UTF-8"), payByPubKey, 2048));
    placeTransferOrderRequest
        .setBeneficiaryFullName(RsaUtil.encrypt("JACKMA", Charset.forName("UTF-8"), payByPubKey, 2048));

    // Transfer order amount Required
    placeTransferOrderRequest.setAmount(new ExternalMoney(new BigDecimal("0.1"), "AED"));

    // memo Required
    placeTransferOrderRequest.setMemo("Bonus");
    // Notification URL Optional
    placeTransferOrderRequest.setNotifyUrl("http://yoursite.com/api/notification");

    SgsRequestWrap<PlaceTransferOrderRequest> wrap = SgsRequestWrap.wrap(placeTransferOrderRequest);
    System.out.println("transfer request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<PlaceTransferOrderResponse> responseWrap = client.execute(SgsApi.PLACE_TRANSFER_ORDER, wrap);
    System.out.println("transfer response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    PlaceTransferOrderResponse body = responseWrap.getBody();
    System.out.println("transfer body=>" + JSON.toJSONString(body));

8. Transfer Query​

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Merchant order number Required
    orderIndexRequest.setMerchantOrderNo("M320000000001");

    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getTransferOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetTransferOrderResponse> responseWrap = client.execute(SgsApi.GET_TRANSFER_ORDER, wrap);
    System.out.println("getTransferOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetTransferOrderResponse body = responseWrap.getBody();
    System.out.println("getTransferOrder body=>" + JSON.toJSONString(body));

9. Transfer To Bank​

    PayByClient client = getPayByClient();

    PlaceTransferToBankOrderRequest placeTransferToBankOrderRequest = new PlaceTransferToBankOrderRequest();
    // Merchant order number Required
    placeTransferToBankOrderRequest.setMerchantOrderNo("M320000000002");
    String payByPubKey = new String(Files
        .readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));
    // Holder Name Required
    placeTransferToBankOrderRequest
        .setHolderName(RsaUtil.encrypt("JACKMA", Charset.forName("UTF-8"), payByPubKey, 2048));
    // Iban Required
    placeTransferToBankOrderRequest
        .setIban(RsaUtil.encrypt("5000312313111", Charset.forName("UTF-8"), payByPubKey, 2048));
    // SwiftCode Optional
    placeTransferToBankOrderRequest.setSwiftCode("ARABAEADDER");
    // Transfer order amount Required
    placeTransferToBankOrderRequest.setAmount(new ExternalMoney(new BigDecimal("0.1"), "AED"));
    // memo Required
    placeTransferToBankOrderRequest.setMemo("Bonus");
    // Notification URL Optional
    placeTransferToBankOrderRequest.setNotifyUrl("http://yoursite.com/api/notification");

    SgsRequestWrap<PlaceTransferToBankOrderRequest> wrap = SgsRequestWrap.wrap(placeTransferToBankOrderRequest);
    System.out.println("transfer2bank request=>" + JSON.toJSONString(wrap));
    SgsResponseWrap<PlaceTransferToBankOrderResponse> responseWrap =
        client.execute(SgsApi.PLACE_TRANSFER_TO_BANK_ORDER, wrap);
    System.out.println("transfer2bank response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    PlaceTransferToBankOrderResponse body = responseWrap.getBody();
    System.out.println("transfer2bank body=>" + JSON.toJSONString(body));

10. Transfer To Bank Query​

    PayByClient client = getPayByClient();

    OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
    // Merchant order number Required
    orderIndexRequest.setMerchantOrderNo("M320000000002");

    SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
    System.out.println("getTransferToBankOrder request=>" + JSON.toJSONString(wrap));

    SgsResponseWrap<GetTransferToBankOrderResponse> responseWrap =
        client.execute(SgsApi.GET_TRANSFER_TO_BANK_ORDER, wrap);
    System.out.println("getTransferToBankOrder response=>" + JSON.toJSONString(responseWrap));
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    GetTransferToBankOrderResponse body = responseWrap.getBody();
    System.out.println("getTransferToBankOrder body=>" + JSON.toJSONString(body));

11. Order Revoke​

PayByClient client = getPayByClient();

        OrderIndexRequest orderIndexRequest = new OrderIndexRequest();
        // Merchant order number Required
        orderIndexRequest.setMerchantOrderNo("M320000000002");
        SgsRequestWrap<OrderIndexRequest> wrap = SgsRequestWrap.wrap(orderIndexRequest);
        System.out.println("revokeOrder request=>" + JSON.toJSONString(wrap));

        SgsResponseWrap<GetPlaceOrderResponse> responseWrap = client.execute(SgsApi.REVOKE_ACQUIRE_ORDER, wrap);
        System.out.println("revokeOrder response=>" + JSON.toJSONString(responseWrap));
        Assert.assertTrue(SgsApi.checkResponse(responseWrap));
        GetPlaceOrderResponse body = responseWrap.getBody();
        System.out.println("revokeOrder body=>" + JSON.toJSONString(body));

12. Protocol Apply​

 PayByClient client = getPayByClient();

        ApplyProtocolRequest applyProtocolRequest = new ApplyProtocolRequest();
        // Merchant order number Required
        applyProtocolRequest.setMerchantOrderNo("M320000000002");
        // langType Optional
        applyProtocolRequest.setLangType(ProtocolLangType.EN);
        // expiredTime Optional
        applyProtocolRequest        .setExpiredTime(Date.from(LocalDateTime.now().plusHours(1).atZone(ZoneId.systemDefault()).toInstant()));

        String payByPubKey = new String(Files
            .readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));
        // signerMerchantId Required
        applyProtocolRequest
            .setSignerMerchantId(RsaUtil.encrypt("200000001222", Charset.forName("UTF-8"), payByPubKey, 2048));
        // protocolSceneCode Required
        applyProtocolRequest.setProtocolSceneCode("120");
        // Notification URL Optional
        applyProtocolRequest.setNotifyUrl("http://yoursite.com/api/notification");
        // protocolSceneParams Required
        Map<String, String> protocolSceneParams = new HashMap<String, String>();
        protocolSceneParams.put("iapDeviceId", "");
        protocolSceneParams.put("appId", "");
        applyProtocolRequest.setProtocolSceneParams(protocolSceneParams);

        SgsRequestWrap<ApplyProtocolRequest> wrap = SgsRequestWrap.wrap(applyProtocolRequest);
        System.out.println("applyProtocol request=>" + JSON.toJSONString(wrap));
        SgsResponseWrap<ApplyProtocolResponse> responseWrap = client.execute(SgsApi.APPLY_PROTOCOL, wrap);
        System.out.println("applyProtocol response=>" + JSON.toJSONString(responseWrap));
        Assert.assertTrue(SgsApi.checkResponse(responseWrap));
        ApplyProtocolResponse body = responseWrap.getBody();
        System.out.println("applyProtocol body=>" + JSON.toJSONString(body));

13. Protocol Query​

 PayByClient client = getPayByClient();


        GetProtocolRequest getProtocolRequest = new GetProtocolRequest();
        // Merchant order number Required
        getProtocolRequest.setMerchantOrderNo("M320000000002");

        SgsRequestWrap<GetProtocolRequest> wrap = SgsRequestWrap.wrap(getProtocolRequest);
        System.out.println("getProtocol request=>" + JSON.toJSONString(wrap));

        SgsResponseWrap<GetProtocolResponse> responseWrap = client.execute(SgsApi.GET_PROTOCOL, wrap);
        System.out.println("getProtocol response=>" + JSON.toJSONString(responseWrap));
        Assert.assertTrue(SgsApi.checkResponse(responseWrap));
        GetProtocolResponse body = responseWrap.getBody();
        System.out.println("getProtocol body=>" + JSON.toJSONString(body));

14. Result Notification​

Verify signature

    // setting payby publicKey path
    String payByPubKey = new String(Files.readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));
    String plain =
        "{\"notify_time\":\"20200428133706\",\"acquireOrder\":{\"product\":\"Basic Payment Gateway\",\"orderNo\":\"911588066370006619\",\"paySceneCode\":\"DYNQR\",\"subject\":\"123456\",\"accessoryContent\":{\"amountDetail\":{\"vatAmount\":{\"amount\":0.10,\"currency\":\"AED\"}},\"terminalDetail\":{\"merchantName\":\"binge test merchant\"},\"goodsDetail\":{\"goodsId\":\"GI1005\",\"body\":\"Gifts\",\"goodsName\":\"candy flower\"}},\"merchantOrderNo\":\"eaa16681-070b-4ae6-9b13-809b0db6eb89\",\"expiredTime\":1588073568745,\"requestTime\":1588066368745,\"totalAmount\":{\"amount\":0.10,\"currency\":\"AED\"},\"payeeMid\":\"200000042607\",\"notifyUrl\":\"http://yoursite.com/api/notification\",\"paymentInfo\":{\"payChannel\":\"BALANCE\",\"paidTime\":1588066471000,\"payeeFeeAmount\":{\"amount\":0.01,\"currency\":\"AED\"},\"payerFeeAmount\":{\"amount\":0.00,\"currency\":\"AED\"},\"paidAmount\":{\"amount\":0.10,\"currency\":\"AED\"},\"payerMid\":\"100000001104\"},\"status\":\"PAID_SUCCESS\"},\"_input_charset\":\"UTF-8\",\"notify_timestamp\":1588066626060,\"notify_id\":\"202004280007581901\"}";
    String sign =
        "dPVyhhidZioH00QCVglgDfXNcDXHuMXmtzYF4WCEvnvmL3nCyqP5r9DmQ2bQYOf30tLEpqx1vmJpcT85f8voual7+sKPAehGRbyL9m30BF1KHwOFOhZSnOsBO8NQDJ1WMkG34mRmndfKRWpzi6RzWwfS/twJRXTt7maY2yPt93xhqeb2JbG2hktDFx8tnk3oxXil3oZLFq75X2Gbpd1SkrsnvxTLq5Bo98i4K3Kl4jWySU/vu8nX0M2JPWF6uC3OlOMq32Wo3mDPqM0DzH9t9WBwz2X6MQVnc/aFA5GfJbMKMYFFYwCh9CPtaWbrGmAFXAC9u/sz8bt3IAyiAGdd4w==";

    // assert verify sign
    Assert.assertTrue(RsaUtil.verifySign(plain, Charset.forName("UTF-8"), sign, payByPubKey));

    GetPlaceOrderResponse callbackOrder = JSON.parseObject(plain, new TypeReference<GetPlaceOrderResponse>() {});

    System.out.println("acquireOrder callback body=>" + callbackOrder);

Servlet receives messages

 @Override
 protected void  doPost(HttpServletRequest req, HttpServletResponse httpResponse) throws ServletException, IOException {

    String sign = req.getHeader("sign");

    String body = IOUtils.toString(req.getInputStream(), "UTF-8");

    // setting payby publicKey path
    String payByPubKey = new String(Files.readAllBytes(Paths.get(PayByDemo.class.getClassLoader().getResource("payby_public_key.pem").toURI())));

    // assert verify sign
    Assert.assertTrue(RsaUtil.verifySign(plain, Charset.forName("UTF-8"), sign, payByPubKey));

    //TODO Business logic
    GetPlaceOrderResponse callbackOrder = JSON.parseObject(plain, new TypeReference<GetPlaceOrderResponse>() {});

    System.out.println("acquireOrder callback body=>" + callbackOrder);

    httpResponse.setContentType("application/json;charset=UTF-8");

    httpResponse.getOutputStream().write("SUCCESS".getBytes("UTF-8"));

    httpResponse.flushBuffer();

  }

15. Download Statement​

Order Statement

    GetStatementRequest req = new GetStatementRequest();
    // setting statementDate
    req.setStatementDate("20200605");
    PayByClient client = getPayByClient();
    SgsRequestWrap<GetStatementRequest> wrap = SgsRequestWrap.wrap(req);
    String statementFilePath = "d:\\payby_statement_file";
    File statementFileDir = new File(statementFilePath);
    System.out.println("getOrderStatement request=>" + JSON.toJSONString(wrap));
    SgsResponseWrap<File> responseWrap = client.download(SgsApi.GET_ORDER_STATEMENT, wrap, statementFileDir);
    System.out.println("getOrderStatement response=>" + responseWrap);
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    System.out.println("getOrderStatement file path=>" + responseWrap.getBody().getAbsolutePath());
    System.out.println("getOrderStatement file size=>" + responseWrap.getBody().length());

Fund Statement

    GetStatementRequest req = new GetStatementRequest();
    // setting statementDate
    req.setStatementDate("20200605");
    PayByClient client = getPayByClient();
    SgsRequestWrap<GetStatementRequest> wrap = SgsRequestWrap.wrap(req);
    String statementFilePath = "d:\\payby_statement_file";
    File statementFileDir = new File(statementFilePath);
    System.out.println("getFundStatement request=>" + JSON.toJSONString(wrap));
    SgsResponseWrap<File> responseWrap = client.download(SgsApi.GET_FUND_STATEMENT, wrap, statementFileDir);
    System.out.println("getFundStatement response=>" + responseWrap);
    Assert.assertTrue(SgsApi.checkResponse(responseWrap));
    System.out.println("getFundStatement file path=>" + responseWrap.getBody().getAbsolutePath());
    System.out.println("getFundStatement file size=>" + responseWrap.getBody().length());

16. InApp Signature​

    InappSignContent content = new InappSignContent();
    // iapAppId Required
    content.setIapAppId("00001");
    // iapDeviceId Required
    content.setIapDeviceId("001");
    // partnerId Required
    content.setIapPartnerId("20000000076");
    // token Required
    content.setToken("daerccxxcdsda0eeda");
    String merchantPrivateKey = new String(Files.readAllBytes(
        Paths.get(PayByDemo.class.getClassLoader().getResource("merchant_demo_private.pem").toURI())));
    System.out.println("plain==>" + SignSerializationUtil.serialize(content));
    System.out.println("sign==>" + RsaUtil.sign(content, Charset.forName("UTF-8"), merchantPrivateKey));