PayApp 서비스 연동 매뉴얼 입니다.

• 판매자 관리 사이트의 메뉴 "설정"탭의 "연동 Key", "연동 Value" 값으로 연동이 가능합니다.
• 본 연동 매뉴얼에 설명하는 API는 서버에서 호출하는 API로 사용자에게 보여지는 디자인이 되어있지 않습니다.
• 샘플 파일은 결제연동을 위해 기본적인 사항만 기재되어 있으므로 실제 개발 시에는 샘플 페이지를 참고하여 고객사의 환경에 맞게 연동 하시기 바랍니다.
• 결제 샘플 코드는 참조용으로 결제 연동 개발에 대한 모든 책임은 가맹점에 있습니다.
• 연동 매뉴얼에 설명하는 API의 값을 임의로 변조,변형 하신 경우 결제가 원활하게 이뤄지지 않을 수 있으며, 최신 업데이트가 적용되지 않기 때문에 동작을 보장할 수 없습니다.
• 기능 추가에 따라 필드가 추가될 수 있습니다. 연동시 필드가 추가될 수 있음을 고려해서 연동해야 합니다.
• 매뉴얼 다운로드

연동 API 구성방법

연동 환경

• 자체개발된 서버사이드 스크립트 언어가 연동가능한 개발환경이라면 페이앱 API 연동이 가능합니다.
• 임대형 쇼핑몰을 이용중이시라면 임대를 해준 업체에 페이앱 API 연동을 문의하셔야 합니다.(예 : 카페24, 고도몰, 메이크샵 등..)
• 템플릿형 사이트나 쇼핑몰을 이용중이시라면 소스코드의 편집 및 수정이 가능한 템플릿에서만 페이앱 API 연동이 가능합니다.

연동 방법

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

REST API URL 주소

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

호출 파라메터

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

응답 파라메터

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

연동 KEY, VALUE

• 판매자 회원가입 후 판매자 관리 사이트의 메뉴 “설정” 탭의 “연동 정보” 값이 있어야 연동이 가능합니다.
• 연동 정보 값은 판매자 회원마다 값이 다르며 영문 대/소문자, 숫자, 기호로 구성되어 있습니다.
• 연동 정보 값은 보안상의 이유로 외부로 유출이 되지 않도록 주의 하시기 바랍니다.

테스트 정보

• 판매자 회원 아이디 userid payapptest

연동 예제

• 현재 페이지의 연동 예제는 기본 PHP 제공
• 매뉴얼을 다운로드 하시면 PHP, JSP 예제파일이 있으며 연동문서를 같이 다운받을 수 있습니다.

오류코드

빠른시작(Quick Start)

