LogoLogo
  • 🧩i'mport Payment Integration Docs
    • 🚗GET STARTED
  • 🛫Setup
    • 🖥️1. Create an account
    • 🧷2. Set up PG
      • 🏢Payment gateway settings
        • ⌨️NHN KCP
        • ⌨️KG INICIS
        • ⌨️NICE Payments
        • ⌨️Toss Payments
        • ⌨️KICC
        • ⌨️Paymentwall
        • ⌨️Daou
        • ⌨️다날 설정
        • ⌨️JTNET 설정
        • ⌨️세틀뱅크 설정
        • ⌨️KG모빌리언스 설정
        • ⌨️스마트로 설정
        • ⌨️페이팔 설정
        • ⌨️엑심베이 설정
        • ⌨️블루월넛 설정
      • ⛺간편 결제사
        • ⌨️카카오페이 설정
        • ⌨️토스간편결제 설정
        • ⌨️네이버페이(결제형) 설정
        • ⌨️페이코 설정
        • ⌨️차이 설정
        • ⌨️알리페이 설정
    • ✔️3. Check required info
  • Payment window
    • 🖥️Authenticated payment
      • 📒Definition
      • 🌠1. Add i'mport library
      • 💡2. Initialize IMP object
      • 🪧3. Request payment
      • 🎁4. Process payment result
        • 🪟Iframe method
        • 🖼️Redirect method
      • 🔦5. Verify payment information
      • 🛬6. Complete payment
    • ⏰Non-authenticated payment
      • 🏍️Request billing key payment
        • 🖱️REST API
        • 🛡️PG window
      • 💳Key-in payment using card info
      • 🪧Subscription payment using billing key
    • 💸Payment cancellation (refund)
      • 💷Virtual account refund
  • Payment result
    • ⚒️Set up a webhook
  • Other Services
    • 📱Mobile identity verification
      • 📔1. Prepare for verification
      • 🥏2. Request verification
      • 🚚3. Send verification result
      • 🤹4. Get verification info
    • 🚚Integrated identity verification
      • 📒Prepare for verification
      • 🥏Request verification
      • 🚚Send verification result
      • 🤹Get verification info
    • 💳Credit card identity verification
      • 📒1. Prepare for verification
      • 🥏2. Request verification
      • 🚚3. Send verification result
      • 🤹4. Get verification info
    • 💻Generate payment URL
    • 🛩️Integrate budget handler
    • 📟Native mobile SDKs
  • TIPS
    • 🌽Tax exemption on payments
    • ✅Service launch checklist
    • 🔏Confirm Process
    • 🎼i'mport payment flow
    • 🎈Agency & Tier
    • 📦Billing key issuance by PG
    • 🏦Bank codes by PG
    • 🧾PG codes
    • 🚚Courier codes
    • 🪧What is redirection?
    • 📰PG error codes
  • Admin console
    • 🎡Admin console guide
      • Apply for online payment
      • My ID & API keys
      • Manage admin & sub-merchant accounts
      • Integrate payment
      • Payment activity
    • 💻Integrating Multiple PGs
  • API
    • 📋i'mport API overview
    • 🖇️REST API Access Token
    • 💳Payment API
      • ⌨️Cancel payment API
      • ⌨️Get payment API
      • ⌨️Get payments API
      • ⌨️Get payments by status API
      • ⌨️Get payments by order ID, status (All)
      • ⌨️Get payments by order ID, status (Top 1)
      • ⌨️Get balance API (for split payment transaction)
      • ⌨️Get payments by billing key API
      • ⌨️Save payment amount API
      • ⌨️Update payment amount API
      • ⌨️Get payment amount API
    • 📝Billing key API
      • ⌨️Request billing key API
      • ⌨️Delete billing key API
      • ⌨️Get billing key API
      • ⌨️Get billing keys API
      • ⌨️Get scheduled payments API
    • 🧭Subscription payment API
      • ⌨️Schedule payment API
      • ⌨️Cancel scheduled payment API
      • ⌨️Get scheduled payments API
      • ⌨️Get scheduled payment API
      • ⌨️Get scheduled payments by billing key API
    • 🪂Non-authenticated payment API
      • ⌨️Request non-authenticated payment (billing key) API
      • ⌨️Request non-authenticated payment (one-time) API
    • 🇺🇲🇺🇲 Overseas PG API
      • ⌨️Paymentwall delivery API
    • 👮‍♂️👮♂ Identity verification API
      • ⌨️Get identity verification result API
      • ⌨️Delete identity verification API
      • ⌨️Request identity verification API
      • ⌨️Confirm identity verification API
    • 🎫Simple payment service API
      • 🧽Kakao Pay
        • ⌨️Get order API
      • 🛩️KCP Quick Pay
        • ⌨️Delete user API
      • 🧰PAYCO
        • ⌨️Update order status API
      • 📗Naver Pay
        • ⌨️Confirm escrow order API
        • ⌨️Accrue points API
        • ⌨️Get cash receipt amount API
    • 🏦Escrow API
      • ⌨️Get delivery info API
      • ⌨️Add delivery info API
      • ⌨️Update delivery info API
    • 💵Cash receipt API
      • ⌨️Cancel cash receipt transaction API
      • ⌨️Get cash receipt API
      • ⌨️Request cash receipt API
      • ⌨️Cancel cash receipt (external) API
      • ⌨️Get cash receipt (external) API
      • ⌨️Request cash receipt (external) API
    • 🏛️Virtual account API
      • ⌨️Request virtual account API
      • ⌨️Cancel virtual account API
      • ⌨️Update virtual account API
      • ⌨️Get account holder API
    • 🍶Miscellaneous API
      • 🎽Benepia point
        • ⌨️Get points API
        • ⌨️Request point payment API
      • 🏪Convenience store payment
        • ⌨️Request barcode API
        • ⌨️Cancel barcode API
      • 🗃️Financial institution codes
        • ⌨️Get credit card codes (All) API
        • ⌨️Get credit card name API
        • ⌨️Get bank codes (All) API
        • ⌨️Get bank name API
      • 🛖PG information
        • ⌨️Get PG MIDs API
  • SDK
    • 📚Javascript SDK
      • 💿Payment request parameters
      • 📀Payment response parameters
      • 💿Identity verification request parameters
      • 📀Identity verification response parameters
      • ✏️SDK Release Notes
  • FAQ
    • ⁉️FAQ
  • 🔑Payment integration by PG
    • 🏢Payment gateways
      • ⌨️NHH KCP
      • ⌨️KG INICIS
      • ⌨️Toss Payments
      • ⌨️NICE Payments
      • ⌨️KICC
      • ⌨️Daou (PAYJOA)
        • 📍Precautions for using PAYJOA
      • ⌨️KG Mobilians
      • ⌨️Paymentwall
      • ⌨️Danal
      • ⌨️Settlebank
      • ⌨️JTNET
      • ⌨️Smartro
      • ⌨️PayPal
      • ⌨️Eximbay
      • ⌨️Blue Walnut
    • ⛺Simple payments
      • ⌨️Naver Pay (Standard)
      • ⌨️Kakao Pay
      • ⌨️PAYCO
      • ⌨️Alipay
      • ⌨️Toss
  • Korean Integration Docs
