IMP.request_pay - param, rsp Object

The general payment processes can be started by calling IMP.request_pay(param, callback) function in the Iamport JavaScript library. At this point, you can request a payment with desired contents and write a post payment logic using param and callback arguments of the function.

param object
rsp object in callback function

`param` object

The JavaScript object is specified as the first argument of the IMP.request_pay() function. This is called param, and it will contain the information needed for the payment approval. You can specify various information required for payment, such as which customers are placing an order, what amount is paid for which product, and what the order number is, in predefined properties.

`param` object properties

Common properties

Property	Data type	Description	Defaut	Misc
`pg` (Supported from v1.1.0)	string	The identifier when using multiple PGs with one Iamport account.	undefined	(Optional) If it is missing or does not match, the "default PG" set in the Iamport Admin page is called. Specify only the PG name, such as `kakaopay` and `html5_inicis` Specify PG name.merchant ID such as `html5_inicis.INIpayTest` `html5_inicis`(Inicis web standard) `inicis`(Inicis ActiveX payment window) `kcp`(NHN KCP) `kcp_billing`(NHN KCP recurring payments) `uplus`(LGU+) `nice`(NICE Pay) `jtnet`(JTNet) `kicc`(KICC) `bluewalnut`(BlueWalnut) `kakaopay`(KakaoPay) `danal`(Danal mobile micropayment) `danal_tpay`(Danal general payment) `mobilians`(Mobilians Mobile micropayment) `chai`(CHAI simple payment) `syrup`(Syrup Pay) `payco`(PAYCO) `paypal`(PayPal) `eximbay`(Eximbay) `naverpay`(Naver Pay - payment type) `naverco`(Naver Pay - on demand) `smilepay`(Smilepay) `alipay`(Alipay)
`pay_method`	string	Payment method	card	`card`(credit card) `trans`(real-time account transfer) `vbank`(virtual account) `phone`(mobile micropayment) `samsung`(Samsung Pay / Inicis, KCP only) `kpay`(Direct call to KPay app / Inicis only) `cultureland`(Culture Voucher / Inicis, LGU+, KCP only) `smartculture`(Smart Culture Voucher / Inicis, LGU+, KCP only) `happymoney`(Happy Money / Inicis, KCP only) `booknlife`(Book Culture Gift Certificate / LGU+, KCP only)
`escrow`	boolean	Escrow enabled	false	(Optional) Call the escrow enabled payment window
`merchant_uid`	string	Unique order number created/managed by the merchant	random	(Required) Repayment is not possible with merchant_uid that has been used
`name`	string	Order name	undefined	(Optional) Recommended for better payment information verification (although there are differences among PG companies). It is also recommended to specified within 16 characters.
`amount`	number	Amount to pay	undefined	(Required)
`custom_data`	object	Extra data defined by the merchant	undefined	(Optional) Used when space is required to store additional information for the order. Stored as json notation (string)
`tax_free`	number	Tax-free amount of the payment	undefined	(Optional) Specify the tax-free amount. Specify the tax-free amount of the payment. more
`vat`	number	VAT of the payment	undefined	(Deprecated) It is recommended to use tax_free parameter for more accurate calculation when applying composite tax. Specify the amount of VAT. Regardless of VAT, the amount means the total amount to be paid by the customer.
`currency`	string	Currency unit	KRW (USD is the default for PayPal)	(Optional) KRW / USD / EUR / JPY. Note: Due to the PayPal policy, KRW is not supported. USD is applied instead as default
`language`	string	The language of the payment window	ko	(Optional) Set the language of the payment window screen provided to buyers KG Inicis, LGU+, Nice Payments: following values can be used `en` or `ko` (KG Inicis and Nice Payments only support it in PC payment window) For Paypal, a 2-digit code is used (see PayPal language setting code)
`buyer_name`	string	Buyer name	undefined	(Optional)
`buyer_tel`	string	Buyer contact	undefined	(Required) Some PGs generate errors when the value is missing or blank
`buyer_email`	string	Buyer e-mail	undefined	(Optional)
`buyer_addr`	string	Buyer address	undefined	(Optional)
`buyer_postcode`	string	Buyer postal code	undefined	(Optional)
`notice_url`	string / array of string	Notification URL	undefined	(Optional) This can overwrite the Notification URL set in Iamport Admin page. Used when a different Notification URL is required for every order or when multiple Notification URLs are required
`display`	object	Payment windows related option	undefined	(Optional) UI option for the payment window provided to buyers

