IPP (Installment Payment Plan)
2C2P Redirect API allows merchants to offer Installment Payment Plans to their customers. Customers have the option of selecting Installment Payment Plans from multiple banks.
Â
How to Integrate
Please refer to the high level diagram flow of Third Party Redirection.
Please refer to the available payment channels below :
Global Installment Payment Plan (IPP)
Local Installment Payment Plan (LIPP)
Â
1. Prepare Payment Token Request
To prepare a payment token request, refer to the required parameters below.
Please refer to: Payment Token API Request
Pre Requisite |
|---|
|
Merchants who already know the specific card payment to process may fill in the corresponding Channel Code, Category Code , or Group Code. The available payment channel will then be shown in the Payment Option and Payment Option Detail APIs. |
{
"merchantID": "JT04",
"invoiceNo": "180920100648",
"description": "V4 Test",
"amount": "10",
"currencyCode": "THB",
"paymentChannel": ["IPP"]
}
Â
2. Receive Payment Token Response
To receive a payment token response, refer to the sample payment token response below.
Please refer to: Payment Token API Response
{
"paymentToken": "kSAops9Zwhos8hSTSeLTURPZNO23dVLrwizwXE1u9XEO9Fhcnss6KvEzhz/NDuThz55NVdN3M3e151hhLHTR+jtX5MWEAio4JP4L929ugHo=",
"respCode": "0000",
"respDesc": "Success"
}
Â
3. Validation of Payment Token
Proceed only when the parameter "respCode" is "0000". Otherwise, terminate the payment process. Refer to the Payment Response Code below.
Please refer to: Payment Response Code
Â
4. Prepare Payment Option Request
To retrieve available payment options, send a payment option request. Refer to the sample Payment Option Request below.
For merchants who already know which payment options are available, this step is optional.
Please refer to: Payment Option API Request
{
"paymentToken": "kSAops9Zwhos8hSTSeLTURPZNO23dVLrwizwXE1u9XEO9Fhcnss6KvEzhz/NDuThz55NVdN3M3e151hhLHTR+jtX5MWEAio4JP4L929ugHo=",
"locale": "en",
"clientID": "30c7cf51-75c4-4265-a70a-effddfbbb0ff"
}
Â
5. Receive Payment Option Response
To receive a payment option response, refer to the sample payment option response below.
Please refer to: Payment Option API Response
{
"paymentToken": "kSAops9Zwhos8hSTSeLTURPZNO23dVLrwizwXE1u9XEO9Fhcnss6KvEzhz/NDuThz55NVdN3M3e151hhLHTR+jtX5MWEAio4JP4L929ugHo=",
"merchantDetails": {
"id": "JT04",
"name": "DEMO Merchant TH",
"address": "DEMO",
"email": "",
"logoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/merchantlogo/JT04.png",
"bannerUrl": null
},
"transactionDetails": {
"amount": "10.00",
"currencyCode": "THB",
"invoiceNo": "180920100648",
"description": "V4 Test"
},
"channelCategories": [{
"groups": [{
"sequenceNo": 1,
"name": "Installment Plan Payment",
"code": "IPP",
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/ipp.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/.png",
"default": true,
"expiration": false
}],
"sequenceNo": 1,
"name": "Global Card",
"code": "GCARD",
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/gcard.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/.png",
"default": true,
"expiration": false
}],
"respCode": "0000",
"respDesc": "Success"
}
Â
6. Prepare Payment Option Details Request
To retrieve details for available payment options, send a payment option details request. Refer to the sample Payment Option Details Request below.
For merchants who already know payment option details, this step is optional.
Pre Requisite |
|---|
|
|
Please refer to: Payment Option Details API Request
{
"categoryCode": "GCARD",
"groupCode": "IPP",
"paymentToken": "kSAops9Zwhos8hSTSeLTURPZNO23dVLrwizwXE1u9XEO9Fhcnss6KvEzhz/NDuThz55NVdN3M3e151hhLHTR+jtX5MWEAio4JP4L929ugHo=",
"locale": "en",
"clientID": "30c7cf51-75c4-4265-a70a-effddfbbb0ff"
}
Â
7. Receive Payment Option Details Response
To receive a payment option details response, refer to the sample payment option details response below.
Please refer to: Payment Option Details API Response
{
"totalChannel": 5,
"name": "Installment Plan Payment",
"categoryCode": "GCARD",
"groupCode": "IPP",
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/ipp.png",
"channels": [{
"sequenceNo": 1,
"name": "Citibank",
"currencyCodes": ["THB"],
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/CITI.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/CITI.png",
"payment": {
"code": {
"channelCode": "IPP"
},
"input": {
"cardNo": "M",
"expiryDate": "M",
"securityCode": "M",
"name": "O",
"email": "O"
},
"validation": {
"cardNo": null,
"expiryDate": "^(2\\d{3}0?[1-9]|1[012])$",
"securityCode": "^[0-9]{3,4}$",
"name": "^(?!\\s*$)[-a-zA-Z' ''.']{1,}$",
"email": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$",
"additional": {
"cardNo": {
"luhn": true,
"prefixes": ["455596", "543449", "438679", "510511", "540522"]
},
"amount": null
}
},
"info": {
"terms": "TOC",
"promoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/ipppromologo/2.png?v=200918030737",
"plans": [{
"sequenceNo": 1,
"period": 3,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 3.33333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "3 months with 0% interest (monthly installment amount 3.33 THB)"
}, {
"sequenceNo": 2,
"period": 6,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.66667,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "6 months with 0% interest (monthly installment amount 1.67 THB)"
}, {
"sequenceNo": 3,
"period": 9,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.11111,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "9 months with 0% interest (monthly installment amount 1.11 THB)"
}]
}
},
"isDown": false
}, {
"sequenceNo": 2,
"name": "Bangkok Bank",
"currencyCodes": ["THB"],
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/BBL.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/BBL.png",
"payment": {
"code": {
"channelCode": "IPP"
},
"input": {
"cardNo": "M",
"expiryDate": "M",
"securityCode": "M",
"name": "O",
"email": "O"
},
"validation": {
"cardNo": null,
"expiryDate": "^(2\\d{3}0?[1-9]|1[012])$",
"securityCode": "^[0-9]{3,4}$",
"name": "^(?!\\s*$)[-a-zA-Z' ''.']{1,}$",
"email": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$",
"additional": {
"cardNo": {
"luhn": true,
"prefixes": ["544485", "444433", "414114", "478825", "411111"]
},
"amount": null
}
},
"info": {
"terms": "TOC",
"promoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/ipppromologo/3.png?v=200918030737",
"plans": [{
"sequenceNo": 1,
"period": 6,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.66667,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "6 months with 0% interest (monthly installment amount 1.67 THB)"
}, {
"sequenceNo": 2,
"period": 9,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.11111,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "9 months with 0% interest (monthly installment amount 1.11 THB)"
}, {
"sequenceNo": 3,
"period": 12,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 0.83333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "12 months with 0% interest (monthly installment amount 0.83 THB)"
}]
}
},
"isDown": false
}, {
"sequenceNo": 3,
"name": "Bank of Ayudhya",
"currencyCodes": ["THB"],
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/BAY.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/BAY.png",
"payment": {
"code": {
"channelCode": "IPP"
},
"input": {
"cardNo": "M",
"expiryDate": "M",
"securityCode": "M",
"name": "O",
"email": "O"
},
"validation": {
"cardNo": null,
"expiryDate": "^(2\\d{3}0?[1-9]|1[012])$",
"securityCode": "^[0-9]{3,4}$",
"name": "^(?!\\s*$)[-a-zA-Z' ''.']{1,}$",
"email": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$",
"additional": {
"cardNo": {
"luhn": true,
"prefixes": ["525669", "540474", "455293", "409337", "409346", "409345", "528560", "525670", "525667", "544572", "450579", "450580", "450578", "552165", "543673", "499960", "434940", "499959", "455296", "454186", "523913", "542380", "455287", "455205"]
},
"amount": null
}
},
"info": {
"terms": "Demo terms and conditions",
"promoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/ipppromologo/45.png?v=200918030737",
"plans": [{
"sequenceNo": 1,
"period": 3,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 3.33333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "3 months with 0% interest (monthly installment amount 3.33 THB)"
}, {
"sequenceNo": 2,
"period": 6,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.66667,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "6 months with 0% interest (monthly installment amount 1.67 THB)"
}, {
"sequenceNo": 3,
"period": 9,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.11111,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "9 months with 0% interest (monthly installment amount 1.11 THB)"
}, {
"sequenceNo": 4,
"period": 12,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 0.83333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "12 months with 0% interest (monthly installment amount 0.83 THB)"
}]
}
},
"isDown": false
}, {
"sequenceNo": 4,
"name": "Thanachart Bank",
"currencyCodes": ["THB"],
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/TBANK.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/TBANK.png",
"payment": {
"code": {
"channelCode": "IPP"
},
"input": {
"cardNo": "M",
"expiryDate": "M",
"securityCode": "M",
"name": "O",
"email": "O"
},
"validation": {
"cardNo": null,
"expiryDate": "^(2\\d{3}0?[1-9]|1[012])$",
"securityCode": "^[0-9]{3,4}$",
"name": "^(?!\\s*$)[-a-zA-Z' ''.']{1,}$",
"email": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$",
"additional": {
"cardNo": {
"luhn": true,
"prefixes": ["414155", "511355", "414167", "512445", "454623"]
},
"amount": null
}
},
"info": {
"terms": "NA",
"promoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/ipppromologo/22.png?v=200918030737",
"plans": [{
"sequenceNo": 1,
"period": 3,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 3.33333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "3 months with 0% interest (monthly installment amount 3.33 THB)"
}, {
"sequenceNo": 2,
"period": 6,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.66667,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "6 months with 0% interest (monthly installment amount 1.67 THB)"
}]
}
},
"isDown": false
}, {
"sequenceNo": 5,
"name": "United Overseas Bank",
"currencyCodes": ["THB"],
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/UOB.png",
"logoUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/logo/UOB.png",
"payment": {
"code": {
"channelCode": "IPP"
},
"input": {
"cardNo": "M",
"expiryDate": "M",
"securityCode": "M",
"name": "O",
"email": "O"
},
"validation": {
"cardNo": null,
"expiryDate": "^(2\\d{3}0?[1-9]|1[012])$",
"securityCode": "^[0-9]{3,4}$",
"name": "^(?!\\s*$)[-a-zA-Z' ''.']{1,}$",
"email": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$",
"additional": {
"cardNo": {
"luhn": true,
"prefixes": ["543215", "403375"]
},
"amount": null
}
},
"info": {
"terms": "&lt;a href=&quot;http://www.uob.com.sg/assets/pdfs/personal/cards/zeroinstaltnc.pdf&quot; &gt;Terms and condition\n&lt;/a&gt;",
"promoUrl": "https://pgw-static-sandbox.s3.amazonaws.com/images/ipppromologo/17.png?v=200918030737",
"plans": [{
"sequenceNo": 1,
"period": 9,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 1.11111,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "9 months with 0% interest (monthly installment amount 1.11 THB)"
}, {
"sequenceNo": 2,
"period": 12,
"interestType": "M",
"interestRate": 0.0,
"monthlyAmount": 0.83333,
"monthlyInterest": 0.00000,
"currencyCode": "THB",
"label": "12 months with 0% interest (monthly installment amount 0.83 THB)"
}]
}
},
"isDown": false
}],
"validation": {
"cardNo": {
"prefixes": ["455596", "543449", "438679", "510511", "540522", "544485", "444433", "414114", "478825", "411111", "525669", "540474", "455293", "409337", "409346", "409345", "528560", "525670", "525667", "544572", "450579", "450580", "450578", "552165", "543673", "499960", "434940", "499959", "455296", "454186", "523913", "542380", "455287", "455205", "414155", "511355", "414167", "512445", "454623", "543215", "403375"],
"regex": null
},
"cardTypes": [{
"sequenceNo": 1,
"name": "MasterCard",
"prefixes": ["51", "52", "53", "54", "55", "2221", "2222", "2223", "2224", "2225", "2226", "2227", "2228", "2229", "223", "224", "225", "226", "227", "228", "229", "23", "24", "25", "26", "270", "271", "2720"],
"regex": "^(?:5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|27[01][0-9]|2720)[0-9]{12}$",
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/master.png"
}, {
"sequenceNo": 2,
"name": "VISA",
"prefixes": ["4"],
"regex": "^4[0-9]{12}(?:[0-9]{3})?$",
"iconUrl": "https://d27uu9vmlo4gwh.cloudfront.net/images/v4/images/icon/visa.png"
}]
},
"configuration": {
"payment": {
"tokenize": false,
"tokenizeOnly": false,
"cardTokenOnly": false,
"immediatePayment": false
},
"notification": {
"facebook": false,
"whatsApp": false,
"line": false
}
},
"respCode": "0000",
"respDesc": "Success"
}
Â
8. Prepare Do Payment Request
Merchants must call the Do Payment API to request for payment. To prepare a payment request, refer to the sample payment request below.
Pre Requisite : |
|---|
|
|
|
|
Please refer to: Do Payment API Request
{
"responseReturnUrl": "https://sandbox-pgw-ui.2c2p.com/payment/4.1/#/info/",
"payment": {
"code": {
"channelCode": "IPP"
},
"data": {
"name": "Terrance",
"email": "[email protected]",
"securePayToken": "00ace3GRc+EOFUi+C/fHd75L/I8h2TRYtutp0qomqDCXVqvhA7jlPTjfYbPaPMl/B/KowbDKzcAgMBZNOoDJ7QmBXsVLt5OBigJEF7aL5MAfcdvVfM4oAKHRSMAL/s+WD2iob+REFlrLs7NkOT7RdeiH5cAbeefoiWXLZKx0D1qIj0o=U2FsdGVkX18TKwyJU+VsKHg/2IIVxTFz72sQUeGjCH0vkUWCLSwZ9qY17q3V3JFT",
"installmentPeriod": 12,
"interestType": "M"
}
},
"clientIP": "175.143.223.174",
"paymentToken": "kSAops9Zwhos8hSTSeLTURPZNO23dVLrwizwXE1u9XEO9Fhcnss6KvEzhz/NDuThz55NVdN3M3e151hhLHTR+jtX5MWEAio4JP4L929ugHo=",
"locale": "en",
"clientID": "30c7cf51-75c4-4265-a70a-effddfbbb0ff"
}
Â
9. Receive Do Payment Response
To receive a payment response, refer to the the sample payment response below.
Please refer to: Do Payment API Response
{
"data": "https://demo2.2c2p.com/2C2PFrontEnd/storedCardPaymentV2/MPaymentProcess.aspx?token=VZ/cZVaoCXJBOyZvkOUhfJqhePKURplxziSz6TN63zWyIuLKT/swJEfcwA4jgqs5",
"channelCode": "IPP",
"respCode": "1001",
"respDesc": "Redirect to authenticate ACS bank page."
}
Â
10. Redirect to Third Party Processor
Redirect to the appropriate third party processor via browser. The third party processor details are returned through the following parameters from the Do Payment API response. **Failure or rejection of the call for the respCode parameter will terminate the process.**
| parameter from Do Payment Response | Description |
|---|---|
| data | Third party URL endpoint |
| respCode | Indicates redirection method. For more details, refer to Payment Process Flow |
Â
11. Receive Payment Response via backend API
Please refer to: 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": "JT04",
"invoiceNo": "180920100648",
"cardNo": "411111XXXXXX1111",
"amount": 10.0,
"currencyCode": "THB",
"cardToken": "",
"recurringUniqueID": "",
"tranRef": "3250489",
"referenceNo": "3129571",
"approvalCode": "487126",
"eci": "05",
"transactionDateTime": "20200918101905",
"agentCode": "KTC",
"channelCode": "VI",
"issuerCountry": "US",
"installmentPeriod": 12,
"interestType": "M",
"interestRate": 1.0,
"installmentMerchantAbsorbRate": 0.0,
"respCode": "0000",
"respDesc": "Success"
}
Â
12. 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 customers 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 the 2C2P merchant portal by default. Refer to the sample response returned below.
{
"invoiceNo": "180920100648",
"channelCode": "CC",
"respCode": "2000",
"respDesc": "Transaction is completed, please do payment inquiry request for full payment information."
}
Â
13. Payment Inquiry to retrieve payment information
For merchants who do not implement "Receive Payment Response via backend API", you are required to call to the Payment Inquiry API to receive the payment response.
To prepare a payment inquiry request, refer to the sample payment inquiry request below.
Please refer to: Payment Inquiry API Request
{
"merchantID": "JT04",
"invoiceNo": "180920100648",
"locale": "en"
}
Â
14. Receive Payment Inquiry Response
To receive a payment inquiry response, refer to the sample payment inquiry response below.
Please refer to: Payment Inquiry API Response
{
"merchantID": "JT04",
"invoiceNo": "180920100648",
"cardNo": "411111XXXXXX1111",
"amount": 10.0,
"currencyCode": "THB",
"cardToken": "",
"recurringUniqueID": "",
"tranRef": "3250489",
"referenceNo": "3129571",
"approvalCode": "487126",
"eci": "05",
"transactionDateTime": "20200918101905",
"agentCode": "KTC",
"channelCode": "VI",
"issuerCountry": "US",
"installmentPeriod": 12,
"interestType": "M",
"interestRate": 1.0,
"installmentMerchantAbsorbRate": 0.0,
"respCode": "0000",
"respDesc": "Success"
}
Updated almost 2 years ago