연동 API 구성방법

연동 방법

• 웹사이트 api.payapp.kr의 REST URL 페이지를 호출해서 응답 값을 받아 연동합니다.
• REST API URL 페이지 호출은 서버에서 실행이 되어야 합니다. (Server Side 호출)

REST API URL 주소

• http://api.payapp.kr/oapi/apiLoad.html

호출 파라메터

• 호출 파라메터는 FORM POST 방식으로 REST API URL 주소에 전달합니다.
• 호출 파라메터의 각 값은 UTF-8로 인코딩된 문자열 이어야 합니다.

응답 파라메터

• 응답 파라메터는 KEY, VALUE 쌍으로 URL encoding된 query 값으로 생성됩니다.

연동 KEY

• 판매자 회원가입 후 판매자 관리 사이트의 메뉴 “설정” 탭의 “연동 정보” 값이 있어야 연동이 가능합니다.
• 연동 정보 값은 판매자 회원마다 값이 다르며 영문 대/소문자, 숫자, 기호로 구성되어 있습니다.

결제요청 연동API

결제 요청– REST 방식

• 호출 파라메터 중 userid,goodname,price,recvphone 값은 필수 입니다.
• feedbackurl 의 값은 “http://” 가 포함된 url 주소 값입니다
• 구매자가 결제완료시feedbackurl로 아래 “feedbackurl 전달”파라메터가 POST방식으로 전달 됩니다.
• feedbackurl에서 다른 url로 리다이렉션(http code 302, 또는 javascript) 처리하시면 자료전달이 되지 않습니다.
  (feedbackurl 이외 다른페이지로 이동되지 않습니다.)
• var1, var2 의 값은 임의로 사용이 가능하며 결제 완료시feedbackurl로 그대로 전달이 됩니다.
• 결제요청 구분 (reqmode)가 usd (달러결제), unionpay (중국은련카드결제) 인 경우 openpaytype은 무시됩니다.
  (신용카드 결제만 가능)
• 결제요청 구분 (reqmode)가 usd (달러결제) 인 경우 price (결제요청금액)은 1000일 경우 $10.00 입니다.
• REST URL :
  http://api.payapp.kr/oapi/apiLoad.html

호출

응답

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

결제 요청 – 팝업창 방식

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

시작하기

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

파라메터 설정

1. HTML 폼 사용

HTML

<form name="{폼이름}">
    <input type="hidden" name="{파라메터1}" value="{설정값1}">
    <input type="hidden" name="{파라메터2}" value="{설정값2}">
</form>

자바스크립트

PayApp.setForm('{폼이름}');

결제창 호출

PayApp.call();

파라메터 목록

자바스크립트 메써드

PayApp.setForm('{폼이름}');

var form;
form = document.forms['{폼이름}'];
form = document.getElementById('{폼아이디}');
PayApp.setForm(form);

PayApp.setDefault('{파라메터1}', '{설정값1}');
PayApp.setDefault('{파라메터2}', '{설정값2}');

PayApp.setDefault({
    '{파라메터1}': '{설정값1}',
    '{파라메터2}': '{설정값2}'
});

PayApp.setParam('{파라메터1}', '{설정값1}');
PayApp.setParam('{파라메터2}', '{설정값2}');

PayApp.setParam({
    '{파라메터1}': '{설정값1}',
    '{파라메터2}': '{설정값2}'
});

PayApp.setTarget('{타겟}');

PayApp.call();

PayApp.call({
    '{파라메터1}': '{설정값1}',
    '{파라메터2}': '{설정값2}'
});

// 폼 등록. 결제창 호출
PayApp.setForm('MyForm').call();

// 상품명 설정. 가격 설정. 결제창 호출.
PayApp.setParam('goodname', '좋은상품').setParam('price', '2000').call();

// jQuery 버전 확인
alert(PayApp.$().jquery);

// 1. 결제버튼 비활성화
PayApp.$('#pay-button').attr('disabled', 'disabled');
// 2. 결제창 호출
PayApp.call();
// 3. 결제버튼 활성화
PayApp.$('#pay-button').removeAttr('disabled');