• 고객사의 프로그램에 맞게 수정 하셔서 사용하셔야 합니다.
• 매뉴얼의 예제 프로그램으로 작성되었습니다.(결제 요청 JS API 연동)
• 매뉴얼의 JS(https://lite.payapp.kr/public/api/v2/payapp-lite.js)를 임의로 변경하실 경우, 연동이 원활하게 이뤄지지 않을 수 있으며, 최신 업데이트가 적용되지 않기 때문에 동작을 보장할 수 없습니다.

결제요청 API

결제요청 연동 구성

연동 방식

• 결제 요청 연동은 "결제 요청 연동 (JS)", "결제 요청 연동 (REST)" 방식 두가지가 있습니다.
• 2개의 연동 방식 중 고객사의 연동 상황에 맞게 이용하시면 됩니다.

연동 구성

• REST API를 이용할 경우 샘플기준 payapp_payrequest.php, payapp_feedbackurl.php 를 참고하시면 됩니다.
• JS API를 이용할 경우 payapp_payrequest_js.php, payapp_feedbackurl.php 를 참고하시면 됩니다.

결제 요청 – JS 방식

• JS 방식은 자바스크립트를 이용해 고객사 웹페이지에 쉽게 연동을 진행하는 API입니다.
• "JS API" 는 PAYAPP REST API 를 HTML 및 자바스크립트를 이용해 연동할 수 있도록 제작된 WRAPPER API 입니다.
• 연동 매뉴얼 "빠른 시작"을 참고 하시기 바랍니다.
• 매뉴얼의 JS(https://lite.payapp.kr/public/api/v2/payapp-lite.js)를 임의로 변경하실 경우, 연동이 원활하게 이뤄지지 않을 수 있으며, 최신 업데이트가 적용되지 않기 때문에 동작을 보장할 수 없습니다.

시작하기

<script src="https://lite.payapp.kr/public/api/v2/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('{폼이름}');

2. 자바스크립트 사용

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

결제창 호출

PayApp.payrequest();

파라메터 목록

자바스크립트 메써드

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.payrequest();

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

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

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

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

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

연동 예제

HTML 폼 사용

<script src="https://lite.payapp.kr/public/api/v2/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="https://lite.payapp.kr/public/api/v2/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="https://lite.payapp.kr/public/api/v2/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="https://lite.payapp.kr/public/api/v2/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');
PayApp.setDefault('shopname',   '좋은상점');
</script>

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

결제요청 연동

결제 요청 – REST 방식

• REST 방식은 모바일 기기, 브라우저 등 다양한 단말기와 프로그램을 지원하는 API입니다.
• 호출 파라메터 중 userid,goodname,price,recvphone 값은 필수 입니다.
• feedbackurl 의 값은 “http://” 가 포함된 url 주소 값입니다.
• 구매자가 결제완료시feedbackurl로 아래 “feedbackurl 전달”파라메터가 POST방식으로 전달 됩니다.
• feedbackurl에서 다른 url로 리다이렉션(http code 302, 또는 javascript) 처리하시면 자료전달이 되지 않습니다.
  (feedbackurl 이외 다른페이지로 이동되지 않습니다.)
• var1, var2 의 값은 임의로 사용이 가능하며 결제 완료시feedbackurl로 그대로 전달이 됩니다.
• 결제요청 구분 (reqmode)가 usd (달러결제) 인 경우 openpaytype은 무시됩니다.
  (신용카드 결제만 가능)
• goodname, memo 항목에는 URI 주소가 포함될 수 없습니다.
• 안드로이드와 아이폰 앱의 연동일 경우 하단 파라메터 목록의 appurl을 반드시 포함하여 전송해 주셔야 합니다.
  예제 파일을 다운로드 받으셔서 카드사 스키마를 참고 후 연동바랍니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=payrequest" \
-d "userid=[고객사 아이디]" \
-d "goodname=api%20test" \
-d "price=1000" \
-d "recvphone=[구매자 휴대전화 번호]" \
-d "smsuse=n" \
https://api.payapp.kr/oapi/apiLoad.html

응답

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

연동 예제

• http://고객사 도메인/payapp_popup.php
• 구매자가 결제를 요청하는 페이지입니다. 고객사에서 개발하시는 페이지입니다.
• 예제파일 payapp_request.php로 post전송합니다.
• "{변수}"는 개발환경에 맞추어서 정의바랍니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

• http://고객사 도메인/payapp_request.php
• 고객사 서버에서 페이앱서버로 결제를 요청하는 페이지입니다.
• 결제요청 후 리턴되는 $oResData값으로 결제요청성공 또는 결제요청실패를 확인하셔야 합니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

• http://고객사 도메인/payapp_lib.php
• 결제요청시 사용되는 라이브러리 파일입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

실행순서 참고

Feedbackurl 전달

• 결제요청 API의 feedbackurl 파라메터에 해당하는 웹노티 페이지입니다.
• “공통 통보 URL” (판매자 관리 사이트의 “설정” > “연동정보”)에서도 동일한 웹노티 데이터를 전달합니다.
  결제요청 API의 feedbackurl을 사용하실 때에는 공통통보URL을 설정하지 않아도 이용이 가능합니다.
• 판매자 관리 사이트의 메뉴 “설정” 탭의 “연동 VALUE” 값과 feedbackurl로 전달되는 linkval 값이 같은 경우에만 정상 호출입니다.
• 유효성 검증을 위해 결제 요청 금액을 확인 하시기 바랍니다.
• feedbackurl, 공통 통보 URL은 여러 번 호출 될 수 있습니다. 중복처리 되지 않도록 mul_no, var1, var2를 이용해 중복방지 하셔야 합니다
• feedbackurl에 해당되는 페이지의 HTTP Code '200'이고 응답(response)으로 'SUCCESS'인 경우 성공, 아닌경우 응답 실패로 확인합니다.
• 결제요청 상태(pay_state)의 1:요청 상태는 JS API 연동을 하신 경우에만 NOTI됩니다.
• 통보받은 데이터는 반드시 Server-Side에서 처리 하고, 민감 정보가 외부에 노출되지 않도록 주의하셔야 합니다.
• 기능 추가 및 결제수단 추가에 따라 통보되는 데이터의 필드가 추가될 수 있습니다. 가맹점에서는 통보 데이터에 필드가 추가될 수 있음을 고려해서 연동해야 합니다.

• http://고객사 도메인/payapp_feedbackurl.php
• 결제완료시 페이앱서버에서 고객사 서버로 결과값을 리턴하는 페이지입니다.
• 결제성공 또는 결제취소시 페이앱서버에서 결과값을 POST로 전송하오니 확인 후 처리하시면 되겠습니다.
• 결과 파라메터는 결제통보 (feedbackurl)을 참고하시기 바랍니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

등록결제 등록(BILL)

등록결제(BILL) 등록– REST 방식

• REST 방식은 모바일 기기, 브라우저 등 다양한 단말기와 프로그램을 지원하는 API입니다.
• 호출 파라메터 중 cmd,userid,linkkey,cardNo,expMonth,expYear,cardpw,buyerAuthNo,buyerPhone,buyerName 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=billRegist" \
-d "userid=[고객사 아이디]" \
-d "cardNo=[구매자 카드번호]" \
-d "expMonth=[구매자 카드유효기간(월)]" \
-d "expYear=[구매자 카드유효기간(년)]" \
-d "buyerAuthNo=[구매자 본인확인 생년월일(YYMMDD)]" \
-d "cardPw=[구매자 카드 비밀번호 앞 두자리]" \
-d "buyerPhone=[구매자 휴대전화 번호]" \
-d "buyerName=[구매자 성함]" \
-d "buyerId=[구매자 아이디]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

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

등록결제 등록 연동 예제

• https://고객사 도메인/payapp_billregist.php
• 등록결제 등록시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

등록결제(BILL) 삭제 API

등록결제(BILL) 삭제– REST 방식

• REST 방식은 모바일 기기, 브라우저 등 다양한 단말기와 프로그램을 지원하는 API입니다.
• 호출 파라메터 중 cmd,userid,encBill 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=billDelete" \
-d "userid=[고객사 아이디]" \
-d "encBill=[등록결제 연동키]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

 state=1&errorMessage=&errno=00000

등록결제 삭제 연동 예제

• https://고객사 도메인/payapp_billdelete.php
• 등록결제 삭제시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

등록결제(BILL) 결제 API

등록결제(BILL) 결제– REST 방식

• REST 방식은 모바일 기기, 브라우저 등 다양한 단말기와 프로그램을 지원하는 API입니다.
• 호출 파라메터 중 cmd,userid,encBill,goodname,price,recvphone,amount_taxable,amount_taxfree,amount_vat 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=billRegist" \
-d "userid=[고객사 아이디]" \
-d "encBill=[등록결제 연동키]" \
-d "goodname=[상품명]" \
-d "price=[상품가격]" \
-d "recvphone=[구매자 전화번호]" \
-d "amount_taxable=[공급가액]" \
-d "amount_taxfree=[면세금액]" \
-d "amount_vat=[부가세]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

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

등록결제 결제 연동 예제

• https://고객사 도메인/payapp_billpay.php
• 페이앱 대리점, 리셀러가 리셀러 또는 판매자를 가입하는 연동입니다.
• 예제파일 및 데이터는 고객사의 개발환경에 맞추시기 바랍니다.

정기결제 요청 연동 구성

연동 방식

• 결제 요청 연동은 "JS API", "REST API" 방식 두가지가 있습니다.
• 2개의 연동 방식 중 고객사의 연동 상황에 맞게 이용하시면 됩니다.

정기 결제 요청 – JS 방식

• JS 방식은 자바스크립트를 이용해 고객사 웹페이지에 쉽게 연동을 진행하는 API입니다.
• "JS API" 는 PAYAPP REST API 를 HTML 및 자바스크립트를 이용해 연동할 수 있도록 제작된 WRAPPER API 입니다.
• 매뉴얼의 JS(https://lite.payapp.kr/public/api/v2/payapp-lite.js)를 임의로 변경하실 경우, 연동이 원활하게 이뤄지지 않을 수 있으며, 최신 업데이트가 적용되지 않기 때문에 동작을 보장할 수 없습니다.

스크립트 주소

<script src="https://lite.payapp.kr/public/api/v2/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('{폼이름}');

2. 자바스크립트 사용

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

결제창 호출

PayApp.rebill();

파라메터 목록

자바스크립트 메써드

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.rebill();

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

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

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

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

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

연동 예제

HTML 폼 사용

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

<form name="MyForm">
    <input type="hidden" name="userid"    value="payapptest">
    <input type="hidden" name="goodname"  value="착한상품">
    <input type="hidden" name="goodprice" value="1000">
    <input type="hidden" name="recvphone" value="01000000000">
    <input type="hidden" name="smsuse" value="n">
    <input type="hidden" name="rebillCycleType"  value="Month">
    <input type="hidden" name="rebillCycleMonth" value="10">
    <input type="hidden" name="rebillExpire"     value="2025-10-20">
</form>

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

자바스크립트 사용

<script src="https://lite.payapp.kr/public/api/v2/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');

function myPay() {
    PayApp.setParam('goodname',  '착한상품');
    PayApp.setParam('goodprice', '1000');
    PayApp.setParam('recvphone', '01000000000');
    PayApp.setParam('smsuse', 'n');
    PayApp.setParam('rebillCycleType',  'Month');
    PayApp.setParam('rebillCycleMonth', '10');
    PayApp.setParam('rebillExpire',     '2025-10-20');
    PayApp.rebill();
}
</script>

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

자바스크립트 사용 #2

<script src="https://lite.payapp.kr/public/api/v2/payapp-lite.js"></script>
<script>
PayApp.setDefault('userid',     'payapptest');
PayApp.setDefault('recvphone', '01000000000');
PayApp.setDefault('smsuse', 'n');
PayApp.setDefault('rebillCycleType',  'Month');
PayApp.setDefault('rebillCycleMonth', '10');
PayApp.setDefault('rebillExpire',     '2025-10-20');
</script>

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

정기결제

정기 결제 요청 – REST 방식

• 정기 결제를 위한 정기 결제 요청을 등록하는 API입니다.
• 정기 결제 요청 등록 후 payurl로 구매자가 최초 1회 결제 승인이 성공하면 다음 결제 주기에 정기 결제가 발생됩니다.
• 결제 승인이 발생되면 feedbackurl로 NOTI가 발생됩니다.("Feedbackurl 전달" 참고)
• 휴대전화 정기 결제는 월 정기 결제만 이용이 가능합니다.
• 호출 파라메터 중 cmd, userid, goodname, goodprice, recvphone, rebillCycletype, rebillExpire 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=rebillRegist" \
-d "userid=[고객사 아이디]" \
-d "goodname=[상품명]" \
-d "goodprice=[정기 결제 요청 금액]" \
-d "recvphone=[수신 휴대전화 번호]" \
-d "rebillCycleType=[정기결제 주기 구분 (Month,Week,Day)]" \
-d "rebillCycleMonth=[월 정기결제 결제일]" \
-d "rebillExpire=[정기결제 만료일]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

state=1&errorMessage=&errno=00000&rebill_no=1&payurl=http%3A%2F%2Fpayapp.kr%2F000000000000

정기결제 요청 예제

• https://고객사 도메인/payapp_rebillrequest.php
• 정기결제 요청시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

정기 결제 해지 API

정기 결제 해지 API

• 정기 결제 해지가 되면 다음 정기 결제 주기에 정기 결제가 발생되지 않습니다.
• 해지된 정기결제는 “승인”으로 변경되지 않습니다.
• 호출 파라메터 중 cmd,userid,rebill_no,linkkey 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=rebillCancel" \
-d "userid=[고객사 아이디]" \
-d "rebill_no=[정기결제요청 등록번호]" \
-d "linkkey=[연동 KEY]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

 state=1&errorMessage=&errno=00000

정기결제 해지 예제

• https://고객사 도메인/payapp_rebillcancel.php
• 정기결제 해지시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

정기결제 일시정지 API

정기결제 일시정지 API

• 정기 결제 요청 건의 상태가 “승인”인 경우 일시정지가 가능합니다.
• 일시정지된 정기 결제 건은 다음 결제 주기에 정기 결제가 발생되지 않습니다.
• 일시정지된 정기 결제 건은 “승인” 상태로 변경이 가능합니다.
• 호출 파라메터 중 cmd,userid,rebill_no,linkkey 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=rebillStop" \
-d "userid=[고객사 아이디]" \
-d "rebill_no=[정기결제요청 등록번호]" \
-d "linkkey=[연동 KEY]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

 state=1&errorMessage=

정기결제 일시정지 예제

• https://고객사 도메인/payapp_rebillstop.php
• 정기결제 일시정지시 사용되는 페이지입니다.
• 예제파일 및 데이터는 고객사의 개발환경에 맞추시기 바랍니다.

정기결제 승인 API

정기결제 승인 API

• 정기 결제 요청 건의 상태가 “일시정지”인 경우 승인 상태로 변경이 가능합니다.
• 승인 상태인 정기 결제 건은 다음 결제 주기에 정기 결제가 발생합니다.
• 호출 파라메터 중 cmd,userid,rebill_no,linkkey 값은 필수 입니다.
• REST URL :
  https://api.payapp.kr/oapi/apiLoad.html

호출 파라메터 목록

curl -d "cmd=rebillStart" \
-d "userid=[고객사 아이디]" \
-d "rebill_no=[정기결제요청 등록번호]" \
-d "linkkey=[연동 KEY]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

 state=1&errorMessage=

정기결제 승인 예제

• https://고객사 도메인/payapp_rebillstart.php
• 정기결제 승인변경시 사용되는 페이지입니다.
• 예제파일 및 데이터는 고객사의 개발환경에 맞추시기 바랍니다.

결제 (요청,승인) 취소

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

호출

curl -d "cmd=paycancel" \
-d "userid=[고객사 아이디]" \
-d "linkkey=[연동 KEY]" \
-d "mul_no=[결제요청번호]" \
-d "cancelmemo=[결제요청취소 메모]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

state=1&errorMessage=

결제 취소 연동 예제

• http://고객사 도메인/payapp_paycancel.php
• 결제(요청,승인) 취소시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

결제 취소 요청

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

호출

curl -d "cmd=paycancelreq" \
-d "userid=[고객사 아이디]" \
-d "linkkey=[연동 KEY]" \
-d "mul_no=[결제요청번호]" \
-d "cancelmemo=[결제요청취소 메모]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

state=1&errorMessage=

결제 취소 요청 연동 예제

• http://고객사 도메인/payapp_paycancel.php
• 결제 취소 요청시 사용되는 페이지입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

판매자 회원 가입

• 대리점이 리셀러를, 리셀러가 판매자를 가입하는 연동입니다.
• resellerid는 대리점 또는 리셀러 아이디를 입력하셔야 합니다.
• REST URL :
  https://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의 피드백은 하나의 결제요청건에 대해 여러 번 피드백 될 수 있으니, 결제상태/결제요청번호에 따라 적절한 연동을 하셔야 합니다.

curl -d "cmd=sellerRegist" \
-d "userid=[고객사 아이디]" \
-d "userpwd=[비밀번호]" \
-d "sellername=[판매자명]" \
-d "phone=[판매자휴대전화번호]" \
-d "email=[이메일]" \
-d "bizkind=[서비스 구분]" \
-d "usertype=[판매자 구분]" \
-d "resellerid=[대리점,리셀러 아이디]" \
-d "join_type=[가입형태]" \
-d "seller_type=[가입구분]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

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

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

호출

curl -d "cmd=useridCheck" \
-d "userid=[고객사 아이디]" \
-d "resellerid=[대리점(리셀러)아이디]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

판매자 회원가입 연동 예제

• http://고객사 도메인/payapp_sellerRegist.php
• 페이앱 대리점, 리셀러가 리셀러 또는 판매자를 가입하는 연동입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

판매자 회원아이디 중복체크 연동 예제

• http://고객사 도메인/payapp_useridCheck.php
• 페이앱 대리점, 리셀러가 리셀러 또는 판매자를 가입시키고자 할때 아이디 중복체크 하는 연동입니다.

부계정 등록

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

호출

조직분류 관리 subetc1

조직분류 관리 subetc2

조직분류 관리 subetc3

권한설정 state

curl -d "cmd=subidregist" \
-d "userid=[고객사 아이디]" \
-d "subuserid=[부계정 아이디]" \
-d "subpwd=[부계정 비밀번호]" \
-d "subname=[부계정명]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

부계정등록 연동 예제

• http://고객사 도메인/payapp_subidRegist.php
• 직급별로 부계정을 등록하는 연동입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

현금영수증 발행

• 현금영수증 발행은 거래일로 부터 6일이내 발행이 가능합니다
• 발행한 날짜의 3일 후 '현금영수증.kr'에서 확인이 가능합니다.
• 현금영수증 발행 시 거래금액의 합계금액은 "공급가액+봉사료+부가가치세"입니다.
• 자진발급 : 발급대상 전 거래에 대하여 현금영수증이 발급이 가능합니다.(고객 미신청의 경우 id_info = '0100001234')

호출

curl -d "cmd=cashStRegist" \
-d "userid=[고객사 아이디]" \
-d "good_name=[상품명]" \
-d "buyr_name=[구매자명]" \
-d "id_info=[휴대폰(사업자)번호]" \
-d "trad_time=[원거래시각]" \
-d "tr_code=[발행용도]" \
-d "amt_tot=[거래금액]" \
-d "amt_sup=[공급가액]" \
-d "amt_svc=[봉사료]" \
-d "amt_tax=[부가가치세]" \
-d "corp_tax_type=[과세(면세)]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

현금영수증 취소

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

호출

• cashstno : 발행시 저장했던 발행번호

응답

현금영수증 발행 연동 예제

• http://고객사 도메인/payapp_cashst.php
• 현금영수증을 발행하는 연동입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

현금영수증 취소 연동 예제

• http://고객사 도메인/payapp_cashstcn.php
• 현금영수증을 취소하는 연동입니다.
• 예제파일의 위치는 고객사의 개발환경에 맞추시기 바랍니다.

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

• 네이버페이 현금영수증 발행대상 금액조회 연동입니다.
• 네이버페이로 결제된 주문건만 조회 가능합니다.

호출

curl -d "cmd=checkNpayCashReceiptReq" \
-d "userid=[고객사 아이디]" \
-d "mul_no=[결제요청번호]" \
https://api.payapp.kr/oapi/apiLoad.html

응답

PayApp APP 연동 구성

• 페이앱 APP은 판매자용입니다. 따라서 고객사 판매자용으로 이용이 가능합니다.
• 페이앱 판매자의 대면결제, 결제요청하는 용도로 이용이 가능합니다.
• 쇼핑몰과 같은 서비스에는 "결제요청" 연동을 이용하시기 바랍니다.
• 페이앱 APP에 로그인되어 있는 상태에서 페이앱 APP을 호출하는 연동입니다.

원격 결제

• (고객사 APP > 페이앱 APP > 결제요청 연동) 으로 연동되는 방식입니다.
• 결제하시는 분에게 결제요청 SMS을 발송하여 결제를 받을때 사용합니다.
• 호출 URI :
  https://payapp.kr/sdk-app

응답

대면 결제

• 카메라(OCR) : 휴대전화 카메라로 신용카드 결제를 합니다.
• 수기 결제 : 카드번호, 유효기간, 비밀번호, 본인확인(생년월일)을 입력하여 신용카드 결제를 합니다.
• 네이버페이,카카오페이,스마일페이,애플페이,페이코,위챗페이 : PayApp APP에서 QR을 생성해서 결제하시는 분의 휴대전화에서 결제를 합니다.
• NFC, 삼성페이 : 안드로이드 휴대전화에서만 지원가능하며, 휴대전화의 NFC모드 "기본모드"로 설정, 카드종류에 따라 지원이 안될 수 있습니다.
• 호출 URI :
  https://payapp.kr/sdk-app

응답