PayAPP

파라메터	필수	비고
cmd	1	결제요청 : payrequest
userid	1	판매자 회원 아이디
goodname	1	상품명
price	1	결제요청 금액
recvphone	1	수신 휴대폰번호
memo	0	메모
reqaddr	0	주소요청 (1:요청, 0:요청안함)
feedbackurl	0	결제완료 피드백 URL
var1	0	임의 사용 변수 1
var2	0	임의 사용 변수 2
smsuse	0	결제요청 SMS 발송여부 (n: SMS발송안함)
vccode	0	국제전화 국가번호
returnurl	0	결제완료 후 이동할 링크 URL (매출전표 페이지에서 “확인” 버튼 클릭시 이동)
amount_taxable	0	과세 공급가액 (price = amount_taxable + amount_taxfree + amount_vat)
amount_taxfree	0	면세 공급가액
amount_vat	0	부가세
openpaytype	0	결제수단 선택 (신용카드:card, 휴대전화:phone, 카카오페이:kakaopay, 네이버페아:naverpay, 스마일페이:smilepay, 애플페이:applepay, 계좌이체:rbank, 가상계좌:vbank, 페이코:payco,위챗페이:wechat) 콤마(,) 구분으로 결제수단 선택이 가능합니다. 페이앱 설정에 있는 결제수단 사용이 우선합니다. ex) phone,card 인 경우 휴대전화,신용카드 결제만 가능합니다.
checkretry	0	feedbackurl 재시도 (y:재시도,n:재시도 안함) feedbackurl의 응답값이 SUCCESS 가 아니면 feedbackurl 호출을 재시도 합니다. (총 10회 재시도)
recvemail	0	수신 이메일 주소
skip_cstpage	0	매출전표 페이지 이동 여부 (y:매출전표 페이지 이동 안함) returnurl 페이지로 POST로 페이지 이동합니다. ( 보안을 위해 결제완료 처리는 feedbackurl 페이지 에서 하셔야 합니다. )
appurl	0	앱스키마 고객사 앱스키마로 카드사 앱 등에서 앱전환을 위해 사용됩니다
subuserid	0	부계정 아이디
buyerid	0	구매자 아이디

2.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
mul_no		성공시 결제요청 번호
payurl		결제창 URL

2.1.5. 응답 예제

state=1&errorMessage=&mul_no=2000&payurl=http%3A%2F%2Fpayapp.kr%2F000000000000

2.2. 결제 요청 – javascript 방식

2.2.1. 설명

- "PAYAPP LITE" 는 PAYAPP REST API 를 HTML 및 자바스크립트를 이용해 쉽게 연동할 수 있도록 제작된 WRAPPER API 입니다.

