These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Self Service Machines

The 2C2P PGW SDK allows customers to use merchant applications to pay at merchant kiosks or machines.

📘

API Method

PGW SDK API Interface

🚧

References

SDK Payment Classes
SDK Payment Enums

 

1. Prepare Payment Token Request

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": ["SSM"]
}

 

2. Receive Payment Token Response

To receive a payment token response, refer to the sample payment token response below. This will return a 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. Prepare Payment Request

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

📘

Payment Request Parameters

Refer to: Self Service Machine Payment Request API Parameters

🚧

Payment Channels & Agents

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

PaymentCode paymentCode = new PaymentCode("123", "UOB", "ATM");
 
PaymentRequest paymentRequest = new SelfServiceMachineBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("08888888")
                                .build();
PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"123" agentCode: @"UOB" agentChannelCode: @"ATM"];
          
PaymentRequest *paymentRequest = [[[[[[SelfServiceMachineBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"08888888"]
                                       build];
let paymentCode: PaymentCode = PaymentCode(channelCode: "123", "UOB", "ATM")
 
let paymentRequest: PaymentRequest = SelfServiceMachineBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("08888888")
                                     .build()

 

4. Prepare Transaction Request

To prepare a transaction request, refer to the parameters 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. Receive Transaction Request Response

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

📘

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.TransactionPaymentSlip)) {
 
               String paymentSlipUrl = response.getData(); //Open payment slip on WebView
           } 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.TransactionPaymentSlip]) {
                     
         NSString *paymentSlipUrl = response.data; //Open payment slip on WebView
     } 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.TransactionPaymentSlip {
             
          guard let paymentSlipUrl: String = response.data else { return } //Open payment slip on WebView
     } 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

 

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 Self Service Machine request.
PaymentCode paymentCode = new PaymentCode("123", "UOB", "ATM");
 
PaymentRequest paymentRequest = new SelfServiceMachineBuilder(paymentCode)
                                .setName("DavidBilly")
                                .setEmail("[email protected]")
                                .setMobileNo("08888888")
                                .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.TransactionPaymentSlip)) {
 
               String paymentSlipUrl = response.getData(); //Open payment slip on WebView
           } 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 Self Service Machine request.
PaymentCode *paymentCode = [[PaymentCode alloc] initWithChannelCode: @"123" agentCode: @"UOB" agentChannelCode: @"ATM"];
          
PaymentRequest *paymentRequest = [[[[[[SelfServiceMachineBuilder alloc] initWithPaymentCode: paymentCode]
                                       name: @"DavidBilly"]
                                       email: @"[email protected]"]
                                       mobileNo: @"08888888"]
                                       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.TransactionPaymentSlip]) {
                     
         NSString *paymentSlipUrl = response.data; //Open payment slip on WebView
     } 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 Self Service Machine request.
let paymentCode: PaymentCode = PaymentCode(channelCode: "123", "UOB", "ATM")
 
let paymentRequest: PaymentRequest = SelfServiceMachineBuilder(paymentCode: paymentCode)
                                     .name("DavidBilly")
                                     .email("[email protected]")
                                     .mobileNo("08888888")
                                     .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.TransactionPaymentSlip {
             
          guard let paymentSlipUrl: String = response.data else { return } //Open payment slip on WebView
     } else {
                 
          //Get error response and display error.
     }
}) { (error: NSError) in
             
     //Get error response and display error.
}