Query Instant Discount Coupons

This API checks for available card issuers and conditions for instant discounts based on the card issuer's policies.

Caution

• You must check the Coupon Exhaustion Rate and Minimum Purchase Amount before requesting a payment.

Request

Caution

Please check the API Domain before requesting.

• Development Server: testpgapi.easypay.co.kr
• Production Server: pgapi.easypay.co.kr

Request URL

POST https://{API Domain}/api/etc/inquiryCoupon
Content-type: application/json; charset=utf-8

Caution

• Request either the cardCd or the cardBin as a search condition, but not both.

Parameters

Field Name	Type	Length	Required	Description
mallId	String	8Byte	✅	Merchant ID assigned by KICC
cardCd	String	3Byte		Card Company Code (See Codes)
cardBin	String	8Byte		Card BIN(first 8 digit of card number)
amount	Number			Payment Amount

Request Example

{  
    "mallId": "{merchant ID}", 
    "cardBin" : "12345678",
    "amount" : "51004"
}

Response

Parameters

Field Name	Type	Length	Description
resCd	String	4Byte	Response Code (Success: “0000”)
resMsg	String	1000Byte	Response Message
couponList	Array		Instant Discount Info (see couponList below)

couponList

Field Name	Type	Length	Description
couponJoinCd	String	3Byte	Target Card Code (See Window Card Codes)
couponJoinNm	String	50Byte	Card Name
couponGid	String	10Byte	Instant Discount Coupon Group ID
calcAuthLimitRate	Number		Coupon Exhaustion Rate (%)
standardAmount	Number		Minimum Purchase Amount (Discount applies if amount >= this value)
discountType	String	2Byte	Discount Coupon Type(Percentage:01, Fixed Amount:02)
maxDiscountAmount	Number		Max Discount Amount(Included Only for Percentage coupon)
couponRate	Number		Coupon Discount Rate(Included Only for Percentage coupon)
couponAmount	Number		Coupon Discount Amount(For Percentage coupon, Included Only if the amount is provided in Request)

Response Example

{
   "res_cd": "0000",
   "res_msg": "Success",
   "coupon_datas": [
      {
         "card_cd": "008",
         "card_nm": "하나카드",
         "coupon_id": "CP12345678",
         "calc_auth_limit_rate": 12.03,
         "standard_amt": 100000,
         "discount_amt": 1000,
         "discount_type": "02",
         "max_discount_amt": null
      },
      {
         "card_cd": "026",
         "card_nm": "비씨카드",
         "coupon_id": "CP87654321",
         "calc_auth_limit_rate": 60.55,
         "standard_amt": 200000,
         "discount_amt": 2000,
         "discount_type": "01",
         "max_discount_amt": 10000
      }
   ]
}