Loyalty Point Information

The Loyalty Point Information API allows merchants to retrieve details for loyalty point information.

Refer to the links below for parameters and code samples for each step:

πŸ“˜

API Method

PGW SDK API Interface

🚧

References

SDK Payment Classes
SDK Payment Enums

1. Generate Payment Token

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

{
    "merchantID": "JT04",
    "invoiceNo": "1595219400",
    "description": "2 days 1 night hotel room",
    "amount": 10.00,
    "currencyCode": "THB",
    "nonceStr": "a8092512-b144-41b0-8284-568bb5e9264c",
    "paymentChannel": ["ALL"],
    "loyaltyPoints": [{
        "providerID": "DGC",
        "accountNo": "501105",
        "redeemAmount": 1.00,
        "rewards": [{
            "quantity": 1.00
        }]
    }]
}

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"

πŸ“˜

Payment Token API

Refer to: Payment Token API

3. Construct Loyalty Point Info Request

To prepare a loyalty point info request, refer to the parameters below.

πŸ“˜

Request API Parameters

Refer to: Loyalty Point Info API Parameters

LoyaltyPointInfoRequest *loyaltyPointInfoRequest =[[LoyaltyPointInfoRequest alloc] initWithPaymentToken: paymentToken];
loyaltyPointInfoRequest.providerId = @"DGC";
PaymentOptionRequest *paymentOptionRequest = [[PaymentOptionRequest alloc] initWithPaymentToken: paymentToken];
let loyaltyPointInfoRequest: LoyaltyPointInfoRequest = LoyaltyPointInfoRequest(paymentToken: paymentToken)
loyaltyPointInfoRequest.providerId = "DGC"

4. Retrieve Loyalty Point Info

To receive a loyalty point info response, refer to the parameters below.

πŸ“˜

Response API Parameters

Refer to: Loyalty Point Info Response API Parameters

PGWSDK.getInstance().loyaltyPointInfo(loyaltyPointInfoRequest, new APIResponseCallback<LoyaltyPointInfoResponse>() {
 
     @Override
     public void onResponse(LoyaltyPointInfoResponse response) {
 
         if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
 
             //Read loyalty point info response. 
         } else {
 
             //Get error response and display error.
         }
     }
 
     @Override
     public void onFailure(Throwable error) {
 
         //Get error response and display error.
     }
});
[[PGWSDK shared] loyaltyPointInfoWithLoyaltyPointInfoRequest: loyaltyPointInfoRequest response: ^(LoyaltyPointInfoResponse * _Nonnull response) {
              
     if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
      
         //Read loyalty point info response.
     } else {
      
         //Get error response and display error.
     }
} failure: ^(NSError * _Nonnull error) {
      
     //Get error response and display error.
}];
PGWSDK.shared.loyaltyPointInfo(loyaltyPointInfoRequest: loyaltyPointInfoRequest, { (response: LoyaltyPointInfoResponse) in
 
     if response.responseCode == APIResponseCode.APISuccess {
 
          //Read loyalty point info response.
     } 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 : Generate payment token
String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
 
//Step 2: Construct loyalty point info request.
LoyaltyPointInfoRequest loyaltyPointInfoRequest = new LoyaltyPointInfoRequest(paymentToken);
loyaltyPointInfoRequest.setProviderId("DGC");
 
//Step 3: Retrieve loyalty point info.
PGWSDK.getInstance().loyaltyPointInfo(loyaltyPointInfoRequest, new APIResponseCallback<LoyaltyPointInfoResponse>() {
 
     @Override
     public void onResponse(LoyaltyPointInfoResponse response) {
 
         if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
 
             //Read loyalty point info response. 
         } else {
 
             //Get error response and display error.
         }
     }
 
     @Override
     public void onFailure(Throwable error) {
 
         //Get error response and display error.
     }
});
//Step 1 : Generate payment token
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
 
//Step 2: Construct loyalty point info request.
LoyaltyPointInfoRequest *loyaltyPointInfoRequest =[[LoyaltyPointInfoRequest alloc] initWithPaymentToken: paymentToken];
loyaltyPointInfoRequest.providerId = @"DGC";
          
//Step 3: Retrieve loyalty point info.
[[PGWSDK shared] loyaltyPointInfoWithLoyaltyPointInfoRequest: loyaltyPointInfoRequest response: ^(LoyaltyPointInfoResponse * _Nonnull response) {
              
     if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
      
         //Read loyalty point info response.
     } else {
      
         //Get error response and display error.
     }
} failure: ^(NSError * _Nonnull error) {
      
     //Get error response and display error.
}];
//Step 1 : Generate payment token
let paymentToken: String = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
 
//Step 2: Construct loyalty point info request. 
let loyaltyPointInfoRequest: LoyaltyPointInfoRequest = LoyaltyPointInfoRequest(paymentToken: paymentToken)
loyaltyPointInfoRequest.providerId = "DGC"
          
//Step 3: Retrieve loyalty point info. 
PGWSDK.shared.loyaltyPointInfo(loyaltyPointInfoRequest: loyaltyPointInfoRequest, { (response: LoyaltyPointInfoResponse) in
 
     if response.responseCode == APIResponseCode.APISuccess {
 
          //Read loyalty point info response.
     } else {
 
          //Get error response and display error.
     }
}) { (error: NSError) in
 
     //Get error response and display error.
}