ZaloPay Wallet

πŸ“˜

API Method

PGW SDK API Interface

🚧

References

SDK Payment Classes
SDK Payment Enums

Prerequisite

Refer all the steps and images from following link.

πŸ“˜

ZaloPay Prerequisite

1. Generate Payment Token

To prepare a payment token request, refer to the required parameters below.

πŸ“˜

Payment Token API

Refer to: Payment Token API

{
    "merchantID": "JT08",
    "invoiceNo": "1595219400",
    "description": "2 days 1 night hotel room",
    "amount": 10.0,
    "currencyCode": "VND",
    "nonceStr": "a8092512-b144-41b0-8284-568bb5e9264c",
    "paymentChannel": ["DPAY"]
}

Β 

2. Receive Payment Token Response

To receive a payment token response, refer to the sample payment token response below. The response will contain the payment token ID which must be passed to the merchant application.

String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
let paymentToken: String = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"

Β 

3. Construct e-Wallet Request

To prepare an e-wallet payment request, refer to the sample code below.

πŸ“˜

Payment Request Parameters

Refer to Payment Request API Parameters

🚧

Payment Channel Matrix

Refer to the payment channel codes for the Touch 'n Go e-wallet below.

Category CodeGroup CodeChannelNameCountry
DPAYEWALLETZALOPAYZalopayVN
PaymentCode paymentCode = new PaymentCode("ZALOPAY");
 
PaymentRequest paymentRequest = new DigitalPaymentBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("08888888")
                                .build();
PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"ZALOPAY"];
          