Powered by GitBook
On this page
  • Parameters
  • Additional properties
  • Additional functions
  1. SDK
  2. Javascript SDK

Payment request parameters

PreviousJavascript SDKNextPayment response parameters

Last updated 2 years ago

Parameters

pg * string

PG code

If not specified or invalid, the default PG setting in Admin console is used.

pay_method * string

Payment method code

Varies by PG.

Payment method codes
  • card (credit card)

  • trans(instant account transfer)

  • vbank(virtual account)

  • phone(mobile micropayment)

  • samsung(Samsung Pay)

  • kpay (KPay app)

  • kakaopay(Kakao Pay)

  • payco ( PAYCO)

  • lpay (LPAY)

  • ssgpay(SSG Pay)

  • tosspay(Toss simple pay)

  • cultureland(Cultureland)

  • smartculture(Smart Culture)

  • happymoney(Happy Money)

  • booknlife(Book culture gift certificate)

  • point(points, e.g., Benepia)

  • wechat(WeChat Pay)

  • alipay(Alipay)

  • unionpay(UnionPay)

  • tenpay(TenPay)

escrow boolean

Option to open escrow payment window

Supported by only some PGs.

merchant_uid * string

Merchant order ID

  • Order ID generated uniquely for each request.

  • Max 40 bytes

  • If you specify an ID used for already approved transaction, your request will be rejected.

