Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

Deep Link Payment

2C2P allows merchants to make payment with secured and seamlessly with third party mobile application.

📘

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.

📘

Payment Token API

Refer to: Payment Token API

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

2. Receive Payment Token Response

To receive a payment token response, refer to the sample payment token response below.

String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";

val 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"

String paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';

let paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';

3. Construct Payment Request

To prepare a payment request, refer to the sample code below.

📘

Payment Request Parameter

Refer to: Payment Request API Parameter

🚧

Payment Channel Matrix

To see the available payment channels and agents for supported banks, refer to: Payment Channel Matrix

PaymentCode paymentCode = new PaymentCode("123", "THSCB", "DEEPLINK");
 
PaymentRequest paymentRequest = new DeepLinkPaymentBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("0888888888")
                                .build();

val paymentCode = PaymentCode("123", "THSCB", "DEEPLINK")
 
val paymentRequest = DeepLinkPaymentBuilder(paymentCode).apply {
       name("DavidBilly")
       email("[email protected]")
       mobileNo("0888888888")
}.build()

PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"123" agentCode: @"THSCB" agentChannelCode: @"DEEPLINK"];
          
PaymentRequest *paymentRequest = [[[[[[DeepLinkPaymentBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"0888888888"]
                                       build];

let paymentCode: PaymentCode = PaymentCode(channelCode: "123", "THSCB", "DEEPLINK")
 
let paymentRequest: PaymentRequest = DeepLinkPaymentBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("0888888888")
                                     .build()

Map<String, dynamic> paymentCode = {
   'channelCode': '123',
   'agentCode': 'THSCB',
   'agentChannelCode': 'DEEPLINK'
};
 
Map<String, dynamic> paymentRequest = {
   'name': 'DavidBilly',
   'email': '[email protected]',
   'mobileNo': '0888888888'
};

let paymentCode = {
   'channelCode': '123',
   'agentCode': 'THSCB',
   'agentChannelCode': 'DEEPLINK'
};
 
let paymentRequest = {
   'name': 'DavidBilly',
   'email': '[email protected]',
   'mobileNo': '0888888888'
};

4. Construct Transaction Request

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

📘

Payment Transaction Request API Parameters

Refer to: Do Payment Request API Parameters

TransactionResultRequest transactionResultRequest = new TransactionResultRequestBuilder(paymentToken)
                                                    .with(paymentRequest)
                                                    .build();

val transactionResultRequest = TransactionResultRequestBuilder(paymentToken).apply {
       with(paymentRequest)
}.build()

TransactionResultRequest *transactionResultRequest = [[[[TransactionResultRequestBuilder alloc] initWithPaymentToken: paymentToken]
                                                         withPaymentRequest: paymentRequest]
                                                         build];)

let transactionResultRequest: TransactionResultRequest = TransactionResultRequestBuilder(paymentToken: paymentToken)
                                                         .with(paymentRequest)
                                                         .build()

Map<String, dynamic> transactionResultRequest = {
   'paymentToken': paymentToken,
   'payment': {
      'code': {
        ...paymentCode
      },
      'data': {
        ...paymentRequest
      }
   }
};

let transactionResultRequest = {
   'paymentToken': paymentToken,
   'payment': {
      'code': {
        ...paymentCode
      },
      'data': {
        ...paymentRequest
      }
   }
};

5. Execute Payment Request

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

📘

Payment Transaction Response API Parameters

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.TransactionAuthenticateRedirect) || response.getResponseCode().equals(APIResponseCode.TransactionAuthenticateFullRedirect)) {
 
               String redirectUrl = response.getData(); //Open WebView
           } else if (response.getResponseCode().equals(APIResponseCode.TransactionExternalApplication)) {
 
               String deepLink = response.getData(); //Open external application          
           } else {
 
               //Get error response and display error.
           }
     }
 
     @Override
     public void onFailure(Throwable error) {
 
          //Get error response and display error.
     }
});

PGWSDK.getInstance().proceedTransaction(transactionResultRequest, object : APIResponseCallback<TransactionResultResponse> {
 
       override fun onResponse(response: TransactionResultResponse) {
 
              if (response.responseCode == APIResponseCode.TransactionAuthenticateRedirect || response.responseCode == APIResponseCode.TransactionAuthenticateFullRedirect) {
 
                     val redirectUrl = response.data //Open WebView
              } else if (response.responseCode == APIResponseCode.TransactionExternalApplication) {
 
                     val deepLink = response.data //Open external application
              } else {
 
                     //Get error response and display error.
              }
       }
 
       override fun onFailure(error: Throwable) {
 
              //Get error response and display error.
       }
})

[[PGWSDK shared] proceedTransactionWithTransactionResultRequest: transactionResultRequest response: ^(TransactionResultResponse * _Nonnull response) {                  
 
     if([response.responseCode isEqualToString: APIResponseCode.TransactionAuthenticateRedirect] || [response.responseCode isEqualToString: APIResponseCode.TransactionAuthenticateFullRedirect]) {
             
         NSString *redirectUrl = response.data; //Open WebView
     } else if([response.responseCode isEqualToString: APIResponseCode.TransactionExternalApplication]) {
             
         NSString *deepLink = response.data; //Open external application      
     } 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.TransactionAuthenticateRedirect || response.responseCode == APIResponseCode.TransactionAuthenticateFullRedirect {
             
          let redirectUrl: String = response.data //Open WebView
     } else if response.responseCode == APIResponseCode.TransactionExternalApplication {
                 
          let deepLink: String = response.data //Open external application     
     } else {
                 
          //Get error response and display error.
     }
}) { (error: NSError) in
             
     //Get error response and display error.
}

