Generate payment URL

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
POST https://api.iamport-dev.co/api/supplements/v1/link/payment

URI
POST https://api.iamport.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

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

Payment (bridge) page Expired (bridge) page

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

Sample page displayed for an expired payment URL page (expire_at exceeded).

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

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