`display` object properties

Property	Data type	Description	Defaut	Misc
`card_quota`	array of integer	UI option to select the installment payment plan	undefined	(Optional) UI control to display the list of installment payments in the payment window of PG when the amount is 50,000 won or bigger. If `undefined`, the list of installment payments provided by PG is displayed. If `[]`, only one-time payment is possible If `2, 3, 4, 5, 6`, installment can be selected up to 2, 3, 4, 5, 6 months including one-time payment. Only supported by KG Inicis and KCP

Additional properties - properties required only for special conditions

Property	Data type	Description	Defaut	Misc
`digital`	boolean	Whether the payment product is content	false	(Optional) Required for mobile micropayment Tangible products and contents must be clearly distinguished.
`vbank_due`	string	Virtual account payment expiration date	undefined	(Optional) `YYYYMMDDhhmm` format
`m_redirect_url`	string	URL to be redirected after mobile payment	undefined	(Optional) Used only for mobile payment
`app_scheme`	string	URL scheme for app return during mobile app payment	undefined	(Optional) Required for payments in WebView. Used to return to the original app from App card or ISP apps the payment if verified.
`biz_num`	string	Business registration number in 10 digits (without symbols)	undefined	(Optional) Must be set when paying with Danal-Virtual account

`rsp` object in `callback` function

JavaScript function is specified as the second argument of the IMP.request_pay() function. This is called a callback function and is a function that is called after the payment process is completed. When the function is called, it takes rsp object as an argument that contains payment result information. From the object, you can check information such as whether the payment was successful, payment error messages, and the payment approval time.

`rsp` object properties

Basic properties

rsp property	Data type	Description	Misc
`success`	boolean	Whether payment was successfully processed	True if the actual payment approval has been made or the virtual account is successfully issued
`error_code`	string	Shortened message if payment fails	No code system at the moment
`error_msg`	string	Detailed message when payment fails
`imp_uid`	string	Unique transaction number in Iamport	Unique number per transaction granted by Iamport (when "success" is false, imp_uid may be null if pre-validation fails)
`merchant_uid`	string	Unique order number created/managed by the merchant
`pay_method`	string	Payment method	`card`(credit card), `trans`(real-time account transfer), `vbank`(virtual account), `phone`(mobile micropayment)
`paid_amount`	number	Amount paid	Actual amount of approved payment or the amount to be transfer to the virtual account
`status`	string	Payment status	`ready`(unpaid), `paid`(payment completed), `cancelled`(payment cancellation, including partial cancellation), `failed`(payment failed)
`name`	string	Order name
`pg_provider`	string	Payment approved/attempted PG company	`html5_inicis`(KG Inicis for web standard), `inicis`(KG Insis for general payments), `kakaopay`(KakaoPay), `uplus`(LGU+), `nice`(NICE), `jtnet`(JTNet), `danal`(Danal)
`pg_tid`	string	PG unique transaction number
`buyer_name`	string	Buyer name
`buyer_email`	string	Buyer e-mail
`buyer_tel`	string	Buyer contact
`buyer_addr`	string	Buyer address
`buyer_postcode`	string	Buyer postal code
`custom_data`	object	Extra data defined by the merchant
`paid_at`	number	Payment approval time	UNIX timestamp
`receipt_url`	string	URL of transaction sales slip issued by PG company	The sales slip can be found by opening the received URL.

Additional properties

rsp property	Data type	Description	Misc
`apply_num`	string	Approval number from card companies	Credit card payment only
`vbank_num`	string	Virtual account number	Since information provided directly from PG, it may include hyphen(-) or other symbols between the numbers.
`vbank_name`	string	Virtual account bank name
`vbank_holder`	string	Virtual account holder	Contracted business name. It is always the same. However, null handling is required for some PGs that return null.
`vbank_date`	number	Virtual account payment expiration date	UNIX timestamp

IMP.request_pay - param, rsp Object

param object

param object properties