PGWSDK().proceedTransaction(transactionResultRequest, (response) {
 
   if (response['responseCode'] == APIResponseCode.transactionAuthenticateRedirect || response['responseCode'] == APIResponseCode.transactionAuthenticateFullRedirect) {
 
      String redirectUrl = response['data']; //Open WebView
   } else if (response['responseCode'] == APIResponseCode.transactionExternalApplication) {
 
      String deepLink = response['data']; //Open external application
   } else {
 
      //Get error response and display error.
   }
}, (error) {
 
    //Get error response and display error.
});

await RTNPGW.proceedTransaction(JSON.stringify(transactionResultRequest)).then((response: string) => {
  
    let transactionResultResponse = JSON.parse(response);
  
    if (transactionResultResponse?.responseCode == APIResponseCode.transactionAuthenticateRedirect || transactionResultResponse?.responseCode == APIResponseCode.transactionAuthenticateFullRedirect) {
  
        let redirectUrl = transactionResultResponse?.data; //Open WebView
    } else if (transactionResultResponse?.responseCode == APIResponseCode.transactionExternalApplication) {
 
        let deepLink = transactionResultResponse?.data; //Open external application
    } else {
  
        //Get error response and display error.
    }
}).catch ((error: Error) => {
  
    //Get error response and display error
});

👍

Callback for PGW Payment Authentication

Refer to: Handle PGW Payment Authentication

👍

Callback for PGW Deep Link

Refer to: Handle PGW Deep Link


6. Initiate Transaction Status Inquiry

To retrieve transaction details and status, merchants must initiate the Transaction Status Inquiry API. Refer to the sample code below.

📘

Transaction Status Inquiry API

Refer to: Transaction Status Inquiry API


Full Sample Code

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

//Step 1: Generate payment token.
String paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
 
//Step 2: Construct Deep Link payment request.
PaymentCode paymentCode = new PaymentCode("123", "THSCB", "DEEPLINK");
 
PaymentRequest paymentRequest = new DeepLinkPaymentBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("0888888888")
                                .build();
 
//Step 3: Construct transaction request.
TransactionResultRequest transactionResultRequest = new TransactionResultRequestBuilder(paymentToken)
                                                    .with(paymentRequest)
                                                    .build();
 
//Step 4: Execute payment request.
PGWSDK.getInstance().proceedTransaction(transactionResultRequest, new APIResponseCallback<TransactionResultResponse>() {
 
     @Override
     public void onResponse(TransactionResultResponse response) {         
 
           if (response.getResponseCode().equals(APIResponseCode.TransactionAuthenticateRedirect) || response.getResponseCode().equals(APIResponseCode.TransactionAuthenticateFullRedirect)) {
 
               String redirectUrl = response.getData(); //Open WebView
           } else if (response.getResponseCode().equals(APIResponseCode.TransactionExternalApplication)) {
 
               String deepLink = response.getData(); //Open external application          
           } else {
 
               //Get error response and display error.
           }
     }
 
     @Override
     public void onFailure(Throwable error) {
 
          //Get error response and display error.
     }
});

//Step 1: Generate payment token.
val paymentToken = "roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL"
 
//Step 2: Construct Deep Link payment request.
val paymentCode = PaymentCode("123", "THSCB", "DEEPLINK")
 
val paymentRequest = DeepLinkPaymentBuilder(paymentCode).apply {
       name("DavidBilly")
       email("[email protected]")
       mobileNo("0888888888")
}.build()
 
//Step 3: Construct transaction request.
val transactionResultRequest = TransactionResultRequestBuilder(paymentToken).apply {
       with(paymentRequest)
}.build()
 
//Step 4: Execute payment request.
PGWSDK.getInstance().proceedTransaction(transactionResultRequest, object : APIResponseCallback<TransactionResultResponse> {
 
       override fun onResponse(response: TransactionResultResponse) {
 
              if (response.responseCode == APIResponseCode.TransactionAuthenticateRedirect || response.responseCode == APIResponseCode.TransactionAuthenticateFullRedirect) {
 
                     val redirectUrl = response.data //Open WebView
              } else if (response.responseCode == APIResponseCode.TransactionExternalApplication) {
 
                     val deepLink = response.data //Open external application
              } else {
 
                     //Get error response and display error.
              }
       }
 
       override fun onFailure(error: Throwable) {
 
              //Get error response and display error.
       }
})

//Step 1: Generate payment token.
NSString *paymentToken = @"roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL";
 
//Step 2: Construct Deep Link payment request.
PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"123" agentCode: @"THSCB" agentChannelCode: @"DEEPLINK"];
          
