본문으로 건너뛰기

등록

예약 결제정보를 등록하면 결제링크를 SMS로 발송하거나, 결제링크만 요청할 수 있도록 제공되는 API 입니다.

참고

결제완료 통지를 받으시려면 노티(웹훅)를 참고해서 Callback을 받기위한 준비를 하시고, 노티를 받기 위한 URL을 가맹점 관리자>노티등록 메뉴에서 등록을 하면 됩니다.

요청

요청 URL
POST https://{API 도메인}/directapi/trades/directSmsUrlPayReg
Content-type: application/json; charset=utf-8

파라미터

필드명타입길이필수여부설명
directRegInfoObjectSMS발송 등록정보 (아래 directRegInfo 참조)
directOrderInfoObject예약결제 주문정보 (아래 directOrderInfo 참조)

directRegInfo(SMS발송 등록정보)

필드명타입길이필수여부설명
mallIdString8ByteKICC에서 부여한 상점ID
regTxtypeString2Byte등록구분 (등록구분 코드표 바로가기)
SMS 발송요청: "51" URL 생성요청: "52"
regSubtypeString2Byte등록 세부구분 (등록 세부구분 코드표 바로가기)
amountNumber결제요청 금액
currencyString2Byte통화코드(원화 : “00”)
payCodeString2Byte결제수단 코드 (결제수단 코드 참고)
전체결제수단: "00"
pgCnoString20Byte등록 PG 거래고유번호로 SMS 재발송 요청 시 필수
rcvMobileNoString11Byte고객 연락처(숫자만 허용) SMS 발송요청 시 필수
sndTelNoString11Byte발신번호(숫자만 허용) SMS 발송요청 시 필수
mallNameString14Byte상점명 SMS 발송요청 시 필수
dispMsgString200Byte결제창 안내문구
installmentMonthString2byte할부개월수 일시불: "00"
smsPayExprString14Byte결제만료일시(yyyyMMddHHmmss) 미설정 시 D+7
certTypeString1Byte신용카드 키인결제를 사용하는 가맹점만 설정
카드번호+유효기간+생년월일+비밀번호: "0"
카드번호+유효기간: "1"

directOrderInfo(예약결제 주문정보)

필드명타입길이필수여부설명
shopOrderNoString40Byte상점 주문번호 반드시 Unique 값으로 생성
goodsNameString50Byte상품명
goodsAmountNumber상품금액(결제요청 금액과 동일)
customerIdString20Byte고객 ID
customerNameString20Byte고객명
customerMailString50Byte고객 Email
customerContactNoString11Byte고객 연락처(숫자만 허용)
value1String200Byte상점여부 필드1
value2String200Byte상점여부 필드2
value3String200Byte상점여부 필드3
요청 예시
{  
"directRegIndo": {
"mallId": "{상점ID}",
"regTxtype": "51",
"regSubtpye": "10",
"amount": 1000,
"currency": "00",
"payCode": "00",
"rcvMobileNo": "{고객 연락처}",
"sndTelNo": "{발신번호}",
"mallName": "{상점명}",
"dispMsg": "{결제창 안내문구}",
"smsPayExpr": "{결제만료일시(yyyyMMddHHmmss)}"
},
"directOrderInfo": {
"shopOrderNo": "{상점 주문번호}",
"goodsName": "예시 상품명",
"goodsAmount": 1000,
"value1": "예시 상점여부 필드1",
"value2": "예시 상점여부 필드2",
"value3": "예시 상점여부 필드3"
}
}

응답

파라미터

필드명타입길이설명
resCdString4Byte결과코드(정상 : “0000”)
resMsgString1000Byte결과 메시지
mallIdString8ByteKICC에서 부여한 상점ID
shopOrderNoString40Byte요청 시 전송한 값 그대로 사용
pgCnoString20Byte등록 PG 거래고유번호
등록된 거래를 취소할 시 필수 필드
amountNumber요청 시 전송한 값 그대로 사용
expiryDateString14Byte결제만료일시(yyyyMMddHHmmss)
authPageUrlString100Byte결제링크
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"mallId": "{상점ID}",
"shopOrderNo": "{상점 주문번호}",
"pgCno": "{등록 PG 거래고유번호}",
"amount": 1000,
"expiryDate": "{결제만료일시(yyyyMMddHHmmss)}",
"authPageUrl": "{결제링크}"
}

등록구분 코드표

등록 구분(regTxtype)

코드구분설명
51결제 SMS 발송요청결제링크를 SMS로 발송요청
52결제 URL 생성요청결제링크만 요청(상정에서 직접 결제링크 발송)

등록 세부구분(regSubtype)

코드구분설명
10등록 요청신규 거래등록 요청
11재등록 요청기존 SMS 발송건을 재발송 요청