거래등록 API

결제창 호출을 하기 위해 주문정보를 등록하고 결제창 URL을 응답으로 받을 수 있습니다. HTTP POST 방식으로 호출하시기 바랍니다.

요청

URL 정보

테스트 https://testpgapi.easypay.co.kr/api/ep9/trades/webpay
운영 https://pgapi.easypay.co.kr/api/ep9/trades/webpay

파라미터

필드명 타입 최대크기 필수여부 설명
mallId String 8 Byte 필수 KICC에서 부여한 상점ID
shopOrderNo String 40 Byte 필수 상점 주문번호
반드시 Unique 값으로 생성
amount Number 필수 결제요청 금액
payMethodTypeCode String 2 Byte 필수 결제수단 코드
(결제수단 코드표 참조)
currency String 2 Byte 필수 통화코드(원화 : "00")
returnUrl String 256 Byte 필수 인증 완료 후 이동할 URL
deviceTypeCode String 20 Byte 필수 결제고객 단말구분
PC버전 : "pc", 모바일버전 : "mobile"
clientTypeCode String 2 Byte 필수 결제창 구분코드(통합형 : 00)
appScheme String 256 Byte 가맹점 앱스키마(앱으로 결제연동 시)
iOS에서 대외기관 앱 호출 후 돌아올 때 사용
'Mobile 앱 연동 가이드' 참조
orderInfo Object 필수 결제 주문정보.
{orderInfo} 참조
payMethodInfo Object 결제수단 관리정보.
{payMethodInfo} 참조
taxInfo Object 복합과세 정보(복합과세 사용 시 필수)
{taxInfo} 참조
shopValueInfo Object 가맹점 필드
승인 및 노티 응답으로 전송됨
{shopValueInfo} 참조

orderInfo(결제 주문정보)

필드명 타입 최대크기 필수여부 설명
goodsName String 50 Byte 필수 상품명
customerInfo Object 주문 고객정보
{customerInfo} 참조

customerInfo(주문 고객정보)

필드명 타입 최대크기 필수여부 설명
customerId String 20 Byte 고객 ID
customerName String 20 Byte 고객 명
customerMail String 50 Byte 고객 Email(에스크로 사용 시 필수)
customerContactNo String 11 Byte 고객 연락처(숫자만 허용)
customerAddr String 200 Byte 고객 주소

payMethodInfo(결제수단 관리정보)

필드명 타입 최대크기 필수여부 설명
mobileCd String 3 Byte 통신사 코드 참조
cashReceiptUsed Boolean 현금영수증 노출여부(가상계좌, 계좌이체만 적용)
True : 노출
cardMethodInfo Object 신용카드 설정 정보
{cardMethodInfo} 참조
virtualAccountMethodInfo Object 가상계좌 설정 정보
{virtualAccountMethodInfo} 참조

cardMethodInfo(신용카드 설정정보)

필드명 타입 최대크기 필수여부 설명
paymentType String 1 Byte 신용카드 결제 구분
빈값: 일반 신용카드 결제
0: 키인(key-in) 인증
1: 키인(key-in) 비인증
installmentMonthList Array(int) 2 Byte 할부개월 수(일시불인 경우: 00)
setFreeInstallment String 1 Byte 무이자 사용 여부(Y/N)
빈값일 경우 원장정보 사용
setCardPoint String 1 Byte 카드사 포인트 사용 여부(Y/N)
빈값일 경우 원장정보 사용
setCouponInfo String 1 Byte 빈값: 쿠폰 미사용
Y: 쿠폰 사용[couponInfo 필수]
D: DB조회,
영업담당자 문의
joinCd String 4 Byte 제휴서비스 코드
해당 서비스를 사용하기 위해 영업담당자와 협의바람
displayArea Array(String) 결제수단 노출영역 지정목록
CARD: 신용카드
SPAY: 간편결제
usedSpayCode Array 간편결제 노출목록
제휴서비스사 코드 참조
예) ["KKO"]
cardInfoList Array(Object) 결제창에 표시할 카드사 리스트
빈값일 경우 원정정보 사용
[CardList] 참조
couponInfo Array(Object) 10 Byte 쿠폰사용 정보(단독형 신용카드)
영업담당자 문의
[couponInfo] 참조

cardList(결제창 표기 카드사 리스트)

필드명 타입 최대크기 필수여부 설명
cardCd String 3 Byte 카드사 코드표 참조
cardPoint String 2 Byte 카드사 포인트 적용값
setCardPoint가 "Y" 시 사용
예) "60"
cardNo String 20 Byte 해외카드 안심클릭 사용시
expireDate String 4 Byte 해외카드 안심클릭 사용시

virtualAccountMethodInfo(가상계좌 설정정보)

필드명 타입 최대크기 필수여부 설명
bankList Array 은행 리스트
빈값일 경우 원장설정 은행
은행 코드표 참조
expiryDate String 8 Byte 입금만료 일자(yyyyMMdd)
빈값일 경우 원장설정 값
expiryTime String 6 Byte 입금만료 시간(hhmmss)
빈값일 경우 원장설정 값

couponInfo(쿠폰사용 정보)

필드명 타입 최대크기 필수여부 설명
cponId String 10 Byte 쿠폰 그룹아이디
cponAmt NUMBER 쿠폰 번호
cponNo String 44 Byte 쿠폰 번호

taxInfo(복합과세 정보)

필드명 타입 최대크기 필수여부 설명
taxAmount Number 필수 과세 금액
freeAmount Number 필수 비과세 금액
vatAmount Number 필수 부가세 금액

shopValueInfo(가맹점 필드)

필드명 타입 최대크기 필수여부 설명
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
value7 String 64 Byte 필드7

요청 예

{

   "mallId":"T0001997",

   "payMethodTypeCode": "11",

   "currency": "00",

   "amount": 51004,

   "clientTypeCode": "00",

   "returnUrl": "https://sample.easypay.co.kr/res.jsp",

   "deviceTypeCode": "mobile",

   "shopOrderNo": "20210326085908",

   "orderInfo": {

      "goodsName":"예시 상품명"

   }

}

응답

Body

필드명 타입 최대크기 필수여부 설명
resCd String 4 Byte 필수 결과코드(정상 : "0000")
resMsg String 100 Byte 필수 결과 메시지
authPageUrl String 256 Byte 결제창 호출 URL

응답 예

{

   resCd : "0000",

   resMsg : "정상처리",

   authPageUrl : "https://testsp.easypay.co.kr/webpay/ReqAction.do?authorizationId=1231234"

}