PaymentRequest *paymentRequest = [[[[[[DigitalPaymentBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"08888888"]
                                       build];
let paymentCode: PaymentCode = PaymentCode(channelCode: "ZALOPAY")
 
let paymentRequest: PaymentRequest = DigitalPaymentBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("08888888")
                                     .build()

Β 

4. Construct Transaction Request

To prepare a transaction request, refer to the parameters and sample code below.

πŸ“˜

Transaction Request API Parameters

Refer to: Do Payment Request API Parameters

TransactionResultRequest transactionResultRequest = new TransactionResultRequestBuilder(paymentToken)
                                                    .with(paymentRequest)
                                                    .build();
TransactionResultRequest *transactionResultRequest = [[[[TransactionResultRequestBuilder alloc] initWithPaymentToken: paymentToken]
                                                         withPaymentRequest: paymentRequest]
                                                         build];
let transactionResultRequest: TransactionResultRequest = TransactionResultRequestBuilder(paymentToken: paymentToken)
                                                         .with(paymentRequest)
                                                         .build()

Β 

5. Execute Payment Request

To receive a transaction request response, refer to the parameters below.

πŸ“˜

Transaction Response API Parameter

Refer to: Do Payment Response API Parameters

🚧

References

Response Code
To view payment process flows based on response code, refer to: Payment Flow Response Codes

PGWSDK.getInstance().proceedTransaction(transactionResultRequest, new APIResponseCallback<TransactionResultResponse>() {
    
     @Override
     public void onResponse(TransactionResultResponse response) {
    
          if(response.getResponseCode().equals(APIResponseCode.TransactionExternalApplication)) {
    
          } else {
    
               //Get error response and display error.
          }
     }
    
     @Override
     public void onFailure(Throwable error) {
    
          //Get error response and display error.
     }
});
[[PGWSDK shared] proceedTransactionWithTransactionResultRequest: transactionResultRequest response: ^(TransactionResultResponse * _Nonnull response) {
              
     if([response.responseCode isEqualToString: APIResponseCode.TransactionExternalApplication]) {
                         
     } else {
                  
          //Get error response and display error.
     }
} failure: ^(NSError * _Nonnull error) {
              
     //Get error response and display error.
}];
PGWSDK.shared.proceedTransaction(transactionResultRequest: transactionResultRequest, { (response: TransactionResultResponse) in
      
     if response.responseCode == APIResponseCode.TransactionExternalApplication {
                
      } else {
                   
           //Get error response and display error.
      }
}) { (error: NSError) in
               
     //Get error response and display error.
}

πŸ‘

Callback for PGW Payment Authentication

Refer to: Handle PGW Payment Authentication

Β 

6. Construct ZaloPay payment request.

PaymentProviderRequest paymentProviderRequest = new PaymentProviderBuilder(getActivity())
                                                               .setTransactionResultResponse(response)
                                                               .build();
 
PGWSDKHelper.getInstance().proceedZaloPayPayment(paymentProviderRequest, new PaymentResultResponseCallback<ZaloPayPaymentResultResponse>() {

   @Override
   public void onResponse(ZaloPayPaymentResultResponse response) {
              
        if(response.getResponseCode().equalsIgnoreCase(ZaloPayPaymentResponseCode.PaymentSuccess)) {

             //Inquiry payment result by using payment token.
        } else {

             //Get error response and display error.
        }
   }

   @Override
   public void onFailure(Throwable error) {

        //Get error response and display error.
   }
});
PaymentProviderRequest *paymentProviderRequest = [[[[PaymentProviderBuilder alloc] init]
                                                               transactionResultResponse: response]
                                                               build];
              
[[PGWSDKHelper shared] proceedZaloPayPaymentWithPaymentProviderRequest: paymentProviderRequest response: ^(ZaloPayPaymentResultResponse * _Nonnull response) {

     if([response.responseCode isEqualToString: ZaloPayPaymentResponseCode.PaymentSuccess]) {
            
           //Inquiry payment result by using payment token.
     } else {
            
           //Get error response and display error.
     }
 } failure: ^(NSError * _Nonnull error) {
         
      //Get error response and display error.
 }];  
let paymentProviderRequest: PaymentProviderRequest = PaymentProviderBuilder()
                                                               .transactionResultResponse(response)
                                                               .build()
                  
 PGWSDKHelper.shared.proceedZaloPayPayment(paymentProviderRequest: paymentProviderRequest, { (response: ZaloPayPaymentResultResponse) in

      if response.responseCode == ZaloPayPaymentResponseCode.PaymentSuccess {

           //Inquiry payment result by using payment token.
      } else {
       
           //Get error response and display error.
      }
 }) { (error: NSError) in

       //Get error response and display error.
 }  

Β 

Full Sample Code

The following sample code demonstrates requests and parameters for each step of the process.

//Step 1 & 2: Generate payment token id.
String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
    
//Step 3: Construct e-wallet request
PaymentCode paymentCode = new PaymentCode("ZALOPAY");
 
PaymentRequest paymentRequest = new DigitalPaymentBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("08888888")
                                .build();
    
//Step 4: Construct transaction request.
TransactionResultRequest transactionResultRequest = new TransactionResultRequestBuilder(paymentToken)
                                                    .with(paymentRequest)
                                                    .build();
    
//Step 5: Execute payment request.
PGWSDK.getInstance().proceedTransaction(transactionResultRequest, new APIResponseCallback<TransactionResultResponse>() {
    
     @Override
     public void onResponse(TransactionResultResponse response) {
    
          if(response.getResponseCode().equals(APIResponseCode.TransactionExternalApplication)) {
    
               //Step 6: Construct ZaloPay payment request.
               PaymentProviderRequest paymentProviderRequest = new PaymentProviderBuilder(getActivity())
                                                               .setTransactionResultResponse(response)
                                                               .build();
 
               PGWSDKHelper.getInstance().proceedZaloPayPayment(paymentProviderRequest, new PaymentResultResponseCallback<ZaloPayPaymentResultResponse>() {
 
                  @Override
                  public void onResponse(ZaloPayPaymentResultResponse response) {
                             
                       if(response.getResponseCode().equalsIgnoreCase(ZaloPayPaymentResponseCode.PaymentSuccess)) {
 
                            //Inquiry payment result by using payment token.
                       } else {
 
                            //Get error response and display error.
                       }
                  }
 
                  @Override
                  public void onFailure(Throwable error) {
 
                       //Get error response and display error.
                  }
              });
          } else {
    
               //Get error response and display error.
          }
     }
    
     @Override
     public void onFailure(Throwable error) {
    
          //Get error response and display error.
     }
});
//Step 1 & 2: Generate payment token id.
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
   
//Step 3: Construct e-wallet request.
PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"ZALOPAY"];
          
PaymentRequest *paymentRequest = [[[[[[DigitalPaymentBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"08888888"]
                                       build];
   
//Step 4: Construct transaction request. 
TransactionResultRequest *transactionResultRequest = [[[[TransactionResultRequestBuilder alloc] initWithPaymentToken: paymentToken]
                                                         withPaymentRequest: paymentRequest]
                                                         build];
       
//Step 5: Execute payment request.
[[PGWSDK shared] proceedTransactionWithTransactionResultRequest: transactionResultRequest response: ^(TransactionResultResponse * _Nonnull response) {
              
     if([response.responseCode isEqualToString: APIResponseCode.TransactionExternalApplication]) {
                  
          //Step 6: Construct ZaloPay payment request.
          PaymentProviderRequest *paymentProviderRequest = [[[[PaymentProviderBuilder alloc] init]
                                                               transactionResultResponse: response]
                                                               build];
              
          [[PGWSDKHelper shared] proceedZaloPayPaymentWithPaymentProviderRequest: paymentProviderRequest response: ^(ZaloPayPaymentResultResponse * _Nonnull response) {
   
               if([response.responseCode isEqualToString: ZaloPayPaymentResponseCode.PaymentSuccess]) {
                      
                     //Inquiry payment result by using payment token.
               } else {
                      
                     //Get error response and display error.
               }
           } failure: ^(NSError * _Nonnull error) {
                   
                //Get error response and display error.
           }];        
     } else {
                  
          //Get error response and display error.
     }
} failure: ^(NSError * _Nonnull error) {
              
     //Get error response and display error.
}];
//Step 1 & 2: Generate payment token id.
let paymentToken: String = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
      
//Step 3: Construct e-wallet request.
let paymentCode: PaymentCode = PaymentCode(channelCode: "ZALOPAY")
 
let paymentRequest: PaymentRequest = DigitalPaymentBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("08888888")
                                     .build()         
 
//Step 4: Construct transaction request.
let transactionResultRequest: TransactionResultRequest = TransactionResultRequestBuilder(paymentToken: paymentToken)
                                                         .with(paymentRequest)
                                                         .build()
           
//Step 5: Execute payment request.
PGWSDK.shared.proceedTransaction(transactionResultRequest: transactionResultRequest, { (response: TransactionResultResponse) in
      
     if response.responseCode == APIResponseCode.TransactionExternalApplication {
                
           //Step 6: Construct ZaloPay payment request.
           let paymentProviderRequest: PaymentProviderRequest = PaymentProviderBuilder()
                                                               .transactionResultResponse(response)
                                                               .build()
                  
           PGWSDKHelper.shared.proceedZaloPayPayment(paymentProviderRequest: paymentProviderRequest, { (response: ZaloPayPaymentResultResponse) in
 
                if response.responseCode == ZaloPayPaymentResponseCode.PaymentSuccess {
 
                     //Inquiry payment result by using payment token.
                } else {
                 
                     //Get error response and display error.
                }
           }) { (error: NSError) in
 
                 //Get error response and display error.
           }
      } else {
                   
           //Get error response and display error.
      }
}) { (error: NSError) in
               
     //Get error response and display error.
}