- 연동 매뉴얼 사이트 참고 (https://payapp.kr/dev_center/dev_center01.html)

- 빠른시작 참고 (https://payapp.kr/dev_center/quick_start.html)

2.2.2. 호출

파라메터	필수	비고
userid	1	판매자 회원 아이디
shopname	1	상점명
goodname	1	상품명
price	1	결제요청 금액
recvphone	1	수신 휴대폰번호
memo		메모
reqaddr		주소요청 (1:요청, 0:요청안함)
redirecturl		결제요청 성공 URL (redirectpay=1 사용시 사용안함)
redirect		결제요청 성공 URL 방향 (redirectpay=1 사용시 사용안함)
feedbackurl		결제완료 피드백 URL
var1		임의 사용 변수 1
var2		임의 사용 변수 2
smsuse		결제요청 SMS 발송여부 (n: SMS발송안함)
openpaytype		결제수단 선택
checkretry		Feedbackurl 재시도
redirectpay		결제창으로 리다이렉션 파라메터 shopname,goodname,price,recvphone 의 값이 있고 redirectpay 파라메터가 '1'인 경우 결제하는 창으로 이동되어 결제를 빠르게 진행할 수 있도록 합니다.
buyerid		구매자 아이디
skip_cstpage		매출전표 페이지 이동 여부 (y:매출전표 페이지 이동 안함)
vccode		국제전화 국가번호
returnurl		결제완료 후 이동할 링크 URL (매출전표 페이지에서 “확인” 버튼 클릭시 이동)
amount_taxable		과세 공급가액 (price = amount_taxable + amount_taxfree + amount_vat)
amount_taxfree		면세 공급가액
amount_vat		부가세
subuserid		부계정 아이디
appurl		앱스키마

2.2.3. 연동예제

<script src="//lite.payapp.kr/public/api/v2/payapp-lite.js"></script>

<script>

PayApp.setDefault('userid', '아이디');

PayApp.setDefault('shopname', '상점명');

function payappPay(){

PayApp.setParam('goodname', 'test good');

PayApp.setParam('price', '1000');

PayApp.setParam('recvphone', '01000000000');

PayApp.setParam('feedbackurl', '');

PayApp.setParam('returnurl', '');

PayApp.setParam('smsuse', 'n');

PayApp.setParam('redirectpay', '1');

PayApp.setParam('skip_cstpage', 'y');

PayApp.call();

}

</script>

2.3. 결제 (요청, 승인) 취소

2.3.1. 설명

- 호출 파라메터 중 userid, linkkey, mul_no 값은 필수 입니다.

- “2.1. 결제 요청” 연동 에서 feedbackurl을 입력된 결제요청 건 경우에는 결제 요청 취소 성공시 “2.1.6 Feedbackurl 전달” 으로 자료가 전송됩니다.

- 부분 승인취소인 경우 “2.4 FeedbackURL”로 전달되는 mul_no(결제요청번호)는 변경 됩니다

2.3.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

2.3.3. 호출

파라메터	필수	비고
cmd	1	결제(요청,승인)취소 : paycancel
userid	1	판매자 회원 아이디
linkkey	1	연동 KEY
mul_no	1	결제요청번호
cancelmemo	1	결제요청취소 메모
cancelmode	0	결제요청취소 모드 (값이 ready 인 경우 결제요청 상태만 취소 가능)
partcancel		결제요청취소 구분 (0:전취소, 1:부분취소)
cancelprice		결제요청취소 금액 (부분취소인 경우 필수)
cancel_taxable	0	결제요청취소 과세 공급가액 (cancelprice = cancel_taxable + cancel_taxfree + cancel_vat)
cancel_taxfree	0	결제요청취소 면세 공급가액
cancel_vat	0	결제요청취소 부가세

2.3.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

2.3.5. 응답 예제

state=1&errorMessage=

2.4. 결제통보 (FeedbackURL)

2.4.1. 설명

- 결제요청 API (2.1, 2.2)의 feedbackurl 파라메터 / 판매자 관리 사이트의 “설정” > “연동정보” > “공통 통보 URL”의 에 해당하는 페이지입니다.

- 판매자 관리 사이트의 메뉴 “설정” 탭의 “연동 VALUE” 값과 feedbackurl로 전달되는 linkval 값이 같은 경우에만 정상 호출입니다.

- 유효성 검증을 위해 결제 요청 금액을 확인 하시기 바랍니다.

- 결제요청 연동되지 않은 결제건은 공통 통보시 var1, var2가 없을 수 있습니다.

- 공통 통보시 pay_state가 결제요청(1)가 없이 결제완료(4)로 통보 될 수 있습니다.

- feedbackurl, 공통 통보 URL은 여러 번 호출 될 수 있습니다. 중복처리 되지 않도록 mul_no, var1, var2를 이용해 중복방지 하셔야 합니다.

- feedbackurl에 해당되는 페이지의 응답(response)로 ‘SUCCESS’인 경우 성공, 아닌경우 응답 실패로 확인합니다.

- 통보받은 데이터는 반드시 Server-Side에서 처리 하고, 민감 정보가 외부에 노출되지 않도록 주의하셔야 합니다.

- 기능 추가 및 결제수단 추가에 따라 통보되는 데이터의 필드가 추가될 수 있습니다.

2.4.2. Data 전달

파라메터	비고
userid	판매자 회원 아이디
linkkey	연동 KEY
linkval	연동 VALUE
goodname	상품명
price	결제요청 금액
recvphone	수신 휴대폰번호
memo	메모
reqaddr	주소요청 (1:요청, 0:요청안함)
reqdate	결제요청 일시
pay_memo	결제시 입력한 메모
pay_addr	결제시 입력한 주소
pay_date	결제승인 일시
pay_type	결제수단 (1:신용카드, 2:휴대전화, 4:대면결제, 6:계좌이체, 7:가상계좌, 15:카카오페이,16:네이버페이,17:등록결제,21:스마일페이,23:애플페이) “payco(페이코)” 결제는 “1:신용카드”로 응답됩니다
pay_state	결제요청 상태 (1:요청, 4:결제완료, 8,16,32:요청취소, 9,64:승인취소, 10:결제대기, 70,71:부분취소)
var1	임의 사용 변수 1
var2	임의 사용 변수 2
mul_no	결제요청번호
payurl	결제페이지 주소
csturl	신용카드 결제시 매출전표 URL
card_name	신용카드명
vccode	국제전화 국가번호
vbank	은행명 (가상계좌 결제일 경우)
vbankno	입금계좌번호 (가상계좌 결제일 경우)
feedbacktype	0 : 결제요청 연동, 1 : 공통 통보 URL
orig_mul_no	원거래 결제요청번호(부분취소일 경우 값이 있음)
orig_price	원거래 결제요청금액(부분취소일 경우 값이 있음)
rebill_no	정기결제 등록번호 (정기결제인 경우)
amount_taxable	과세 공급가액
amount_taxfree	면세 공급가액
amount_vat	부가세
naverpoint	네이버 포인트 결제시 금액(네이버페이 결제시만 제공)
naverpay	네이버페이 결제구분(네이버페이 결제시만 제공) (카드결제 : ‘card’, 그외 :’bank’)
buyerid	구매자 아이디
canceldate	취소일시
cancelmemo	취소메모
smilepay_smilecash	스마일캐시 이용금액 (스마일페이 결제시만 제공)
smilepay_discountamt	스마일페이 프로모션 이용금액 (스마일페이 결제시만 제공)

2.5. 결제 취소 요청

2.5.1. 설명

- 구매자가 결제승인 후 D+5일이 경과 되었거나, 판매자 정산이 완료된 경우 “2.3. 결제(요청,승인) 취소” 연동으로 취소 되지 않습니다. 이 경우 결제 취소 요청 연동 후 정산금액을 반환하셔야(판매자 정산이 완료된 경우) 취소가 가능합니다.

2.5.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

2.5.3. 호출

파라메터	필수	비고
cmd	1	결제취소 요청 : paycancelreq
userid	1	판매자 회원 아이디
linkkey	1	연동 KEY
mul_no	1	결제요청번호
cancelmemo	1	결제요청취소 메모
dpname		입금자명
partcancel		결제요청취소 구분 (0:전취소,1:부분취소)
cancelprice		결제요청취소 금액 (부분취소인 경우 필수)
cancel_taxable	0	결제요청취소 과세 공급가액 ( partcancel = cancel_taxable + cancel_taxfree + cancel_vat )
cancel_taxfree	0	결제요청취소 면세 공급가액
cancel_vat	0	결제요청취소 부가세

2.5.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

2.5.5. 응답 예제

state=1&errorMessage=

3. 정기 결제 연동

3.1. 정기 결제 요청

3.1.1. 설명

- 정기 결제를 위한 정기 결제 요청을 등록하는 API입니다.

- 정기 결제 요청 등록 후 payurl로 구매자가 최초 1회 결제 승인이 성공하면 다음 결제 주기에 정기 결제가 발생됩니다.

- 휴대전화 정기 결제는 월 정기 결제만 이용이 가능합니다.

3.1.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

3.1.3. 호출

파라메터	필수	비고
cmd	1	정기결제요청 : rebillRegist
userid	1	판매자 회원 아이디
goodname	1	상품명
goodprice	1	정기 결제 요청 금액
recvemail		수신 이메일
recvphone	1	수신 휴대전화 번호
memo		정기 결제 요청 메모
rebillCycleType	1	정기결제 주기 구분(Month,Week,Day)
rebillCycleMonth		월 정기결제 결제일 (1~31,90:말일)
rebillCycleWeek		주 정기결제 결제요일 (1 ~ 7) 1:월요일 ~ 7:일요일
rebillExpire	1	정기결제 만료일 (yyyy-mm-dd)
feedbackurl		결제완료 피드백 URL
var1		임의 변수1
var2		임의 변수 2
smsuse		정기결제요청 SMS발송여부 (n:발송안함)
returnurl		결제완료 후 이동할 링크 URL (매출전표 페이지에서 “확인”버튼 클릭시 이동)
openpaytype		결제 가능 수단 (신용카드:card, 휴대전화:phone)
failurl		결제 실패 Noti URL (1회차 승인 실패는 Noti되지 않습니다)

3.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
rebill_no		정기결제 등록번호
payurl		정기결제URL

3.1.5. 응답 예제

state=1&errorMessage=rebill_no=&payurl=

3.2. 정기 결제 해지

3.2.1. 설명

- 해지된 정기 결제 건은 복구가 불가능 합니다.

3.2.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

3.2.3. 호출

파라메터	필수	비고
cmd	1	정기결제해지 : rebillCancel
userid	1	판매자 회원 아이디
rebill_no	1	정기결제요청 등록번호
linkkey	1	연동 KEY

3.2.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

3.2.5. 응답 예제

state=1&errorMessage=

3.3. 정기 결제 일시정지

3.3.1. 설명

- 정기 결제 요청 건의 상태가 “승인”인 경우 일시정지가 가능합니다.

- 일시정지된 정기 결제 건은 다음 결제 주기에 정기 결제가 발생되지 않습니다.

- 일시정지된 정기 결제 건은 “승인” 상태로 변경이 가능합니다.

3.3.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

3.3.3. 호출

파라메터	필수	비고
cmd	1	정기결제 일시정지 : rebillStop
userid	1	판매자 회원 아이디
rebill_no	1	정기결제요청 등록번호
linkkey	1	연동 KEY

3.3.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

3.3.5. 응답 예제

state=1&errorMessage=

3.4. 정기 결제 승인

3.4.1. 설명

- 정기 결제 요청 건의 상태가 “일시정지”인 경우 승인 상태로 변경이 가능합니다.

- 승인 상태인 정기 결제 건은 다음 결제 주기에 정기 결제가 발생합니다.

3.4.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

3.4.3. 호출

파라메터	필수	비고
cmd	1	정기결제 승인 : rebillStart
userid	1	판매자 회원 아이디
rebill_no	1	정기결제요청 등록번호
linkkey	1	연동 KEY

3.4.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

3.4.5. 응답 예제

state=1&errorMessage=

4. 회원 연동

4.1. 판매자 회원 가입

4.1.1. 설명

대리점이 리셀러를, 리셀러가 판매자를 가입하는 연동입니다.

resellerid는 대리점 또는 리셀러 아이디를 입력하셔야 합니다.

4.1.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

4.1.3. 호출

파라메터	필수	비고
cmd	1	판매자 회원 가입 : sellerRegist
userid	1	판매자 회원 아이디
userpwd	1	판매자 회원 비밀번호 (영문,숫자 8자리)
sellername	1	판매자명
phone	1	판매자 휴대전화번호
compregno		(사업자 필수) 사업자등록번호
compname		(사업자 필수) 상호명(법인명)
biztype1		(사업자 필수) 업태
biztype2		(사업자 필수) 업종
email	1	이메일
zipcode	0	주소-우편번호
addr1	0	주소1
addr2	0	주소2
homepage	0	홈페이지
compbank	0	정산은행
compbanknum	0	정산은행 계좌번호
compbankname	0	정산은행 예금주
bizkind	1	서비스 구분
username		이름
usertype	1	판매자 구분 (개인:1,사업자:2)
resellerid	1	대리점 또는 리셀러 아이디
join_type	1	가입형태 (유료:0, 할인:4), 리셀러 회원 가입은 유료형
ceo_nm		(사업자 필수) 대표자 성함
seller_type	1	가입구분 (seller,reseller)
common_feedbackurl	0	공통 통보 URL
corp_type		사업자 구분 (1:법인,2:개인)

seller_type의 값이“seller”인 경우 resellerid는 리셀러 아이디,

seller_type의 값이“reseller”인 경우 resellerid는 대리점 아이디 입니다.

bizkind : Blog사업자,쇼핑몰사업자,방문판매,음식점(배달),A/S긴급출동,운수업,컨텐츠,도소매,유통,서비스,숙박업,임대업,농수산업,기타

common_feedbackurl : 결제요청연동시 입력하는 feedbackurl과 별도로 결제승인 NOTI을 받으실 수 있습니다.

common_feedbackurl은 결제요청 없이 결제완료로 통보 될 수 있으며, 결제요청연동으로 연동되지 않는 결제건도 피드백이 됩니다. (모든 결제건에 대해 피드백이 이루어 집니다.)

common_feedbackurl의 피드백은 하나의 결제요청건에 대해 여러 번 피드백 될 수 있으니, 결제상태/결제요청번호에 따라 적절한 연동을 하셔야 합니다.

4.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
userid		가입 성공시 판매자 아이디
linkkey		가입 성공시 연동KEY
linkval		가입 성공시 연동VALUE

4.2. 판매자 회원 아이디 중복 체크

4.2.1. 설명

- resellerid는 대리점 또는 리셀러 아이디를 입력하셔야 합니다.

4.2.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

4.2.3. 호출

파라메터	필수	비고
cmd	1	판매자 회원 아이디 중복체크 : useridCheck
userid	1	판매자 회원 아이디
resellerid	1	대리점 또는 리셀러 아이디

4.2.4. 응답

파라메터	값	비고
state	1	중복안됨
state	0	실패, 또는 아이디 중복
errorMessage		실패시 오류 문자열

5. 부계정 등록

5.1. 부계정 등록

5.1.1. 설명

직원별로 카드 결제 및 매출 현황관리를 가능하도록 부계정을 등록하는 연동입니다.

5.1.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

5.1.3. 호출

파라메터	필수	비고
cmd	1	부계정 등록 : subRegist
userid	1	판매자 회원 아이디
subuserid	1	부계정 아이디
linkkey	1	판매자 연동KEY
subpwd	1	부계정 비밀번호
subname	1	부계정명
subetc1		대분류
subetc2		중분류
subetc3		소분류
subjtype		직급
state		권한

5.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

5.1.5. 응답 예제

state=1&errorMessage=

6. 현금영수증 연동

6.1. 현금영수증 발행

6.1.1. 설명

현금영수증 발행 연동입니다.

6.1.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

6.1.3. 호출

파라메터	필수	비고
cmd	1	현금영수증 발행 : cashStRegist
userid	1	판매자 회원 아이디
linkkey	1	판매자 연동KEY
good_name	1	상품명
buyr_name	1	구매자명
buyr_tel1		구매자 휴대폰
buyr_mail		구매자 이메일
id_info	1	휴대폰번호 또는 사업자번호
trad_time	1	원거래시각
tr_code	1	발행용도(0:소득공제용, 1:지출증빙용)
amt_tot	1	거래금액
amt_sup	1	공급가액
amt_svc	1	봉사료
amt_tax	1	부가가치세
corp_tax_type	1	과세:TG01, 면세:TG02

6.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
cashstno		발행번호
cashsturl		발행url

6.1.5. 응답 예제

state=1&errorMessage=&cashstno=&cashsturl=

6.2. 현금영수증 발행 취소

6.2.1. 설명

현금영수증 발행 취소 연동입니다.

6.2.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

6.2.3. 호출

파라메터	필수	비고
cmd	1	현금영수증 취소 : cashStCancel
userid	1	판매자 회원 아이디
linkkey	1	판매자 연동KEY
cashstno	1	발행번호

6.2.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

6.2.5. 응답 예제

state=1&errorMessage=

6.3. 네이버페이 현금영수증 발행대상 금액조회

6.3.1. 설명

네이버페이 현금영수증 발행대상 금액조회입니다.

6.3.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

6.3.3. 호출

파라메터	필수	비고
cmd	1	네이버페이 발행대상 조회 : getNaverpayCashPrice
userid	1	판매자 회원 아이디
linkkey	1	판매자 연동KEY
mul_no	1	결제요청번호

6.3.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
totalCashAmount		현금영수증 발행 대상 총 금액
supplyCashAmount		현금성 총 공급가
vatCashAmount		현금성 총 부가세

6.3.5. 응답 예제

state=1&errorMessage=

7. APP TO APP 연동

7.1. 조건

페이앱 설치, 페이앱 계정 로그인, 페이앱에 필요한 권한(ex: 카메라 결제시 카메라 권한)이 기본

7.2. 스키마

페이앱의 결과를 받을 수 있도록 manifests 파일에 설정

7.2.1. 예제

<activity android:name=".MainActivity"

android:screenOrientation="portrait">

<intent-filter>

</intent-filter>

<intent-filter>

<data

android:host="result"

android:scheme="payappsample"/>

</intent-filter>

</activity>

7.3. 원격 결제

7.3.1. 설명

원격결제(SMS) 연동입니다.

7.3.2. 호출

파라메터	필수	비고
payappRequest	1	페이앱의 원격결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.3.3. 응답

파라메터	값	비고
mul_no		페이앱 결제 번호
payurl		결제 URL

7.3.4. 응답 예제

payappsample://result?mul_no=&payurl=

7.4. 카메라 결제

7.4.1. 설명

카메라를 이용한 결제 연동입니다.(단, 페이앱 카메라 결제 페이지에서 카메라 권한을 획득 해야 합니다.)

7.4.2. 호출

파라메터	필수	비고
payappOcrPaym ent	1	페이앱의 카메라 결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.4.3. 응답

파라메터	값	비고
state		결과
mul_no		페이앱 결제 번호
csturl		페이앱 영수증 URL
errorMessage		에러 메시지
errorCode		에러 코드
cardName		카드사 이름
cardNum		카드 번호
date		결제 일시
installment		할부개월
goodName		상품명
cardAuthNumber		카드승인번호
goodPrice		상품 금액

7.4.4. 응답 예제

payappsample://result?csturl=&state=&errorMessage=&errorCode=&mul_no=&cardName=&cardNum=&date=&installment=&goodName=&cardAuthNumber=&goodPrice=

7.5. 수기 결제

7.5.1. 설명

수기결제를 이용한 연동입니다.

7.5.2. 호출

파라메터	필수	비고
payappNotePay ment	1	페이앱의 수기 결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.5.3. 응답

파라메터	값	비고
state		결과
mul_no		페이앱 결제 번호
csturl		페이앱 영수증 URL
errorMessage		에러 메시지
errorCode		에러 코드
cardName		카드사 이름
cardNum		카드 번호
date		결제 일시
installment		할부개월
goodName		상품명
cardAuthNumber		카드승인번호
goodPrice		상품 금액

7.5.4. 응답 예제

payappsample://result?csturl=&state=&errorMessage=&errorCode=&mul_no=&cardName=&cardNum=&date=&installment=&goodName=&cardAuthNumber=&goodPrice=

7.6. NFC(카드) 결제

7.6.1. 설명

NFC를 이용한 카드 결제입니다.

(단, 페이앱이 실행중이면 NFC카드를 단말에서 인식 못하므로, 페이앱을 종료해야 합니다.)

7.6.2. 호출

파라메터	필수	비고
payappNfcPaym ent	1	페이앱의 NFC 카드 결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.6.3. 응답

파라메터	값	비고
state		결과
mul_no		페이앱 결제 번호
csturl		페이앱 영수증 URL
errorMessage		에러 메시지
errorCode		에러 코드
cardName		카드사 이름
cardNum		카드 번호
date		결제 일시
installment		할부개월
goodName		상품명
cardAuthNumber		카드승인번호
goodPrice		상품 금액

7.6.4. 응답 예제

payappsample://result?csturl=&state=&errorMessage=&errorCode=&mul_no=&cardName=&cardNum=&date=&installment=&goodName=&cardAuthNumber=&goodPrice=

7.7. NFC(삼성페이) 결제

7.7.1. 설명

삼성페이를 이용한 결제입니다.

(단, 페이앱이 실행중이면 삼성페이를 단말에서 인식 못하므로, 페이앱을 종료해야 합니다.)

7.7.2. 호출

파라메터	필수	비고
payappSamsung Payment	1	페이앱의 NFC 삼성페이 결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.7.3. 응답

파라메터	값	비고
state		결과
mul_no		페이앱 결제 번호
csturl		페이앱 영수증 URL
errorMessage		에러 메시지
errorCode		에러 코드
cardName		카드사 이름
cardNum		카드 번호
date		결제 일시
installment		할부개월
goodName		상품명
cardAuthNumber		카드승인번호
goodPrice		상품 금액

7.7.4. 응답 예제

payappsample://result?csturl=&state=&errorMessage=&errorCode=&mul_no=&cardName=&cardNum=&date=&installment=&goodName=&cardAuthNumber=&goodPrice=

7.8. 정기결제

7.8.1. 설명

정기결제를 이용한 결제입니다.

7.8.2. 호출

파라메터	필수	비고
payappFixedPeri odPayment	1	페이앱의 정기결제 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.8.3. 응답

파라메터	값	비고
rebill_no		정기결제 번호
payurl		정기결제 URL

7.8.4. 응답 예제

payappsample://result?payurl=&rebill_no=

7.9. 현금영수증 결제

7.9.1. 설명

현금영수증 발행 기능입니다..

7.9.2. 호출

파라메터	필수	비고
payappCashReceiptPayment	1	페이앱의 현금영수증 scheme
default	1	페이앱의 host
mode	1	모드 값 (default : request)
phoneNumber	1	구매자 휴대폰
goodPrice	1	구매 금액
goodName	1	상품명
callback_url	1	페이앱을 호출 후 결과 받을 앱의 host
scheme		페이앱을 호출 후 결과 받을 앱의 Scheme
application_id	1	페이앱을 호출 하는 앱의 package name

7.9.3. 응답

파라메터	값	비고
state		현금영수증 발행 결과

7.9.4. 응답 예제

payappsample://result?state=

8. 등록결제 (BILL)

8.1. 등록결제 (BILL) 등록

8.1.1. 설명

- 호출 파라메터 중 cmd, userid, linkkey , cardNo, expMonth, expYear, cardpw, buyerAuthNo, buyerPhone, buyerName 값은 필수 입니다.

- 등록결제 (BILL)은 신용카드를 미리 등록해놓고 필요할때 결제하는 방식입니다.

8.1.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

8.1.3. 호출

파라메터	필수	비고
cmd	1	등록결제(BILL) 등록 : billRegist
userid	1	판매자 회원 아이디
cardNo	1	카드번호
expMonth	1	카드 유효기간(월)
expYear	1	카드 유효기간(년)
buyerAuthNo	1	구매자확인 개인:생년월일(YYMMDD) 6자리, 사업자번호
cardPw	1	카드 비밀번호 앞 두자리
buyerPhone	1	구매자 전화번호
buyerName	1	구매자 성함
buyerId	0	구매자 아이디

8.1.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
encBill		등록결제(BILL) 연동키
cardNo		카드번호
cardname

8.1.5. 응답 예제

state=1&errorMessage=&errno=00000&encBill=song_2322132222&cardno=4518%2A%2A%2A%2%2A%2A%2A%2A1111&cardname=%5B%EC%8B%A0%ED%95%9C%5D

8.2. 등록결제 (BILL) 결제

8.2.1. 설명

- 호출파라미터중 cmd,userid,encBill,goodname,price,recvphone,amount_taxable,amount_taxfree,amount_vat 값은 필수 입니다.

- 등록결제 (BILL) 등록으로 등록된 encBill 값으로 즉시 결제승인을 받습니다.

8.2.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

8.2.3. 호출

파라메터	필수	비고
cmd	1	등록결제(BILL) 결제 : billPay
userid	1	판매자 회원 아이디
encBill	1	등록결제(BILL) 연동키
goodname	1	상품명
price	1	상품가격
recvphone	1	구매자 전화번호
amount_taxable		공급가액
amount_taxfree		면세금액
amount_vat		부가세
feedbackurl		결제완료 후 결과값을 리턴받을 고객사 URL 응답내용은 2.4 참조
var1		사용자 임의변수 1
var2		사용자 임의변수 2
checkretry		common_feedbackurl 재시도(y:재시도, n:재시도 안함) common_feedbackurl의 응답값 SUCCESS가 아니면 common_feedbackurl 호출을 재시도 합니다.(총 10회 재시도)
cardinst		카드할부 개월 수(‘00’,’01’…) 50,000원이상부터 할부 가능

8.2.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열
CSTURL		영수증 url
price		결제금액
mul_no		결제요청번호

8.2.5. 응답 예제

state=1&errorMessage=&errno=00000&CSTURL=https%3A%2F%2Fwww.payapp.kr%2FCST%2xxxdf&price=1000&mul_no=12234567

8.3. 등록결제 (BILL) 삭제

8.3.1. 설명

- 호출파라미터중 cmd,userid,encBill 값은 필수 입니다.

8.3.2. REST URL

- https://api.payapp.kr/oapi/apiLoad.html

8.3.3. 호출

파라메터	필수	비고
cmd	1	등록결제(BILL) 삭제 : billDelete
userid	1	판매자 회원 아이디
encBill	1	등록결제(BILL) 연동키

8.3.4. 응답

파라메터	값	비고
state	1	성공
state	0	실패
errorMessage		실패시 오류 문자열

8.3.5. 응답 예제

state=1&errorMessage=&errno=00000