본문으로 건너뛰기

거래인증 등록

인증 화면 호출을 하기 위해 주문정보를 등록하면 인증창 호출 URL을 응답으로 받을 수 있습니다.

정보
  • 본 API는 PG 결제를 위해 제공되는 서비스 입니다.

요청​

요청 URL
POST https://{API 도메인}/easypay/auth/paymentAuthReg.do
Content-type: application/json; charset=euc-kr
참고

API 멱등성 지원 대상 (API 멱등성 참조)

파라미터​

필드명타입길이필수여부설명
mallIdString8Byte✅KICC에서 부여한 가맹점ID
customerKeyString60Byte✅간편결제 회원 고유키
easypayVirtualNoString60Byte✅고객이 선택한 결제수단 가상번호
payMethodTypeCodeString2Byte✅고객이 선택한 결제수단 코드 (결제수단 코드 참고)
payMethodDetailCodeString3Byte✅고객이 선택한 결제수단 상세코드 (결제수단 코드 참고)
shopTransactionIdString60Byte✅제휴사 거래고유번호 (API 멱등성 키)
shopOrderNoString40Byte✅제휴사 주문번호
currencyString2Byte✅통화코드 원화 : “00”
amountNumber✅결제요청 금액
comTaxAmtNumber과세금액
comFreeAmtNumber비과세금액
comVatAmtNumber부가세
goodsNameString100Byte✅상품명
UTF-8 사용 제휴사는 URL Encoding
installmentMonthNumber고객이 선택한 할부개월(카드 Only) 신용카드 시 필수
isFreeInstallmentBoolean무이자 여부(카드Only) 신용카드 시 필수
isCardPointUsageCheckBoolean카드사 포인트 선택 유무(카드 Only) 신용카드 시 필수
joinCdString4Byte제휴서비스 코드 사용 제휴사만 세팅가능
userEmailString50Byte고객 이메일 승인/취소 시 결제내역 전송
returnUrlString256Byte✅인증 후 되돌아갈 제휴사 리턴URL 해당URL로 Redirect됨(HTTPS만 허용)
msgAuthValueString200Byte✅요청값의 무결성을 검증 (메시지 인증값 바로가기)
cashReceiptInfoObject현금영수증 발행정보 (아래 cashReceiptInfo 참조)
depositListArray자원순환 보증금 목록 (아래 depositList 참조)
shopParameterString4000Byte제휴사 예비필드(개인정보에 해당하는 데이터는 제외하여 전달해야 합니다.)

cashReceiptInfo(현금영수증 발행정보)​

필드명타입길이필수여부설명
usageString2Byte✅현금영수증 발행용도
소득공제용: "01" 지출증빙용: "02"
issuingMethodString1Byte✅현금영수증 발행을 위한 수단
카드: "1" 휴대폰번호: "3" 사업자번호: "4"
issuingValueString256Byte✅현금영수증 발행 수단의 값을 SEED 암호화 후 HexString으로 전송함

depositList(자원순환 보증금 목록)​

필드명타입길이필수여부설명
dpsTypeString1Byte✅보증금 종류 컵 보증금 : “C”
dpsAmountNumber✅보증금 금액(자원순환 보증금종류별 총금액)
요청 예시
{  
"mallId": "{KICC에서 부여한 가맹점ID}",
"customerKey": "{간편결제 회원 고유키}",
"easypayVirtualNo": "{고객이 선택한 결제수단 가상번호}",
"payMethodTypeCode": "11",
"payMethodDetailCode": "026",
"shopTransactionId": "{API 멱등성 키}",
"shopOrderNo": "{제휴사 주문번호}",
"currency": "00",
"amount": 1000,
"goodsName": "예시 상품명",
"installmentMonth": 0,
"isFreeInstallment": false,
"isCardPointUsageCheck": false,
"userEail": "{결제고객 메일}",
"returnUrl": "{제휴사 리턴 URL}",
"msgAuthValue": "{메시지 인증값}"
}

응답​

파라미터​

필드명타입길이설명
resCdString4Byte결과코드(정상 : “0000”)
resMsgString1000Byte결과 메시지
shopTransactionIdString60Byte요청 시 전송한 값 그대로 사용
authPageUrlString256Byte인증창 호출 URL(URL Encoding 됨)
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"shopTransactionId": "{API 멱등성 키}",
"authPageUrl": "{인증창 호출 URL}"
}

메시지 인증값​

메시지 인증값 구성은 아래와 같이 조합하고 해당값을 HmacSHA256으로 해시한다. 메시지 인증 참조

customerKey(고객 고유키) + “|” + shopTransactionId(제휴사 거래고유번호) + “|” + payMethodDetailCode(결제수단 상세코드) + “|” + easypayVirtualNo(가상번호) + “|” + amount(결제금액)