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 |