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 Name	Type	Length	Required	Description
mallId	String	8Byte	✅	Merchant ID assigned by KICC
customerKey	String	60Byte	✅	Simple Payment User Unique Key
easypayVirtualNo	String	60Byte	✅	Payment Method Virtual Number selected by customer
payMethodTypeCode	String	2Byte	✅	Payment Method Code (See PayMethod Code)
payMethodDetailCode	String	3Byte	✅	Payment Method Detail Code (See Card Code)
shopTransactionId	String	60Byte	✅	Merchant Transaction ID (API Idempotency Key)
shopOrderNo	String	40Byte	✅	Merchant Order No.
currency	String	2Byte	✅	Currency Code (KRW: “00”)
amount	Number		✅	Payment Request Amount
comTaxAmt	Number			Taxable Amount
comFreeAmt	Number			Tax-free Amount
comVatAmt	Number			VAT Amount
goodsName	String	100Byte	✅	Product Name Merchants using UTF-8 must URL Encode this value
installmentMonth	Number			Installment Months (Card Only) Required for Credit Card
isFreeInstallment	Boolean			Interest-free Y/N (Card Only) Required for Credit Card
isCardPointUsageCheck	Boolean			Point Usage Y/N (Card Only) Required for Credit Card
joinCd	String	4Byte		Affiliate Service Code (Only for specific merchants)
userEmail	String	50Byte		User Email (Sent upon approval/cancellation)
returnUrl	String	256Byte	✅	Merchant Return URL after auth (Redirects here, HTTPS Only)
msgAuthValue	String	200Byte	✅	Message Integrity Verification Value (See Message Authentication) Contact sales for Secret Key
cashReceiptInfo	Object			Cash Receipt Info (See cashReceiptInfo below)
depositList	Array			Resource Circulation Deposit List (See depositList below)
shopParameter	String	4000Byte		Merchant Custom Data (Reserved Field) Do not include personal information.

cashReceiptInfo (Cash Receipt Information)

Field Name	Type	Length	Required	Description
usage	String	2Byte	✅	Usage Type Income Deduction: "01", Expenditure Proof: "02"
issuingMethod	String	1Byte	✅	Issuing Method Card: "1", Phone No: "3", Biz No: "4"
issuingValue	String	256Byte	✅	Value for issuance. Must be SEED Encrypted and sent as HexString.

depositList (Resource Circulation Deposit List)

Field Name	Type	Length	Required	Description
dpsType	String	1Byte	✅	Deposit Type (Cup Deposit: “C”)
dpsAmount	Number		✅	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 Name	Type	Length	Required	Description
resCd	String	4Byte	✅	Result Code (Success: “0000”)
resMsg	String	1000Byte	✅	Result Message
shopTransactionId	String	60Byte		Returns the value sent in the request
authPageUrl	String	256Byte		Authentication 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