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

Card Token Information

The Card Token Information API allows merchants to retrieve customer card information that has been stored through the 2C2P PGW.

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.0,
    "currencyCode": "THB",
    "nonceStr": "a8092512-b144-41b0-8284-568bb5e9264c",
    "paymentChannel": ["ALL"]
}

 

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. Prepare Card Token Info Request

To prepare a card token info request, refer to the parameters below.

📘

Request API Parameters

Refer to: Card Token Info Request API Parameters

CardTokenInfoRequest cardTokenInfoRequest = new CardTokenInfoRequest(paymentToken);
CardTokenInfoRequest *cardTokenInfoRequest =[[CardTokenInfoRequest alloc] initWithPaymentToken: paymentToken];
let cardTokenInfoRequest: CardTokenInfoRequest = CardTokenInfoRequest(paymentToken: paymentToken)

 

4. Retrieve Card Token Info Response

To retrieve a card token information response, refer to the parameters below.

📘

Response API Parameters

Refer to: Card Token Info Response API Parameters

PGWSDK.getInstance().cardTokenInfo(cardTokenInfoRequest, new APIResponseCallback<CardTokenInfoResponse>() {
 
     @Override
     public void onResponse(CardTokenInfoResponse response) {
         if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
             //Read card token info response. 
         } else {
             //Get error response and display error.
         }
     }
 
     @Override
     public void onFailure(Throwable error) {
         //Get error response and display error.
     }
});
[[PGWSDK shared] cardTokenInfoWithCardTokenInfoRequest: cardTokenInfoRequest response: ^(CardTokenInfoResponse * _Nonnull response) {        
     if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
          //Read card token info response.
     } else {
         //Get error response and display error.
     }
} failure: ^(NSError * _Nonnull error) { 
     //Get error response and display error.
}];
PGWSDK.shared.cardTokenInfo(cardTokenInfoRequest: cardTokenInfoRequest, { (response: CardTokenInfoResponse) in
     if response.responseCode == APIResponseCode.APISuccess {
          //Read card token 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 card token info request.
CardTokenInfoRequest cardTokenInfoRequest = new CardTokenInfoRequest(paymentToken);
 
//Step 3: Retrieve card token info response.
PGWSDK.getInstance().cardTokenInfo(cardTokenInfoRequest, new APIResponseCallback<CardTokenInfoResponse>() {
 
     @Override
     public void onResponse(CardTokenInfoResponse response) {
         if(response.getResponseCode().equals(APIResponseCode.APISuccess)) {
             //Read card token 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 card token info request.
CardTokenInfoRequest *cardTokenInfoRequest =[[CardTokenInfoRequest alloc] initWithPaymentToken: paymentToken];
     
//Step 3: Retrieve card token info response.
[[PGWSDK shared] cardTokenInfoWithCardTokenInfoRequest: cardTokenInfoRequest response: ^(CardTokenInfoResponse * _Nonnull response) {   
     if([response.responseCode isEqualToString: APIResponseCode.APISuccess]) {
          //Read card token 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 card token info request.
let cardTokenInfoRequest: CardTokenInfoRequest = CardTokenInfoRequest(paymentToken: paymentToken)
          
//Step 3: Retrieve card token info response.
PGWSDK.shared.cardTokenInfo(cardTokenInfoRequest: cardTokenInfoRequest, { (response: CardTokenInfoResponse) in
     if response.responseCode == APIResponseCode.APISuccess {
          //Read card token info response.
     } else {
          //Get error response and display error.
     }
}) { (error: NSError) in
     //Get error response and display error.
}