PaymentRequest *paymentRequest = [[[[[[DeepLinkPaymentBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"0888888888"]
                                       build];
     
//Step 3: Construct transaction request.
TransactionResultRequest *transactionResultRequest = [[[[TransactionResultRequestBuilder alloc] initWithPaymentToken: paymentToken]
                                                         withPaymentRequest: paymentRequest]
                                                         build];
 
//Step 4: Execute payment request.
[[PGWSDK shared] proceedTransactionWithTransactionResultRequest: transactionResultRequest response: ^(TransactionResultResponse * _Nonnull response) {                  
 
     if([response.responseCode isEqualToString: APIResponseCode.TransactionAuthenticateRedirect] || [response.responseCode isEqualToString: APIResponseCode.TransactionAuthenticateFullRedirect]) {
             
         NSString *redirectUrl = response.data; //Open WebView
     } else if([response.responseCode isEqualToString: APIResponseCode.TransactionExternalApplication]) {
             
         NSString *deepLink = response.data; //Open external application      
     } 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 Deep Link payment request.
let paymentCode: PaymentCode = PaymentCode(channelCode: "123", "THSCB", "DEEPLINK")
 
let paymentRequest: PaymentRequest = DeepLinkPaymentBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("0888888888")
                                     .build()
         
//Step 3: Construct transaction request.
let transactionResultRequest: TransactionResultRequest = TransactionResultRequestBuilder(paymentToken: paymentToken)
                                                         .with(paymentRequest)
                                                         .build()
         
//Step 4: Execute payment request.
PGWSDK.shared.proceedTransaction(transactionResultRequest: transactionResultRequest, { (response:TransactionResultResponse) in          
 
     if response.responseCode == APIResponseCode.TransactionAuthenticateRedirect || response.responseCode == APIResponseCode.TransactionAuthenticateFullRedirect {
             
          let redirectUrl: String = response.data //Open WebView
     } else if response.responseCode == APIResponseCode.TransactionExternalApplication {
                 
          let deepLink: String = response.data //Open external application     
     } else {
                 
          //Get error response and display error.
     }
}) { (error: NSError) in
             
     //Get error response and display error.
}

//Step 1: Generate payment token.
String paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
 
//Step 2: Construct Deep Link payment request.
Map<String, dynamic> paymentCode = {
   'channelCode': '123',
   'agentCode': 'THSCB',
   'agentChannelCode': 'DEEPLINK'
};
 
Map<String, dynamic> paymentRequest = {
   'name': 'DavidBilly',
   'email': '[email protected]',
   'mobileNo': '0888888888'
};
 
//Step 3: Construct transaction request.
Map<String, dynamic> transactionResultRequest = {
   'paymentToken': paymentToken,
   'payment': {
      'code': {
        ...paymentCode
      },
      'data': {
        ...paymentRequest
      }
   }
};
 
//Step 4: Execute payment request.
PGWSDK().proceedTransaction(transactionResultRequest, (response) {
 
   if (response['responseCode'] == APIResponseCode.transactionAuthenticateRedirect || response['responseCode'] == APIResponseCode.transactionAuthenticateFullRedirect) {
 
      String redirectUrl = response['data']; //Open WebView
   } else if (response['responseCode'] == APIResponseCode.transactionExternalApplication) {
 
      String deepLink = response['data']; //Open external application
   } else {
 
      //Get error response and display error.
   }
}, (error) {
 
    //Get error response and display error.
});

//Step 1: Generate payment token.
let paymentToken = 'roZG9I1hk/GYjNt+BYPYbxQtKElbZDs9M5cXuEbE+Z0QTr/yUcl1oG7t0AGoOJlBhzeyBtf5mQi1UqGbjC66E85S4m63CfV/awwNbbLbkxsvfgzn0KSv7JzH3gcs/OIL';
 
//Step 2: Construct Deep Link payment request.
let paymentCode = {
   'channelCode': '123',
   'agentCode': 'THSCB',
   'agentChannelCode': 'DEEPLINK'
};
 
let paymentRequest = {
   'name': 'DavidBilly',
   'email': '[email protected]',
   'mobileNo': '0888888888'
};
 
//Step 3: Construct transaction request.
let transactionResultRequest = {
   'paymentToken': paymentToken,
   'payment': {
      'code': {
        ...paymentCode
      },
      'data': {
        ...paymentRequest
      }
   }
};
 
//Step 4: Execute payment request.
await RTNPGW.proceedTransaction(JSON.stringify(transactionResultRequest)).then((response: string) => {
  
    let transactionResultResponse = JSON.parse(response);
  
    if (transactionResultResponse?.responseCode == APIResponseCode.transactionAuthenticateRedirect || transactionResultResponse?.responseCode == APIResponseCode.transactionAuthenticateFullRedirect) {
  
        let redirectUrl = transactionResultResponse?.data; //Open WebView
    } else if (transactionResultResponse?.responseCode == APIResponseCode.transactionExternalApplication) {
 
        let deepLink = transactionResultResponse?.data; //Open external application
    } else {
  
        //Get error response and display error.
    }
}).catch ((error: Error) => {
  
    //Get error response and display error
});

Updated 6 months ago