name string

Product name

  • Max 16 bytes

amount * number

Amount

  • Must be numeric

custom_data object

Custom data

  • Can be received as echo in the response.

  • Saved as JSON notation (string).

  • Use to specify additional order information.

tax_free number

Tax free amount

  • Tax free amount (out of amount)

currency string

Currency

  • For PayPal, USD is the default value as PayPal does not support KRW

Currency codes
  1. KRW

  2. USD

  3. EUR

  4. JPY

language string

Language for payment window (Supported by only some PGs.)

Language codes
  • en (English)

  • ko (Korean)

buyer_name * string

Customer name

buyer_tel string

Customer phone number

  • Some PGs throw an error if this is not specified

buyer_email string

Customer email

  • Some PGs throw an error if this is not specified (Paymentwall)

buyer_addr string

Customer address

buyer_postcode string

Customer zip code

confirm_url string

  • Must request for use to support@iamport.kr.

notice_url string

Webhook URL

  • URL to use instead of Notification URL set in Admin Console (set for each request)

  • If specified, notification is not sent to the URL set in Admin Console.

customer_uid string

Merchant defined billing key

Customer billing key that is mapped 1:1 with the billing key for non-authenticated payment.

Additional properties

digital boolean

Option to specify the product as digital content

  • Required for mobile micropayment

  • For intangible product, set to true

  • Note that fees vary depending on this option.

vbank_due string

Virtual account expiration

  • For virtual account payment

  • YYYYMMDDhhmm

m_redirect_url string

EndPoint URL to redirect to after payment is complete

  • Required in redirection mode

  • Required in most mobile payment environments.

  • If not specified in redirection mode, you cannot receive the payment result.

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 info from ISP/App card app

biz_num string

Business registration number

  • Required for Danal-virtual account payment

Additional functions

javascript
display: {
    card_quota: [6]  // Display up to 6 months installment plans
}

Parameters

  • card_quota :

    • []: Only immediate pay

    • 2,3,4,5,6: immediate, 2, 3, 4, 5, 6 month installment plans

Installment plan option is available only for KRW 50,000 or more.

Example of allowing up to 3 months installment plans

javascript
card: {
     direct: {
        code: "367",
        quota: 3
    }
}

Parameters

  • quota: Installment plan. For immediate, set to 0. (integer)

Precautions

  • Currently, direct call to the credit card company's payment window is only supported by 6 PGs: KG Inicis, KCP, Toss Payments, Nice Payments, KICC, and Danal.

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

Example of direct call to Hyundai Card module

javascript
card : {
    detail : [
        {card_code:"*", enabled:false},     // Disable all credit cards
        {card_code:'366', enabled:true}     // Enable specific credit card
    ]
}

Parameters

  • enabled: Option to enable the credit card (boolean)

Example of enabling only Shinhan Card payment window

Merchant endpoint url when using

code: (string)

card_code: (string)

📚
💿
PG codes
Payment integration by PG
PayPal Supported Currencies
confirm_process
Credit card code
Credit card code