RPP (Recurring Payment Plan)

1. Prepare Payment Token Request

Refer to the required parameters below to create a payment token. Enter the required additional field to specify recurring payment.

📘

Please refer: Payment Token API Request

{
    "merchantID": "JT01",
    "invoiceNo": "1523953661",
    "description": "item 1",
    "amount": 1500.00,
    "currencyCode": "THB",
    "recurring": true,
    "invoicePrefix": "020620125724",
    "recurringAmount": "10",
    "allowAccumulate": false,
    "maxAccumulateAmount": "1500",
    "recurringInterval": "30",
    "recurringCount": "12",
    "chargeNextDate": "03062020"
}

2. Receive Payment Token Response

Refer to the sample payment token response below.

📘

Please refer: Payment Token API Response

{
  "webPaymentUrl": "https://sandbox-pgw-ui.2c2p.com/payment/4.1/#/token/kSAops9Zwhos8hSTSeLTUcCrwcnrndJUZanGJy3fBEsXCiYmynwxHvK5h7XPBadJqD0nG7v65t5N2jPVrnwX2jL4nu%2bKKSegjUjERKCyWPg%3d",
  "paymentToken": "kSAops9Zwhos8hSTSeLTUcCrwcnrndJUZanGJy3fBEsXCiYmynwxHvK5h7XPBadJqD0nG7v65t5N2jPVrnwX2jL4nu+KKSegjUjERKCyWPg=",
  "respCode": "0000",
  "respDesc": "Success"
}

3. Validation of Payment Token

Proceed only when the parameter "respCode" is "0000" which inidcates success. Otherwise, terminate the payment process. Refer to the Payment Response Code below.

🚧

Please refer : Payment Response Code

4. Redirect to Payment Page

Redirect to payment page via browser. The payment page URL is returned from the parameter "webPaymentUrl".

5. Receive Payment Response via backend API

📘

Please refer : Payment Response - Backend API

The parameter "backendReturnUrl" that was previously sent via Payment Token Request is the merchant endpoint that will receive the backend notification. If the parameter "backendReturnUrl" is not set, the system will obtain the backend return URL from the merchant profile set in 2C2P's merchant portal by default.

{
  "merchantID": "JT01",
  "invoiceNo": "1523953661",
  "cardNo": "411111XXXXXX1111",
  "amount": "1500.00",
  "currencyCode": "THB",
  "cardToken": "28052010234224845229",
  "recurringUniqueID": "138738",  //return recurring ID
  "tranRef": "2876444",
  "referenceNo": "2793077",
  "approvalCode": "287413",
  "eci": "05",
  "transactionDateTime": "20200602133028",
  "respCode": "0000",
  "respDesc": "Success"
}

6. Receive Payment Response via browser redirection

📘

Please refer : Payment Response - Frontend API

The parameter "frontendReturnUrl" that was previously sent via Payment Token Request is the merchant page that the customer will be redirected to. If the parameter "frontendReturnUrl" is not set, the system will obtain the front end return URL from the merchant profile set in 2C2P's merchant portal by default. Refer to the sample response returned below.

{"invoiceNo":"280520075921","channelCode":"CC","respCode":"2000","respDesc":"Transaction is completed, please do payment inquiry request for full payment information."}

Parameter "respCode" specifies the status of the transaction and also indicates what action should be performed next. Refer to Payment Flow Response Code.

🚧

Please refer : Payment Flow Response Code

7. Payment Inquiry to retrieve the payment information

📘

Please refer : Payment Inquiry API

For merchants who do not implement "Receive Payment Response via backend API", they are required to call Payment Inquiry API to receive the payment response.