서비스 Flow
상점에서 결제할 수 있는 URL이 포함된 SMS를 고객에게 발송하고, 해당 URL을 통해 결제하는 서비스 입니다.
해당 서비스는 가맹점이 계약한 모든 결제수단을 지원합니다.
모든 API 응답 대기시간은 최대 30초를 권장합니다.
HTTP 헤더
HTTP POST 방식으로 요청하는 모든 API 호출 시 아래 내용을 필수로 추가해 주시기 바랍니다.
항목 | Desc | 설명 |
---|---|---|
Content-type | application/json | |
Charset | UTF-8 |
고객에게 결제URL이 있는 SMS 발송을 요청하는 API 입니다.
HTTP POST 방식으로 호출하시기 바랍니다.
요청
URL 정보
테스트 | https://testpgapi.easypay.co.kr/directapi/trades/directSmsUrlReg |
운영 | https://pgapi.easypay.co.kr/directapi/trades/directSmsUrlReg |
파라미터
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
directRegInfo | Object | 필수 | SMS발송 등록정보 {directRegInfo} 참조 |
|
directOrderInfo | Object | 필수 | 결제 주문정보 {directOrderInfo} 참조 |
directRegInfo(SMS발송 등록정보)
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
mallId | String | 8 Byte | 필수 | 상품명 |
shopTransactionId | String | 60 Byte | 필수 | 가맹점 트랜젝션ID 중복요청을 방지를 위해 일별로 Unique 보장 |
shopReqDate | String | 8 Byte | 필수 | 등록요청 일자(yyyyMMdd) |
regTxtype | String | 2 Byte | 필수 | 등록구분 SMS PAY 등록 : "51" URL PAY 등록 : "52" |
regSubtype | String | 2 Byte | 필수 | 등록 세부구분 승인요청 : "10" 등록세부구분 코드표 참조 |
amount | Number | 필수 | 결제금액 | |
currency | String | 2 Byte | 필수 | 통화코드(원화 : "00") |
payCode | String | 2 Byte | 필수 | 결제수단 코드 "00" : 전체결제수단 "11" : 신용카드 "21" : 계좌이체 "31" : 휴대폰결제 "81" : 빌키 발급 |
pgCno | String | 20 Byte | 기 등록 PG거래번호 SMS 재발송 요청 시 필수 |
|
rcvMobileNo | String | 11 Byte | SMS 수신할 휴대폰번호(숫자만 허용) 등록구분 SMS PAY("51")일 경우 필수 |
|
sndTelNo | String | 11 Byte | 발신번호(숫자만 허용) 등록구분 SMS PAY("51")일 경우 필수 |
|
mallName | String | 14 Byte | 상호명(SMS 발송 시 사용할 상호명) 등록구분 SMS PAY("51")일 경우 필수 |
|
dispMsg | String | 200 Byte | 결제창 안내문구 | |
installmentMonth | String | 2 Byte | 할부개월(단일개월만 지정가능) 예) 일시불 : "00", 3개월 "03" |
|
smsPayExpr | String | 14 Byte | 결제만료일시(yyyyMMddHHmmss) 미설정 시 D+7 |
|
certType | String | 1 Byte | 신용카드 인증구분 미설정 : 온라인 인증(default) 키인(카유생비) : "0" 키인(카유) : "1" |
directOrderInfo(결제 주문정보)
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
shopOrderNo | String | 40 Byte | 필수 | 가맹점 주문번호 |
goodsTypeCode | String | 1 Byte | 상품구분(실물:0, 컨텐츠:1) | |
goodsName | String | 50 Byte | 상품명 | |
goodsAmount | Number | 필수 | 상품금액(결제금액과 동일해야 함) | |
customerNo | String | 20 Byte | 고객일련번호 | |
customerId | String | 20 Byte | 가맹점 고객ID | |
customerName | String | 20 Byte | 고객명 | |
customerMail | String | 50 Byte | 고객메일(결제안내 메일용) | |
customerContactNo1 | String | 20 Byte | 고객 연락처(숫자만 허용) | |
customerAddr | String | 200 Byte | 고객 주소 | |
value1 | String | 64 Byte | 가맹점 사용 필드1 | |
value2 | String | 64 Byte | 가맹점 사용 필드2 | |
value3 | String | 32 Byte | 가맹점 사용 필드3 | |
value4 | String | 32 Byte | 가맹점 사용 필드4 | |
value5 | String | 64 Byte | 가맹점 사용 필드5 | |
value6 | String | 64 Byte | 가맹점 사용 필드6 |
요청 예
{
"directRegInfo" : {
"mallId" : "T0001986",
"shopTransactionId" : "202311011234567",
"shopReqDate" : "20231027",
"regTxtype" : "51",
"regSubtype" : "10"
"amount" : 51004,
"currency" : "00",
"payCode" : "00",
"rcvMobileNo" : "01012345678",
"sndTelNo" : "15881588"
},
"directOrderInfo" : {
"shopOrderNo" : "ORDER_20210601162253541680",
"goodsName" : "학원 월회비",
"goodsAmount" : 51004
}
}
응답
Body
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
resCd | String | 4 Byte | 필수 | 결과코드(정상 : "0000") |
resMsg | String | 100 Byte | 필수 | 결과 메시지 |
mallId | String | 8 Byte | 필수 | KICC에서 발급한 상점ID |
shopTransactionId | String | 60 Byte | 필수 | 가맹점 트랜젝션ID 요청값 그대로 응답 |
shopOrderNo | String | 40 Byte | 상점 주문번호 결제등록 시 요청한 값 그대로 사용 |
|
pgCno | String | 20 Byte | PG 등록거래번호 | |
amount | Number | 총 결제금액 | ||
expiryDate | String | 14 Byte | 결제 만료일시(yyyyMMddHHmmss) | |
authPageUrl | String | 100 Byte | regTxtype: 51의 경우, 해당 URL이 고객번호로 발송됨 regTxtype: 52의 경우, 가맹점에서 해당 URL을 고객에게 전송 |
응답 예
{
"resCd": "0000",
"resMsg": "MPI결제 정상",
"mallId": "T0001997",
"pgCno": "21032609005610816914",
"shopTransactionId": "20210326090126",
"shopOrderNo": "20210326090046",
"amount": "51004",
"expiryDate": "20210326090200",
"authPageUrl": "http://easypay.kr/s/21032609005610816914"
}
기 등록된 거래를 취소하는 API 입니다.
이미 결제가 완료된 거래는 취소가 불가하며, 등록 취소된 거래의 결제링크를 클릭해도 결제를 진행할 수 없습니다.
HTTP POST 방식으로 호출하시기 바랍니다.
요청
URL 정보
테스트 | https://testpgapi.easypay.co.kr/directapi/trades/directSmsUrlRegCancel |
운영 | https://pgapi.easypay.co.kr/directapi/trades/directSmsUrlRegCancel |
파라미터
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
mallId | String | 8 Byte | 필수 | 상품명 |
shopTransactionId | String | 60Byte | 필수 | 가맹점 트랜젝션ID 중복요청을 방지를 위해 일별로 Unique 보장 |
shopReqDate | String | 8Byte | 필수 | 등록요청 일자(yyyyMMdd) |
reviseTypeCode | String | 2 Byte | 필수 | 변경거래구분, 등록취소 : "10" |
reviseSubTypeCode | String | 2 Byte | 필수 | 변경거래 세부구분, 결제요청 등록취소 : "30" |
clientIp | String | 2 Byte | 필수 | 요청자 IP |
clientId | String | 15 Byte | 필수 | 요청자 ID(관리자 접속ID) |
요청 예
{
"mallId" : "T0001986",
"shopTransactionId" : "202311011234567",
"shopReqDate" : "20231027",
"reviseTypeCode " : "10",
"reviseSubTypeCode" : "30",
"clientIp" : "203.203.203.203",
"clientId" : "shopID"
}
응답
Body
필드명 | 타입 | 최대크기 | 필수여부 | 설명 |
---|---|---|---|---|
resCd | String | 4 Byte | 필수 | 결과코드(정상 : "0000") |
resMsg | String | 100 Byte | 필수 | 결과 메시지 |
mallId | String | 8Byte | 필수 | KICC에서 부여한 상점ID |
shopTransactionId | String | 60Byte | 필수 | 가맹점 트랜젝션ID 요청값 그대로 응답 |
pgCno | String | 20 Byte | PG 등록거래번호 |
응답 예
{
"resCd": "0000",
"resMsg": "MPI결제 정상",
"mallId": "T0001997",
"pgCno": "21032609005610816914",
"shopTransactionId": "20210326090126",
}