등록
예약 결제정보를 등록하면 결제링크를 SMS로 발송하거나, 결제링크만 요청할 수 있도록 제공되는 API 입니다.
참고
결제완료 통지를 받으시려면 노티(웹훅)를 참고해서 Callback을 받기위한 준비를 하시고, 노티를 받기 위한 URL을 가맹점 관리자>노티등록 메뉴에서 등록을 하면 됩니다.
요청
요청 URL
POST https://{API 도메인}/directapi/trades/directSmsUrlPayReg
Content-type: application/json; charset=utf-8
파라미터
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| directRegInfo | Object | ✅ | SMS발송 등록정보 (아래 directRegInfo 참조) | |
| directOrderInfo | Object | ✅ | 예약결제 주문정보 (아래 directOrderInfo 참조) |
directRegInfo(SMS발송 등록정보)
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| mallId | String | 8Byte | ✅ | KICC에서 부여한 상점ID |
| regTxtype | String | 2Byte | ✅ | 등록구분 (등록구분 코드표 바로가기) SMS 발송요청: "51" URL 생성요청: "52" |
| regSubtype | String | 2Byte | ✅ | 등록 세부구분 (등록 세부구분 코드표 바로가기) |
| amount | Number | ✅ | 결제요청 금액 | |
| currency | String | 2Byte | ✅ | 통화코드(원화 : “00”) |
| payCode | String | 2Byte | ✅ | 결제수단 코드 (결제수단 코드 참고) 전체결제수단: "00" |
| pgCno | String | 20Byte | 등록 PG 거래고유번호로 SMS 재발송 요청 시 필수 | |
| rcvMobileNo | String | 11Byte | 고객 연락처(숫자만 허용) SMS 발송요청 시 필수 | |
| sndTelNo | String | 11Byte | 발신번호(숫자만 허용) SMS 발송요청 시 필수 | |
| mallName | String | 14Byte | 상점명 SMS 발송요청 시 필수 | |
| dispMsg | String | 200Byte | 결제창 안내문구 | |
| installmentMonth | String | 2byte | 할부개월수 일시불: "00" | |
| smsPayExpr | String | 14Byte | 결제만료일시(yyyyMMddHHmmss) 미설정 시 D+7 | |
| certType | String | 1Byte | 신용카드 키인결제를 사용하는 가맹점만 설정 카드번호+유효기간+생년월일+비밀번호: "0" 카드번호+유효기간: "1" |
directOrderInfo(예약결제 주문정보)
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| shopOrderNo | String | 40Byte | ✅ | 상점 주문번호 반드시 Unique 값으로 생성 |
| goodsName | String | 50Byte | ✅ | 상품명 |
| goodsAmount | Number | ✅ | 상품금액(결제요청 금액과 동일) | |
| customerId | String | 20Byte | 고객 ID | |
| customerName | String | 20Byte | 고객명 | |
| customerMail | String | 50Byte | 고객 Email | |
| customerContactNo | String | 11Byte | 고객 연락처(숫자만 허용) | |
| value1 | String | 200Byte | 상점여부 필드1 | |
| value2 | String | 200Byte | 상점여부 필드2 | |
| value3 | String | 200Byte | 상점여부 필드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"
}
}
응답
파라미터
| 필드명 | 타입 | 길이 | 설명 |
|---|---|---|---|
| resCd | String | 4Byte | 결과코드(정상 : “0000”) |
| resMsg | String | 1000Byte | 결과 메시지 |
| mallId | String | 8Byte | KICC에서 부여한 상점ID |
| shopOrderNo | String | 40Byte | 요청 시 전송한 값 그대로 사용 |
| pgCno | String | 20Byte | 등록 PG 거래고유번호 등록된 거래를 취소할 시 필수 필드 |
| amount | Number | 요청 시 전송한 값 그대로 사용 | |
| expiryDate | String | 14Byte | 결제만료일시(yyyyMMddHHmmss) |
| authPageUrl | String | 100Byte | 결제링크 |
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"mallId": "{상점ID}",
"shopOrderNo": "{상점 주문번호}",
"pgCno": "{등록 PG 거래고유번호}",
"amount": 1000,
"expiryDate": "{결제만료일시(yyyyMMddHHmmss)}",
"authPageUrl": "{결제링크}"
}
등록구분 코드표
등록 구분(regTxtype)
| 코드 | 구분 | 설명 |
|---|---|---|
| 51 | 결제 SMS 발송요청 | 결제링크를 SMS로 발송요청 |
| 52 | 결제 URL 생성요청 | 결제링크만 요청(상정에서 직접 결제링크 발송) |
등록 세부구분(regSubtype)
| 코드 | 구분 | 설명 |
|---|---|---|
| 10 | 등록 요청 | 신규 거래등록 요청 |
| 11 | 재등록 요청 | 기존 SMS 발송건을 재발송 요청 |