Skip to main content

Payment Method Inquiry

This API retrieves the list of payment methods registered by a Simple Payment member using their Customer Key.

Note
  • This API is provided for PG payment services.
  • You must obtain the Merchant ID (mallId) from your sales representative to use this service.

Request

Request URL
POST https://{API Domain}/easypay/user/paymentMethodInfo.do
Content-type: application/json; charset=euc-kr

Parameters

Field NameTypeLengthRequiredDescription
mallIdString8ByteMerchant ID assigned by KICC
customerKeyString60ByteSimple Payment User Unique Key
payMethodTypeCodeListString60BytePayment Method Type Filter
Empty: All, "11": Credit Card, "21": Account
(See PayMethod Code)
payMethodDetailCodeListString100ByteIssuer/Bank Code Filter
Empty: All
(See Card Code or Bank Code)
Request Example
{  
"mallId": "{Merchant ID}",
"customerKey": "{Simple Payment User Unique Key}",
"payMethodTypeCodeList": "11",
"payMethodDetailCodeList": ""
}

Response

Parameters

Field NameTypeLengthRequiredDescription
resCdString4ByteResult Code (Success: “0000”)
resMsgString1000ByteResult Message
payMethodInfoListArrayPayment Method Detail List (See payMethodInfoList below)

payMethodInfoList (Payment Method Detail List)

Field NameTypeLengthRequiredDescription
payMethodTypeCodeString2ByteSee PayMethod Code
payMethodDetailCodeString3ByteSee Card Code or See Bank Code
displayNameString30BytePayment Method Display Name
nickNameString30ByteUser-defined Nickname
easypayVirtualNoString60BytePayment Method Virtual Number (Important)
maskingNoString30ByteMasked Number (e.g., ****1234)
imageUrlString256BytePayment Method Icon/Image URL
sortOrderNumberDisplay Sort Order
checkCardFlagString1ByteCheck Card Flag (Y/N) (If type is Card)
cardUserTypeString1ByteCard User Type
Personal: “P”, Corporate: “C”
installmentInfoListArrayInstallment Info (For Credit Cards, PG only)
(See installmentInfoList below)
cardPointInfoObjectCard Point Info (For Credit Cards)
(See cardPointInfo below)

payMethodList > installmentInfoList (Installment Info)

Field NameTypeLengthRequiredDescription
basisAmountNumberMinimum Amount Required for Installment
freeInstallmentMonthListArrayList of Interest-Free Months e.g., [2,3,4,5,6]
installmentMonthListArrayList of Available Installment Months e.g., [2,3...12]

payMethodList > cardPointInfo (Card Point Info)

Field NameTypeLengthRequiredDescription
isPointEnabledBooleanPoint Usage Availability
true: Can use points (Display checkbox)
Response Example
{
"resCd": "0000",
"resMsg": "Success",
"payMethodInfoList": [
{
"payMethodTypeCode": "11",
"payMethodDetailCode": "016",
"displayName": "Credit Card",
"nickName": "KB Kookmin Card",
"easypayVirtualNo": "{Payment Method Virtual Number}",
"maskingNo": "445612******1234",
"imageUrl": "{Image URL}",
"sortOrder": 1,
"checkCardFlag": "Y",
"cardUserType": "P",
"installmentInfoList": [
{
"basisAmount": 50000,
"freeInstallmentMonthList": [2,3,4,5,6],
"installmentMonthList": [2,3,4,5,6,7,8,9,10,11,12]
}
],
"cardPointInfo": {
"isPointEnabled": true
}
},
{
"payMethodTypeCode": "11",
"payMethodDetailCode": "027",
"displayName": "Credit Card",
"nickName": "Hyundai Card",
"easypayVirtualNo": "{Payment Method Virtual Number}",
"maskingNo": "545312******1234",
"imageUrl": "{Image URL}",
"sortOrder": 1,
"checkCardFlag": "Y",
"cardUserType": "P",
"installmentInfoList": [
{
"basisAmount": 10000,
"freeInstallmentMonthList": [2,3,4,5,6],
"installmentMonthList": [2,3,4,5,6,7,8,9,10,11,12]
}
],
"cardPointInfo": {
"isPointEnabled": true
}
}
]
}