Skip to main content

Transaction Registration

This API registers order information to invoke the authentication screen and returns the Authentication Window URL in the response.

info
  • This API is provided for PG payment services.

Request​

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

Supports API Idempotency (See API Idempotency)

Parameters​

Field NameTypeLengthRequiredDescription
mallIdString8Byte✅Merchant ID assigned by KICC
customerKeyString60Byte✅Simple Payment User Unique Key
easypayVirtualNoString60Byte✅Payment Method Virtual Number selected by customer
payMethodTypeCodeString2Byte✅Payment Method Code (See PayMethod Code)
payMethodDetailCodeString3Byte✅Payment Method Detail Code (See Card Code)
shopTransactionIdString60Byte✅Merchant Transaction ID (API Idempotency Key)
shopOrderNoString40Byte✅Merchant Order No.
currencyString2Byte✅Currency Code (KRW: “00”)
amountNumber✅Payment Request Amount
comTaxAmtNumberTaxable Amount
comFreeAmtNumberTax-free Amount
comVatAmtNumberVAT Amount
goodsNameString100Byte✅Product Name
Merchants using UTF-8 must URL Encode this value
installmentMonthNumberInstallment Months (Card Only) Required for Credit Card
isFreeInstallmentBooleanInterest-free Y/N (Card Only) Required for Credit Card
isCardPointUsageCheckBooleanPoint Usage Y/N (Card Only) Required for Credit Card
joinCdString4ByteAffiliate Service Code (Only for specific merchants)
userEmailString50ByteUser Email (Sent upon approval/cancellation)
returnUrlString256Byte✅Merchant Return URL after auth (Redirects here, HTTPS Only)
msgAuthValueString200Byte✅Message Integrity Verification Value (See Message Authentication)
Contact sales for Secret Key
cashReceiptInfoObjectCash Receipt Info (See cashReceiptInfo below)
depositListArrayResource Circulation Deposit List (See depositList below)
shopParameterString4000ByteMerchant Custom Data (Reserved Field)
Do not include personal information.

cashReceiptInfo (Cash Receipt Information)​

Field NameTypeLengthRequiredDescription
usageString2Byte✅Usage Type
Income Deduction: "01", Expenditure Proof: "02"
issuingMethodString1Byte✅Issuing Method
Card: "1", Phone No: "3", Biz No: "4"
issuingValueString256Byte✅Value for issuance.
Must be SEED Encrypted and sent as HexString.

depositList (Resource Circulation Deposit List)​

Field NameTypeLengthRequiredDescription
dpsTypeString1Byte✅Deposit Type (Cup Deposit: “C”)
dpsAmountNumber✅Deposit Amount (Total amount per type)
Request Example
{  
"mallId": "{Merchant ID}",
"customerKey": "{Simple Payment User Unique Key}",
"easypayVirtualNo": "{Virtual Number selected by customer}",
"payMethodTypeCode": "11",
"payMethodDetailCode": "026",
"shopTransactionId": "{API Idempotency Key}",
"shopOrderNo": "{Merchant Order No}",
"currency": "00",
"amount": 1000,
"goodsName": "Sample Product",
"installmentMonth": 0,
"isFreeInstallment": false,
"isCardPointUsageCheck": false,
"userEmail": "{User Email}",
"returnUrl": "{Merchant Return URL}",
"msgAuthValue": "{Message Auth Value}"
}

Response​

Parameters​

Field NameTypeLengthRequiredDescription
resCdString4Byte✅Result Code (Success: “0000”)
resMsgString1000Byte✅Result Message
shopTransactionIdString60ByteReturns the value sent in the request
authPageUrlString256ByteAuthentication Window URL (URL Encoded)
Response Example
{
"resCd": "0000",
"resMsg": "Success",
"shopTransactionId": "{API Idempotency Key}",
"authPageUrl": "{Authentication Window URL}"
}

Message Authentication Value​

The Message Authentication Value is constructed by combining the fields below and hashing the result using HmacSHA256. (See Message Authentication)

customerKey + “|” + shopTransactionId + “|” + payMethodDetailCode + “|” + easypayVirtualNo + “|” + amount