---
description: KICC payment window integration guide
---

# KICC

### 1. Configure KICC PG settings

Refer to the [**KICC settings**](../../ready/2.-pg/payment-gateway-settings/kicc) page to configure the PG settings.

![](https://2814812280-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTv8JEzyM5h4cYcL5StH%2Fuploads%2FjdBXNC6q7VbR3MhQW9Yv%2F%E1%84%89%E1%85%B3%E1%84%8F%E1%85%B3%E1%84%85%E1%85%B5%E1%86%AB%E1%84%89%E1%85%A3%E1%86%BA%202022-06-03%20%E1%84%8B%E1%85%A9%E1%84%92%E1%85%AE%204.54.05.png?alt=media\&token=f76b39f8-f38b-4e40-aeae-1288e7f72540)

### 2. Request payment

To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk) IMP.**request\_pay**(param, callback).

In PC browsers, <mark style="color:red;">**callback**</mark> is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to <mark style="color:red;">**m\_redirect\_url**</mark>.

{% tabs %}
{% tab title="Authenticated payment request" %}
{% code title="Javascript SDK" %}
```javascript
IMP.request_pay({
    pg : 'kicc',
    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... *//
});
```
{% endcode %}

####

#### Key parameter description

**`pg`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:green;">**string**</mark>

**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 **`kicc`**.

**`pay_method`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:green;">**string**</mark>

**Payment method code**

<details>

<summary>Payment method codes</summary>

* `card` (credit card)
* `trans`(instant account transfer)
* `vbank`(virtual account)
* `phone`(mobile micropayment)

</details>

**`merchant_uid`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:green;">**string**</mark>

**Order ID**

Must be unique for each request.

**`buyer_tel`**<mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

**Customer phone number**

**`amount`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:purple;">**integer**</mark>

**Payment amount**

Must be an integer (not string)

**` escrow`` `` `**<mark style="color:orange;">**`boolean`**</mark>

**Escrow option**

Only supports account transfer and virtual account payment.

{% embed url="https://codepen.io/chaiport/pen/YzevrGz" %}
{% endtab %}

{% tab title="Non-authenticated payment request" %}
To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.

{% code title="Javascript SDK" %}
```javascript
IMP.request_pay({
    pg : 'kicc',
    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');
	}
});
```
{% endcode %}



{% hint style="info" %}
* To request non-authenticated payment, you must set the **MID info issued by KICC** in the Admin console.
* KICC <mark style="color:red;">**does not process the payment**</mark> when issuing the billing key even if you specify an amount.
{% endhint %}

#### Key parameter description

**`pg`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:green;">**string**</mark>

**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 **`kicc.[billing MID]`**.

**`customer_uid`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:green;">**string**</mark>

**Credit card billing key**

Billing key to be mapped 1:1 with the user-entered credit card information.

**`amount`** <mark style="color:red;">**\***</mark>\*\* \*\*<mark style="color:purple;">**Integer**</mark>

**Payment amount**

Amount to display in the payment window, but <mark style="color:red;">actual payment approval is not processed.</mark> (To request payment, use the **REST API with the customer\_uid**.)\\

#### Request payment with billing key (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 [<mark style="color:blue;">**non-authenticated payment request REST API**</mark>](../../api/api/api) with the `customer_uid` as follows:

{% code title="sever-side" %}
```
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
```
{% endcode %}
{% endtab %}

{% tab title="Non-authenticated API  request" %}
**Not supported.**
{% endtab %}
{% endtabs %}

### 3. Additional functions

{% tabs %}
{% tab title="Escrow setting" %}
KICC supports escrow payments only for **cash payment methods** (instant account transfer or virtual bank account).

> To enable escrow payment, first set the following parameters and then configure additional parameters below.
>
> * **escrow : true**

#### Additional parameters

When making an escrow payment, you must enter the following required parameters:

* `buyer_name` : Customer name
* `buyer_email` : Customer email
* `buyer_tel` : Customer phone number
* `kiccProducts` : An array of objects consisting of the following 4 required properties. The `amount` value has no relation to the payment amount (`param.amount`) value and is not used for comparison.
  * `orderNumber` : Product order number
  * `name` : Product name
  * `quantity` : Quantity
  * `amount` : Product price

{% code title="JavaScript SDK" %}
```javascript
IMP.request_pay({
   ...
   escrow : true, // Required for escrow payment
   kiccProducts : [
    	       {
			"orderNumber" : "xxxx",
			"name" : "Product A",
			"quantity" : 3,
			"amount" : 1000
		},
		{
			"orderNumber" : "yyyy",
			"name" : "Product B",
			"quantity" : 2,
			"amount" : 3000
		}
	       ]
    ...
}, function(rsp) { // callback logic
	//* ...Omitted ... *//
});
```
{% endcode %}
{% endtab %}

{% tab title="Direct credit card module call" %}
{% code title="javascript" %}
```javascript
card: {
     direct: {
        code: "367",
        quota: 3
    }
}
```
{% endcode %}

**Parameters**

* **code**: [<mark style="color:red;">**Credit card code**</mark>](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
* **quota**: Installment plan. For immediate, set to 0. (**integer**)

{% hint style="danger" %}
**Precautions**

* Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
{% endhint %}
{% endtab %}

{% tab title="Enable specific credit cards" %}
{% code title="javascript" %}
```javascript
card : {
    detail : [
        {card_code:"*", enabled:false},     // Disable all credit cards
        {card_code:'366', enabled:true}     // Enable specific credit card
    ]
}
```
{% endcode %}

**Parameters**

* **card\_code:** [<mark style="color:red;">**Credit card code**</mark>](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (<mark style="color:green;">**string)**</mark>
* **enabled:** Option to enable the credit card (<mark style="color:orange;">**boolean)**</mark>

{% embed url="https://codepen.io/chaiport/pen/MWQKdVo" %}
**Example of enabling only&#x20;**<mark style="color:red;">**Shinhan Card**</mark>**&#x20;payment window**
{% endembed %}
{% endtab %}
{% endtabs %}
