⌨ī¸KICC

KICC payment window integration guide

1. Configure KICC PG settings

Refer to the KICC settings page to configure the PG settings.

2. Request payment

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.

Javascript SDK
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... *//
});

Key parameter description

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

pay_method *** **string

Payment method code

Payment method codes
  • card (credit card)

  • trans(instant account transfer)

  • vbank(virtual account)

  • phone(mobile micropayment)

merchant_uid *** **string

Order ID

Must be unique for each request.

buyer_tel*string

Customer phone number

amount *** **integer

Payment amount

Must be an integer (not string)

escrow`` boolean

Escrow option

Only supports account transfer and virtual account payment.

3. Additional functions

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

JavaScript SDK
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 ... *//
});

Last updated