연동 예제

HTML 폼 사용

<script src="http://lite.payapp.kr/public/api/payapp-lite.js"></script>
<script>
function myPay() {
    PayApp.setForm('MyForm');
    PayApp.call();
}
</script>

<form name="MyForm">
    <input type="hidden" name="userid"   value="payapptest">
    <input type="hidden" name="shopname" value="좋은상점">
    <input type="hidden" name="goodname" value="착한상품">
    <input type="hidden" name="price"    value="1000">
</form>

<a href="#" onclick="myPay();">결제하기</a>

자바스크립트 사용

<script src="http://lite.payapp.kr/public/api/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');
PayApp.setDefault('shopname',   '좋은상점');

function myPay() {
    PayApp.setParam('goodname', '착한상품');
    PayApp.setParam('price',    '1000');
    PayApp.call();
}
</script>

<a href="#" onclick="myPay();">결제하기</a>

자바스크립트 사용 #2

<script src="http://lite.payapp.kr/public/api/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');
PayApp.setDefault('shopname',   '좋은상점');
</script>

<a href="#" onclick="PayApp.setParam('goodname', '좋은상품').setParam('price', '1000').call();">좋은상품 결제하기</a>
<a href="#" onclick="PayApp.call({'goodname': '보통상품', 'price': '2000'});">보통상품 결제하기</a>
<a href="#" onclick="PayApp.call({'goodname': '나쁜상품', 'price': '3000'});">나쁜상품 결제하기</a>

사용자 입력 결제창 제작

<script src="http://lite.payapp.kr/public/api/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');
PayApp.setDefault('shopname',   '좋은상점');
</script>

<a href="#" onclick="PayApp.call();">결제하기</a>

테스트 정보

Feedbackurl 전달

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

결제 (요청,승인) 취소

• 호출 파라메터 중 userid, linkkey, mul_no 값은 필수 입니다.
• “결제 요청” 연동 에서 feedbackurl을 입력된 결제요청 건 경우에는 결제 요청 취소 성공시“Feedbackurl 전달” 으로 자료가 전송됩니다.
• REST URL :
  http://api.payapp.kr/oapi/apiLoad.html

호출

응답

state=1&errorMessage=

결제 취소 요청

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

호출

응답

state=1&errorMessage=

판매자 회원 가입

• 대리점이 리셀러를, 리셀러가 판매자를 가입하는 연동입니다.
• resellerid는 대리점 또는 리셀러 아이디를 입력하셔야 합니다.
• REST URL :
  http://api.payapp.kr/oapi/apiLoad.html

호출

• seller_type의 값이“seller”인 경우 resellerid는 리셀러 아이디, seller_type의 값이“reseller”인 경우 resellerid는 대리점 아이디 입니다.
• bizkind : Blog사업자,쇼핑몰사업자,방문판매,음식점(배달),A/S긴급출동,운수업,컨텐츠,도소매,유통,서비스,숙박업,임대업,농수산업,기타
• common_feedbackurl : 결제요청연동시 입력하는 feedbackurl과 별도로 결제상태 피드백을 받으실 수 있습니다.
• common_feedbackurl은 결제요청 없이 결제완료로 통보 될 수 있으며, 결제요청연동으로 연동되지 않는 결제건도 피드백이 됩니다. (모든 결제건에 대해 피드백이 이루어 집니다.)
• common_feedbackurl의 피드백은 하나의 결제요청건에 대해 여러 번 피드백 될 수 있으니, 결제상태/결제요청번호에 따라 적절한 연동을 하셔야 합니다.

응답

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

• 대리점이 리셀러를, 리셀러가 판매자를 가입하기 위해 아이디 중복체크 하는 연동입니다.
• resellerid는 대리점 또는 리셀러 아이디를 입력하셔야 합니다.
• REST URL :
  http://api.payapp.kr/oapi/apiLoad.html

호출

응답