💻Generate payment URL

Learn about the payment URL generation API.

1. Overview

This document describes i'mport payment URL generation API specification. i'mport Merchants can use the service without any restrictions.

2. API URI

Payment API is exposed as REST web service.

HTTP Method : POST

Content-Type : application/json;charset=UTF-8

URI
https://api.iamport-dev.co/api/supplements/v1/link/payment

3. Description

Customers can access the generated payment URL to make a payment. It supports all payment methods supported by the PG. When the link expires, payment is no longer available.

4. Request message specification

Creates a payment URL.

POST https://api.iamport.co/api/supplements/v1/link/payment

HTTP Method : POST

Content-Type : Application.json;charset=UTF-8

Request Body

Name
Type
Description

title*

String

Title of the bridge page

user_code*

String

Merchant ID

amount*

integer

Amount

merchant_uid*

String

Order ID

name*

String

Product name

tax_free

integer

Tax free amount

currency*

String

Currency code

language

String

Payment window language

-ko

-en

buyer_name

String

Customer name

buyer_tel*

String

Customer phone

buyer_addr

String

Customer address

buyer_email

String

Customer email

buyer_postcode

String

Customer zip

custom_data

Object

Custom data

notice_url

String

Notification URL to receive payment result

expire_at*

String

Page expiration

display_language

String

Bridge page language

-ko : Korean

-en : English

pay_methods*

Object

pg * string

PG code

display: { card_quota: [6] // Display up to 6 months installment plans}Parameterscard_quota :[]: Only immediate pay2,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 planscard: { direct: { code: "367", quota: 3 }}Parameterscode: Credit card code (string)quota: Installment plan. For immediate, set to 0. (integer)PrecautionsCurrently, 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 modulecard : { detail : [ {card_code:"*", enabled:false}, // Disable all credit cards {card_code:'366', enabled:true} // Enable specific credit card ]}Parameterscard_code: Credit card code (string)enabled: Option to enable the credit card (boolean)Example of enabling only Shinhan Card payment window

pay_method * string

Payment method code

display: { card_quota: [6] // Display up to 6 months installment plans}Parameterscard_quota :[]: Only immediate pay2,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 planscard: { direct: { code: "367", quota: 3 }}Parameterscode: Credit card code (string)quota: Installment plan. For immediate, set to 0. (integer)PrecautionsCurrently, 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 modulecard : { detail : [ {card_code:"*", enabled:false}, // Disable all credit cards {card_code:'366', enabled:true} // Enable specific credit card ]}Parameterscard_code: Credit card code (string)enabled: Option to enable the credit card (boolean)Example of enabling only Shinhan Card payment window

label * string

Payment method shown on bridge page

json
{
    "shortenedUrl": "https://dev.impay.link/4bdf239e"  //Create payment link 
}

#Sample JSON request message

json
{
    "payment_info": "{\"title\":\"Test merchant\",\"user_code\":\"imp68124833\",\"amount\":10000,\"merchant_uid\":\"merchant_1630665784552\",\"name\":\"payment link test\",\"tax_free\":\"tax free amount\",\"currency\":\"KRW\",\"language\":\"ko\",\"buyer_name\":\"\",\"buyer_tel\":\"\",\"buyer_addr\":\"\",\"buyer_email\":\"\",\"buyer_postcode\":\"\",\"custom_data\":\"json_object\",\"notice_url\":\"notification url\",\"pay_methods\":[{\"pg\":\"INIpayTest\",\"pay_method\":\"card\",\"label\":\"credit/check card\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"naverpay\",\"label\":\"Naver Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"kakaopay\",\"label\":\"Kakao Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"phone\",\"label\":\"mobile micropayment\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"trans\",\"label\":\"account transfer\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"vbank\",\"label\":\"virtual account\"}]}",
    "expired_at": 1634324016
}

#Sample payment (bridge) page

Sample response URL page displayed when payment URL API request is successful.

Payment URL page

5. Disabling payment URL

Append the last part of the response (shortenedUrl) URL to the payment URI API address and call it.

HTTP Method : PUT

For the following API response

{

"shortenedUrl": "https://dev.impay.link/4bdf239e"

}

https://api.iamport.co/api/supplements/v1/link/payment/4bdf239e

Call the above payment URL to disable it.

Previous4. Get verification infoNextIntegrate budget handler

Last updated