Register SMS Payment

This API registers reservation payment information and either sends a payment link via SMS or generates a payment link URL.

Note

To receive payment completion notifications, please refer to the Webhook (Notification) guide to prepare your server, and then register your URL in the Merchant Admin > Notification Registration menu.

Request

Request URL

POST https://{API Domain}/directapi/trades/directSmsUrlPayReg
Content-type: application/json; charset=utf-8

Parameters

Field Name	Type	Length	Required	Description
directRegInfo	Object		✅	SMS Registration Info (See directRegInfo below)
directOrderInfo	Object		✅	Reservation Order Info (See directOrderInfo below)

directRegInfo (SMS Registration Info)

Field Name	Type	Length	Required	Description
mallId	String	8Byte	✅	Merchant ID assigned by KICC
regTxtype	String	2Byte	✅	Registration Type (See Code Table) Send SMS: "51" Generate URL: "52"
regSubtype	String	2Byte	✅	Registration Sub-Type (See Code Table)
amount	Number		✅	Payment Amount
currency	String	2Byte	✅	Currency Code (KRW: “00”)
payCode	String	2Byte	✅	Payment Method Code (See Codes) All Methods: "00"
pgCno	String	20Byte		Registered PG Transaction ID (Required for SMS Resend)
rcvMobileNo	String	11Byte		Customer Mobile No. (Numbers only). Required for SMS Send Request.
sndTelNo	String	11Byte		Sender Mobile No. (Numbers only). Required for SMS Send Request.
mallName	String	14Byte		Merchant Name. Required for SMS Send Request.
dispMsg	String	200Byte		Message to display on Payment Window
installmentMonth	String	2byte		Installment Month (Lump-sum: "00")
smsPayExpr	String	14Byte		Payment Expiration Date (yyyyMMddHHmmss). Default: D+7 if not set.
certType	String	1Byte		Key-in Payment Auth Type (Only for Key-in Merchants) Card No+Exp+DOB+PWD: "0" Card No+Exp: "1"

directOrderInfo (Reservation Order Info)

Field Name	Type	Length	Required	Description
shopOrderNo	String	40Byte	✅	Merchant Order No. Must be Unique.
goodsName	String	50Byte	✅	Product Name
goodsAmount	Number		✅	Product Amount (Same as Payment Amount)
customerId	String	20Byte		Customer ID
customerName	String	20Byte		Customer Name
customerMail	String	50Byte		Customer Email
customerContactNo	String	11Byte		Customer Contact No. (Numbers only)
value1	String	1000Byte		Custom Field 1
value2	String	64Byte		Custom Field 2
value3	String	32Byte		Custom Field 3

Request Example

{  
    "directRegInfo": { 
        "mallId": "{Merchant ID}", 
        "regTxtype": "51", 
        "regSubtpye": "10", 
        "amount": 1000, 
        "currency": "00", 
        "payCode": "00",     
        "rcvMobileNo": "{Customer Mobile No}", 
        "sndTelNo": "{Sender No}", 
        "mallName": "{Merchant Name}", 
        "dispMsg": "{Display Message}",        
        "smsPayExpr": "{Expiration Date}"
    },    
    "directOrderInfo": { 
        "shopOrderNo": "{Merchant Order No}", 
        "goodsName": "Sample Product", 
        "goodsAmount": 1000,        
        "value1": "Custom Data 1", 
        "value2": "Custom Data 2", 
        "value3": "Custom Data 3" 
    }
}

Response

Parameters

Field Name	Type	Length	Required	Description
resCd	String	4Byte	✅	Response Code (Success: “0000”)
resMsg	String	1000Byte	✅	Response Message
mallId	String	8Byte		Merchant ID assigned by KICC
shopOrderNo	String	40Byte		Returns the value sent in the request
pgCno	String	20Byte		Registered PG Transaction ID
amount	Number			Returns the value sent in the request
expiryDate	String	14Byte		Payment Expiration Date (yyyyMMddHHmmss)
authPageUrl	String	100Byte		Payment Link URL

Response Example

{
    "resCd": "0000",
    "resMsg": "Success",
    "mallId": "{Merchant ID}",
    "shopOrderNo": "{Merchant Order No}",
    "pgCno": "{Registered PG Transaction ID}",
    "amount": 1000,
    "expiryDate": "{Expiration Date}",
    "authPageUrl": "{Payment Link URL}"
}

Registration Codes

Registration Type (regTxtype)

Code	Type	Description
51	Send SMS	Request to send the payment link via SMS
52	Generate URL	Request to generate the payment link only (Merchant sends the link)

Registration Sub-Type (regSubtype)

Code	Type	Description
10	New Registration	Request a new transaction registration
11	Resend Request	Request to resend an existing SMS