연동준비
국내 카드/계좌결제
샘플코드
페이플 결제 연동을 위한 샘플코드는 아래 버튼을 눌러 확인해주세요.
API 키, 테스트 정보
페이플이 제공하는 테스트 정보를 통해 계약 전 단계에서도 누구나 연동 체험이 가능합니다.
1. 접속정보
내용 | |
---|---|
접속 도메인 | https://democpay.payple.kr |
cst_id | test |
custKey | abcd1234567890 |
clientKey | test_DF55F29DA654A8CBC0F0A9DD4B556486 |
PCD_REFUND_KEY (결제취소 시 이용) | a41ce010ede9fcbfb3be86b24858806596a9db68b79d138b147c3e563e1829a0 |
·요청 header 설정
파트너 인증시 referer 헤더의 값을 결제창이 호출될 도메인으로 입력해주세요. 별도의 테스트 계정을 발급 받으신 경우, 도메인을 검증하므로 등록한 도메인이 포함된 referer로 설정해야합니다.
2. 확인사항
카드결제 | 계좌결제 | |
---|---|---|
인증 | 카드번호, 유효기간으로 카드 인증이 진행됩니다. ·라이브환경에서는 카드번호, 유효기간, 생년월일, 비밀번호로 인증이 진행됩니다. | 실제 계좌로 인증 및 등록이 진행됩니다. |
실결제 여부 | 해당 카드로 실결제가 진행됩니다. | 가상으로 진행되기에 실제 출금이 진행되지 않습니다. |
취소 | 별도 취소처리하지 않아도 24시간 내에 자동 취소됩니다. 전체취소만 가능하며, 라이브 환경에서는 부분취소도 가능합니다. | 가상으로 진행됩니다. |
·라이브 환경 주의사항
오픈 이후에 제공되는 라이브 API 키 정보는 외부에 노출되어서는 안됩니다.
웹훅(Webhook)
페이플 웹훅을 이용하면 결제결과 누락을 방지할 수 있습니다.
1. 수신가능 이벤트
이벤트 | 설명 |
---|---|
결제 완료 | 결제 완료 결과를 수신합니다. |
취소 완료 | 결제 취소 결과를 수신합니다. ·파트너 관리자에서 직접 취소한 건도 포함됩니다. |
결과 지연 | 결제 완료 수신이 지연된 거래 건을 수신합니다. |
결제수단 등록 | 카드/계좌 등록 결과를 수신합니다. |
결제수단 해지 | 파트너 관리자에서 직접 해지 시 결과를 수신합니다. ·API로 해지한 건은 수신되지 않습니다. |
·테스트
테스트는 고객센터(help@payple.kr)를 통해 테스트 계정 발급 후 이용 가능합니다.
·라이브
라이브 환경에서 웹훅 등록은 파트너 관리자 〉 기본정보 메뉴에서 가능합니다.
2. 수신 데이터 설명과 예시
2.1 결제 완료
정기결제에서 중복결제를 방지하려면 PCD_PAY_YEAR,PCD_PAY_MONTH 를 추가해주세요.
국내 카드결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_TYPE": "결제수단",
6 "PCD_CARD_VER": "결제수단 상세(앱카드/정기)",
7 "PCD_PAY_WORK": "결제요청 방식",
8 "PCD_AUTH_KEY": "파트너 인증 토큰 값",
9 "PCD_PAY_REQKEY": "최종 결제요청 승인키",
10 "PCD_PAY_HOST": "파트너 인증 후 본 요청시 필요한 페이플 도메인 주소",
11 "PCD_PAY_URL": "파트너 인증 후 본 요청시 필요한 페이플 도메인 주소",
12 "PCD_PAY_COFURL": "최종 결제요청 URL",
13 "PCD_PAYER_ID": "카드등록 후 리턴받은 빌링키",
14 "PCD_PAYER_NO": "회원번호",
15 "PCD_PAYER_NAME": "결제자 이름",
16 "PCD_PAYER_HP": "휴대전화번호",
17 "PCD_PAYER_EMAIL": "이메일주소",
18 "PCD_PAY_YEAR": "월 중복결제 년",
19 "PCD_PAY_MONTH": "월 중복결제 월",
20 "PCD_PAY_OID": "주문번호",
21 "PCD_PAY_GOODS": "상품명",
22 "PCD_PAY_AMOUNT": "결제 요청금액",
23 "PCD_PAY_DISCOUNT": "페이플 이벤트 할인금액(이용불가)",
24 "PCD_PAY_AMOUNT_REAL": "실 결제금액",
25 "PCD_PAY_TOTAL": "결제금액의 총합계",
26 "PCD_PAY_TAXTOTAL": "과세금액",
27 "PCD_PAY_ISTAX": "과세여부",
28 "PCD_PAY_CARDNAME": "카드사",
29 "PCD_PAY_CARDNUM": "카드번호",
30 "PCD_PAY_CARDQUOTA": "할부 개월 수",
31 "PCD_PAY_CARDTRADENUM": "승인거래 키",
32 "PCD_PAY_CARDAUTHNO": "승인번호",
33 "PCD_PAY_CARDRECEIPT": "매출전표 출력 링크",
34 "PCD_PAY_TIME": "결제완료 시간",
35 "PCD_REGULER_FLAG": "월 중복결제 방지 사용여부",
36 "PCD_SIMPLE_FLAG": "비밀번호 간편결제 방식 선택",
37 "PCD_RST_URL": "결과 리턴 URL / 결제창 호출방식",
38 "PCD_LINK_ADD_PARAM": "링크결제 생성시 추가로 지정한 사용자 정의 파라미터"
39}
국내 카드결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "0000",
4 "PCD_PAY_MSG": "카드승인완료",
5 "PCD_PAY_TYPE": "card",
6 "PCD_CARD_VER": "01",
7 "PCD_PAY_WORK": "CERT",
8 "PCD_AUTH_KEY": "K0VnWlZ5TWZSaG...",
9 "PCD_PAY_REQKEY": "VnfReitkgcREx...",
10 "PCD_PAY_HOST": "https://democpay.payple.kr",
11 "PCD_PAY_URL": "",
12 "PCD_PAY_COFURL": "https://demopcpay.payple.kr...",
13 "PCD_PAYER_ID": "OVA3UUdZSFNiSG...",
14 "PCD_PAYER_NO": "2335",
15 "PCD_PAYER_NAME": "홍길동",
16 "PCD_PAYER_HP": "01012345678",
17 "PCD_PAYER_EMAIL": "test@payple.kr",
18 "PCD_PAY_YEAR": "2022",
19 "PCD_PAY_MONTH": "06",
20 "PCD_PAY_OID": "test06881335001623242176279",
21 "PCD_PAY_GOODS": "테스트상품",
22 "PCD_PAY_AMOUNT": "1000",
23 "PCD_PAY_DISCOUNT": "",
24 "PCD_PAY_AMOUNT_REAL": "1000",
25 "PCD_PAY_TOTAL": "1000",
26 "PCD_PAY_TAXTOTAL": "0",
27 "PCD_PAY_ISTAX": "Y",
28 "PCD_PAY_CARDNAME": "삼성카드",
29 "PCD_PAY_CARDNUM": "1234-****-****-5678",
30 "PCD_PAY_CARDQUOTA": "00",
31 "PCD_PAY_CARDTRADENUM": "298416639827",
32 "PCD_PAY_CARDAUTHNO": "85324231",
33 "PCD_PAY_CARDRECEIPT": "https://www.test.com/receipt/creditcard/view...",
34 "PCD_PAY_TIME": "20220624114407",
35 "PCD_REGULER_FLAG": "N",
36 "PCD_SIMPLE_FLAG": "N",
37 "PCD_RST_URL": "/order_result.html",
38 "PCD_LINK_ADD_PARAM": "{\"params1\":\"val1\",\"params2\":\"val2\"}"
39}
국내 계좌결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_TYPE": "결제수단",
6 "PCD_PAY_WORK": "결제요청 방식",
7 "PCD_AUTH_KEY": "파트너 인증 토큰 값",
8 "PCD_PAY_REQKEY": "최종 결제요청 승인키",
9 "PCD_PAY_HOST": "파트너 인증 후 본 요청시 필요한 페이플 도메인 주소",
10 "PCD_PAY_URL": "파트너 인증 후 본 요청시 필요한 페이플 도메인 주소",
11 "PCD_PAY_COFURL": "최종 결제요청 URL",
12 "PCD_PAYER_ID": "계좌등록 후 리턴받은 빌링키",
13 "PCD_PAYER_NO": "회원번호",
14 "PCD_PAYER_NAME": "결제자 이름",
15 "PCD_PAYER_HP": "휴대전화번호",
16 "PCD_PAYER_EMAIL": "이메일주소",
17 "PCD_PAY_BANKACCTYPE": "개인, 법인 구분",
18 "PCD_PAY_YEAR": "월 중복결제 년",
19 "PCD_PAY_MONTH": "월 중복결제 월",
20 "PCD_PAY_OID": "주문번호",
21 "PCD_PAY_GOODS": "상품명",
22 "PCD_PAY_AMOUNT": "결제 요청금액",
23 "PCD_PAY_DISCOUNT": "페이플 이벤트 할인금액(이용불가)",
24 "PCD_PAY_AMOUNT_REAL": "실 결제금액",
25 "PCD_PAY_TOTAL": "결제금액의 총합계",
26 "PCD_PAY_TAXTOTAL": "과세금액",
27 "PCD_PAY_BANK": "은행 코드",
28 "PCD_PAY_BANKNAME": "은행명",
29 "PCD_PAY_BANKNUM": "계좌번호",
30 "PCD_PAY_ISTAX": "과세여부",
31 "PCD_PAY_TIME": "결제완료 시간",
32 "PCD_REGULER_FLAG": "월 중복결제 방지 사용여부",
33 "PCD_TAXSAVE_FLAG": "현금영수증 발행창 사용여부",
34 "PCD_TAXSAVE_RST": "현금영수증 발행결과",
35 "PCD_TAXSAVE_MGTNUM": "현금영수증 국세청 발행번호",
36 "PCD_SIMPLE_FLAG": "비밀번호 간편결제 방식 선택",
37 "PCD_RST_URL": "결과 리턴 URL / 결제창 호출방식",
38 "PCD_LINK_ADD_PARAM": "링크결제 생성시 추가로 지정한 사용자 정의 파라미터"
39}
국내 계좌결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "BILL0000",
4 "PCD_PAY_MSG": "출금이체완료",
5 "PCD_PAY_TYPE": "transfer",
6 "PCD_PAY_WORK": "CERT",
7 "PCD_AUTH_KEY": "K0VnWlZ5TWZSaGNla1V...",
8 "PCD_PAY_REQKEY": "VnfReitkgcREx...",
9 "PCD_PAY_HOST": "https://democpay.payple.kr",
10 "PCD_PAY_URL": "",
11 "PCD_PAY_COFURL": "https://demopcpay.payple.kr...",
12 "PCD_PAYER_ID": "bitvTm11bEN...",
13 "PCD_PAYER_NO": "2335",
14 "PCD_PAYER_NAME": "홍길동",
15 "PCD_PAYER_HP": "01012345678",
16 "PCD_PAYER_EMAIL": "test@payple.kr",
17 "PCD_PAY_BANKACCTYPE": "personal",
18 "PCD_PAY_YEAR": "2022",
19 "PCD_PAY_MONTH": "06",
20 "PCD_PAY_OID": "test0803729001656045847",
21 "PCD_PAY_GOODS": "테스트상품",
22 "PCD_PAY_AMOUNT": "1000",
23 "PCD_PAY_DISCOUNT": "",
24 "PCD_PAY_AMOUNT_REAL": "1000",
25 "PCD_PAY_TOTAL": "1000",
26 "PCD_PAY_TAXTOTAL": "0",
27 "PCD_PAY_BANK": "011",
28 "PCD_PAY_BANKNAME": "NH농협은행",
29 "PCD_PAY_BANKNUM": "456-*******-123",
30 "PCD_PAY_ISTAX": "과세여부",
31 "PCD_PAY_TIME": "20220624134514",
32 "PCD_REGULER_FLAG": "N",
33 "PCD_TAXSAVE_FLAG": "N",
34 "PCD_TAXSAVE_RST": "N",
35 "PCD_TAXSAVE_MGTNUM": "",
36 "PCD_SIMPLE_FLAG": "",
37 "PCD_RST_URL": "/order_result.html",
38 "PCD_LINK_ADD_PARAM": "{\"params1\":\"val1\",\"params2\":\"val2\"}"
39}
2.2 취소 완료
국내 카드/계좌결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_OID": "주문번호",
6 "PCD_PAY_TYPE": "결제수단",
7 "PCD_PAYER_ID": "카드(계좌) 등록시 리턴받은 빌링키",
8 "PCD_PAY_GOODS": "상품명",
9 "PCD_REFUND_TOTAL": "취소 요청금액",
10 "PCD_REFUND_TAXTOTAL": "취소 요청금액의 부가세",
11 "PCD_PAY_CARDTRADENUM": "취소거래 키",
12 "PCD_PAY_CARDRECEIPT": "매출전표 출력 링크"
13}
국내 카드/계좌결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "PAYC0000",
4 "PCD_PAY_MSG": "승인취소성공",
5 "PCD_PAY_OID": "test06881335001623242176279",
6 "PCD_PAY_TYPE": "card",
7 "PCD_PAYER_ID": "d0to...",
8 "PCD_PAY_GOODS": "테스트상품",
9 "PCD_REFUND_TOTAL": "1000",
10 "PCD_REFUND_TAXTOTAL": "10",
11 "PCD_PAY_CARDTRADENUM": "202206241312548965783400",
12 "PCD_PAY_CARDRECEIPT": "https://www.danalpay.com/receipt/creditcar..."
13}
2.3 결제수단 등록
국내 카드결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_WORK": "등록방식",
6 "PCD_AUTH_KEY": "파트너 인증 토큰 값",
7 "PCD_PAY_TYPE": "등록한 결제수단",
8 "PCD_PAYER_AUTHTYPE": "비밀번호 간편결제 인증방식",
9 "PCD_PAYER_NO": "회원번호",
10 "PCD_PAYER_ID": "카드 등록 후 리턴받은 빌링키",
11 "PCD_PAYER_NAME": "결제자 이름",
12 "PCD_PAYER_EMAIL": "이메일",
13 "PCD_PAYER_HP": "휴대전화번호",
14 "PCD_PAY_CARDNAME": "카드사",
15 "PCD_PAY_CARDNUM": "카드번호",
16 "PCD_RST_URL": "결과 리턴 URL / 결제창 호출방식"
17}
국내 카드결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "0000",
4 "PCD_PAY_MSG": "카드등록이 완료되었습니다.",
5 "PCD_PAY_WORK": "AUTH",
6 "PCD_AUTH_KEY": "K0VnWlZ5TWZSaGNla...",
7 "PCD_PAY_TYPE": "card",
8 "PCD_PAYER_AUTHTYPE": "pwd",
9 "PCD_PAYER_NO": "2335",
10 "PCD_PAYER_ID": "ekNWNW...",
11 "PCD_PAYER_NAME": "홍길동",
12 "PCD_PAYER_EMAIL": "test@payple.kr",
13 "PCD_PAYER_HP": "01012345678",
14 "PCD_PAY_CARDNAME": "NH",
15 "PCD_PAY_CARDNUM": "1234-****-****-7894",
16 "PCD_RST_URL": "/order_result.html"
17}
국내 계좌결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_WORK": "등록방식",
6 "PCD_AUTH_KEY": "파트너 인증 토큰 값",
7 "PCD_PAY_TYPE": "등록한 결제수단",
8 "PCD_PAYER_NO": "회원번호",
9 "PCD_PAYER_ID": "계좌 등록 후 리턴받은 빌링키",
10 "PCD_PAYER_NAME": "결제자 이름",
11 "PCD_PAYER_EMAIL": "이메일",
12 "PCD_PAYER_HP": "결제자 휴대전화번호",
13 "PCD_RST_URL": "결과 리턴 URL / 결제창 호출방식",
14 "PCD_PAY_BANKACCTYPE": "개인, 법인 구분",
15 "PCD_PAY_BANK": "은행 코드",
16 "PCD_PAY_BANKNAME": "은행명",
17 "PCD_PAY_BANKNUM": "계좌번호"
18}
국내 계좌결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "PBER0000",
4 "PCD_PAY_MSG": "계좌등록이 완료되었습니다.",
5 "PCD_PAY_WORK": "AUTH",
6 "PCD_AUTH_KEY": "K0VnWlZ5TWZ...",
7 "PCD_PAY_TYPE": "transfer",
8 "PCD_PAYER_NO": "2335",
9 "PCD_PAYER_ID": "YzZFc3h...",
10 "PCD_PAYER_NAME": "홍길동",
11 "PCD_PAYER_EMAIL": "test@payple.kr",
12 "PCD_PAYER_HP": "01012345678",
13 "PCD_RST_URL": "/order_result.html",
14 "PCD_PAY_BANKACCTYPE": "personal",
15 "PCD_PAY_BANK": "011",
16 "PCD_PAY_BANKNAME": "NH농협은행",
17 "PCD_PAY_BANKNUM": "456-*******-123"
18}
2.4 결제수단 해지
국내 카드결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_WORK": "API 요청 종류",
6 "PCD_PAY_TYPE": "해지한 결제수단",
7 "PCD_PAYER_ID": "카드 등록 후 리턴받은 빌링키",
8 "PCD_PAYER_NO": "회원번호"
9}
국내 카드결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "PUSER0000",
4 "PCD_PAY_MSG": "카드해지완료",
5 "PCD_PAY_TYPE": "card",
6 "PCD_PAY_WORK": "PUSERDEL",
7 "PCD_PAYER_ID": "ekNWNW...",
8 "PCD_PAYER_NO": "1234"
9}
국내 계좌결제
JSON
1{
2 "PCD_PAY_RST": "결과",
3 "PCD_PAY_CODE": "응답 코드",
4 "PCD_PAY_MSG": "응답 메시지",
5 "PCD_PAY_WORK": "API 요청 종류",
6 "PCD_PAY_TYPE": "해지한 결제수단",
7 "PCD_PAYER_ID": "계좌 등록 후 리턴받은 빌링키",
8 "PCD_PAYER_NO": "회원번호"
9}
국내 계좌결제 예시
JSON
1{
2 "PCD_PAY_RST": "success",
3 "PCD_PAY_CODE": "PUER0000",
4 "PCD_PAY_MSG": "계좌해지 완료",
5 "PCD_PAY_TYPE": "transfer",
6 "PCD_PAY_WORK": "PUSERDEL",
7 "PCD_PAYER_ID": "YzZFc3h...",
8 "PCD_PAYER_NO": "2335"
9}