Transaction Registration (VAN)

Register payment information to invoke the authentication screen. Upon successful registration, the Authentication Window URL will be provided in the response.

info

• This API is provided specifically for VAN payment services.
• For online non-face-to-face payments, please refer to the VAN Payment > Simple Payment Guide.

Request

Request URL

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

Note

Supports API Idempotency (See API Idempotency)

Parameters

Field Name	Type	Length	Required	Description
customerKey	String	60Byte	✅	Simple Payment Member Unique Key
easypayVirtualNo	String	60Byte	✅	Payment Method Virtual Number selected by the customer
payMethodTypeCode	String	2Byte	✅	Payment Method Type Code (See Payment Method Codes)
payMethodDetailCode	String	3Byte	✅	Detailed Payment Method Code (See Card Codes)
shopTransactionId	String	60Byte	✅	Merchant Transaction ID (API Idempotency Key)
shopOrderNo	String	40Byte	✅	Merchant Order Number
returnUrl	String	256Byte	✅	Merchant Return URL after authentication Redirects to this URL (HTTPS only)
shopParameter	String	4000Byte		Merchant Reserved Field (Do not include personal information)

Request Example

{    
    "customerKey": "{Simple Payment Member Unique Key}",
    "easypayVirtualNo": "{Payment Method Virtual Number}",
    "payMethodTypeCode": "11",
    "payMethodDetailCode": "026",
    "shopTransactionId": "{API Idempotency Key}",
    "shopOrderNo": "{Merchant Order Number}",    
    "returnUrl": "{Merchant Return URL}"    
}

Response

Parameters

Field Name	Type	Length	Required	Description
resCd	String	4Byte	✅	Result Code (Normal: “0000”)
resMsg	String	1000Byte	✅	Result Message
shopTransactionId	String	60Byte		Returns the same 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}"
}