⌨️KG INICIS
KG INICIS payment window integration guide
Last updated
KG INICIS payment window integration guide
Last updated
Refer to the KG INICIS settings page to configure the PG settings.
To open the payment window, call JavaScript SDK IMP.request_pay(param, callback).
In PC browsers, callback is invoked after calling IMP.request_pay(param, callback)
. In mobile browsers, the page is redirected to m_redirect_url.
Parameters
card_quota :
[]
: Only immediate pay
If not specified and this is the only PG setting that exists, default PG
is automatically set.
If there are multiple PG settings, set to html5_inicis
.
pay_method
* string
Payment method code
merchant_uid
* string
Order ID
Must be unique for each request.
amount
* integer
Payment amount
Must be an integer (not string)
buyer_tel
*
string
Customer phone number
Required
amount
parameter is for display purpose only. Actual payment approval is not processed.
pg
* string
PG code
If not specified and this is the only PG setting that exists, default PG
is automatically set.
If there are multiple PG settings, set to html5_inicis
.
If you have multiple merchant IDs (each for general and subscription) issued by KG INCIS, set to
html5_inicis.{Merchant ID}
orinicis.{Merchant ID}
(for ActiveX).
customer_uid
* string
Credit card billing key
Billing key to be mapped 1:1 with the user-entered credit card information.
amount
* Integer
Payment amount
Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the REST API with the customer_uid.)
After successfully getting the billing key, the billing key is stored on the i'mport server mapped 1:1 with the specified customer_uid
. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the non-authenticated payment request REST API with the customer_uid
as follows:
To request a billing key, use the billing key request REST API POST /subscribe/customers/{customer_uid}.
To request a billing key and initial payment, use the key-in REST API POST /subscribe/payments/onetime.
customer_uid
: required for saving the billing key.
After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified customer_uid
. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API (POST /subscribe/payments/again) with the customer_uid
as follows:
For detailed information, refer to:
2,3,4,5,6
: immediate, 2, 3, 4, 5, 6 month installment plans
IMP.request_pay({
pg : 'html5_inicis',
pay_method : 'card',
merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
name : 'Order name: Test payment request',
amount : 14000,
buyer_email : 'iamport@siot.do',
buyer_name : 'John Doe',
buyer_tel : '010-1234-5678',
buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
buyer_postcode : '123-456',
m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
}, function(rsp) { // callback logic
//* ...Omitted... *//
});
curl -H "Content-Type: application/json" \
-X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/onetime
display: {
card_quota: [6] // Display up to 6 months installment plans
}
card: {
direct: {
code: "367",
quota: 3
}
}
card : {
detail : [
{card_code:"*", enabled:false}, // Disable all credit cards
{card_code:'366', enabled:true} // Enable specific credit card
]
}
IMP.request_pay({
pg : 'html5_inicis',
pay_method : 'card', // only 'card' supported.
merchant_uid : '{Merchant created Order ID}', // Example: issue_billingkey_monthly_0001
name : 'Initial billing key request',
amount : 0, // For display purpose only (no payment approval).
customer_uid : '{Unique ID for the card (billing key)}', // Required (Example: gildong_0001_1234)
buyer_email: "johndoe@gmail.com",
buyer_name: "John Doe",
buyer_tel : '02-1234-1234',
m_redirect_url : '{redirect URL}' // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
}, function(rsp) {
if ( rsp.success ) {
alert('Success');
} else {
alert('Failed');
}
});
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/again
curl -H "Content-Type: application/json" \
-X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
https://api.iamport.kr/subscribe/customers/your-customer-unique-id
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/onetime
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/again