<!-- jQuery -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.12.4.min.js" ></script>
<!-- iamport.payment.js -->
<script type="text/javascript" src="https://cdn.iamport.kr/js/iamport.payment-{SDK-latest-version}.js"></script>
Property* Required | Type(Default value) | Description |
---|---|---|
pg (Supported from v1.1.0) | string | Identifies a PG when using multiple PGs with one i'mport account If this is missing or there is no matching PG, the default PG set in the Admin Console is called Format: [PG service code] or [PG service code].[PG merchant ID]PG Service Codes
|
pay_method * | string(card) | Payment methodOptions
|
escrow | boolean(false) | Option to open escrow payment page |
merchant_uid * | string | Unique order ID generated/managed by the merchant You cannot use a merchant_uid that has already been approved (status: paid) for another payment
|
name | string | Order nameInput is recommended for seamless payment information check Recommended length: 16 characters (varies by PG) |
amount * | number | Payment amount |
custom_data | object | Additional order information specified by merchantSaved as json notation (string) |
tax_free | number | Tax free amount (out of amount )More on tax exemptions |
vat | amount )tax_free property for more accurate calculations. | |
currency | string(KRW) | Currency For PayPal, USD is the default value as PayPal does not support KRW For currencies supported by PayPal: PayPal Supported CurrenciesOptions
|
language | string(ko) | Language for payment page
|
buyer_name | string | Buyer name |
buyer_tel * | string | Buyer phone (some PGs throw an error if this is not specified) |
buyer_email | string | Buyer email |
buyer_addr | string | Buyer address |
buyer_postcode | string | Buyer postal code |
notice_url | string /array of string | URL to use instead of Notification URL set in Admin Console Use this property to set different or multiple Notification URLs for each order |
display | object | Display settings for payment window |
Property* Required | Type(Default value) | Description |
---|---|---|
card_quota | array of integer | Installment plan option for KRW 50,000 or more
|
Property* Required | Type(Default value) | Description |
---|---|---|
digital | boolean(false) | Option to specify the product as digital content (required for mobile micropayment) You must accurately distinguish contents and tangible products |
vbank_due | string | Due date(YYYYMMDDhhmm ) to deposit payment to virtual account |
m_redirect_url | string | URL to redirect to after payment is complete (in redirection mode) |
app_scheme | string | URL scheme for returning to the app during mobile app payment (required for WebView payment) Used to return to the original app after verifying payment information in the ISP/app card app |
biz_num | string | Registered business registration number (10-digit without symbols)Required for Danal-Virtual Account payments |
function (rsp) { ... }
The function that is called after payment is complete in a payment window implemented in Iframe.Properties by PG/Payment Method
i'mport policy for adding response fields
Property* Required | Type | Description | |
---|---|---|---|
success *(returned as imp_success for some PG/payment method) | boolean | Whether or not the payment succededTrue when payment is approved or virtual account is issued | |
error_code * | string | Short error message when payment fails (currently no code system available) | |
error_msg * | string | Detailed error message when payment fails | |
imp_uid * | string | Unique i'mport payment IDThis may be null if success is false and verification fails | |
merchant_uid * | string | Unique order ID generated/managed by the merchant | |
pay_method | string | Payment methodOptions
| |
paid_amount | number | Paid amountApproved amount or amount to deposit to virtual account | |
status | string | Payment statusOptions
| |
name | string | Order name | |
pg_provider | string | PGOptions
| |
emb_pg_provider | string | Payment approved PG when simple payment is requested from payment window | Simple payment PG selected in the payment window ( Naver Pay, Kako Pay, Payco, Samsung Pay, SSG Pay, L.pay, Kpay ) when pay_method = card in KG Inicis or NHN KCP |
pg_tid | string | Unique PG transaction ID | |
buyer_name | string | Buyer name | |
buyer_email | string | Buyer email | |
buyer_tel | string | Buyer phone | |
buyer_addr | string | Buyer address | |
buyer_postcode | string | Buyer postal code | |
custom_data | object | Additional order information specified by the merchant | |
paid_at | number | Payment approved time (UNIX timestamp) | |
receipt_url | string | URL for sales slip issued by PG |
Property | Type | Description |
---|---|---|
apply_num | string | Credit card approval ID (for credit card only) |
vbank_num | string | Virtual account number May include dash (-) or other symbols (shown as is from PG) |
vbank_name | string | Virtual account bank |
vbank_holder | string | Shown as the contracted business name. Null may be returned by some PGs (requires manual processing). |
vbank_date | number | Due date to deposit to virtual account (UNIX timestamp) |
Property* Required | Type(Default value) | Description |
---|---|---|
merchant_uid (Supported from v1.1.4) | string | Unique order ID generated/managed by the merchant |
min_age (Supported from v1.1.4) | number | Minimum age allowed (based on date of birth) |
name (Supported from v1.1.4) | string | Customer name Auto entered in the name field of the verification window |
phone (Supported from v1.1.4) | string | Customer mobile phone (includes delimiters, such as - or . ) Auto entered in the phone field of the verification window |
carrier (Supported from v1.1.4) | string | Mobile carrier Mobile carrier options for the verification windowOptions
|
birth (Supported from v1.1.4) | YYYYMMDD ), such as 19821231 or 1982-12-31 . | |
company (Supported from v1.1.4) | string(URL where this function is called from) | Service domain URL or name
|
m_redirect_url (Supported from v1.1.7) | string | URL to redirect to after verfication is complete in mobile imp_uid , merchant_uid and success are appended as query string to the redirect URL |
popup (Supported from v1.1.7, mobile only) | boolean(false) | Option to open verification page in a popup window PC: forcibly set to popup : true Mobile: if you set popup : false , you must specify m_redirect_url |
function (rsp) { ... }
The function that is called after verification is complete in an identity verification window implemented in Iframe.Property* Required | Type | Description |
---|---|---|
success * | boolean | Whether or not the verification succededtrue/false |
error_code * | string | Short error message when verification fails (currently no code system available) |
error_msg * | string | Detailed error message when verification fails |
imp_uid * | string | Unique i'mport verification ID |
merchant_uid * | string | Unique order ID generated/managed by the merchant |