Search
🔗

링크결제 (카드 / 계좌)

1. 정의

링크결제는 결제링크를 생성하여 문자, 카카오톡, 이메일 등의 다양한 채널에서 고객에게 결제를 받을 수 있는 서비스입니다.
링크결제의 생성은 다음과 같은 경로로 수동으로 생성 가능합니다.
해당 문서에서는 API를 통해 자동으로 링크를 생성하는 방법을 소개드립니다.
아래 링크를 클릭해서 링크결제를 직접 체험해보세요.
체험링크이며, 결제된 금액은 자동 취소됩니다.

2. 프로세스 개요

3. 파트너 인증

파트너 서버

Request Message

기본 보기
Search
파라미터 정보
Parameter
더 알아보기
Type (Length)
Parameter value
Reference
custKey
Open
aN(255)
abcd1234567890
파트너 인증키
PCD_PAY_WORK
Open
A(20)
LINKREG
URL링크결제 생성요청 Parameter
COUNT3
요청 파라미터의 Type 보는 방법 에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://democpay.payple.kr/php/auth.php * REAL : https://cpay.payple.kr/php/auth.php */ Request URL: "https://democpay.payple.kr/php/auth.php" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Referer: https://파트너사 도메인 /* ※ Referer 설정 방법 * REAL : referer에는 파트너사 도메인으로 등록된 도메인을 넣어주셔야합니다. * 다른 도메인을 넣으시면 [AUTH0004] 응답이 발생합니다. */
JSON
Referer에 대한 자세한 설명은 이곳에서 확인해보세요!
Body(Payload) 값
{ "cst_id": "test", "custKey": "abcd1234567890", "PCD_PAY_WORK": "LINKREG" }
JSON
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드

Response Message

파트너 인증이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
Parameter
더 알아보기
Parameter value
Reference
server_name
Open
democpay.payple.kr
파트너 인증시 페이플의 요청 URL
result
Open
success
결과확인
result_msg
Open
사용자 인증 완료!!
결과메세지
cst_id
Open
UFVNNVZ...
파트너 ID
custKey
Open
T3JzRkp5L...
파트너 Key
AuthKey
Open
a688ccb3555...
파트너 인증토큰
PCD_PAY_HOST
Open
https://democpay.payple.kr
결제요청 도메인
PCD_PAY_URL
Open
<return_uri>
결제요청 URI *고정값으로 사용하지 않기를 권장합니다.
return_url
Open
<return full uri>
결제요청 URI (PCD_PAY_HOST + PCD_PAY_URL) ※ 요청시 Request URL *고정값으로 사용하지 않기를 권장합니다.
COUNT9
Response sample
{ "server_name": "요청 URL" "result": "결과확인" "result_msg": "결과 메시지" "cst_id": "파트너사 아이디" "custKey": "파트너사 키" "AuthKey": "파트너사 인증토큰", "PCD_PAY_HOST": "요청 도메인, (예: https://democpay.payple.kr)" "PCD_PAY_URL": "요청 URL, (예: /auth.php)" "return_url": "요청 URL (PCD_PAY_HOST + PCD_PAY_URL)" }
JSON
실패 리턴 (result = error)을 받으신 경우, result_msg 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.

4. 링크생성

파트너 서버
파트너는 파트너 인증 완료 후 링크생성 요청을 수행합니다.
이때 파트너 인증 후 Response 받은 cst_id, custkey, AuthKey 값을 각각 PCD_CST_ID, PCD_CUST_KEY, PCD_AUTH_KEY 에 넣어 취소 요청을 보냅니다.
파트너 인증 후 Response 받은 cst_id, custKey,AuthKey 값은 고정값이 아니므로 저장해놓고 계속해서 사용하면 안됩니다. + 한번의 파트너 인증과 하나의 요청이 매칭되어야 합니다. 즉 한번의 파트너 인증으로 받은 cst_id, custKey,AuthKey 값을 여러 요청에 사용하면 안됩니다.

Request Message

Show All
Search
결제수단
Parameter
더 알아보기
Type (Length)
Parameter value
Reference
카드
계좌
PCD_CST_ID
Open
aN(255)
UFVN...
파트너 인증 후 리턴 받은 cst_id Token
카드
계좌
PCD_CUST_KEY
Open
aN(255)
T3Jz...
파트너 인증 후 리턴 받은 custKey Token
카드
계좌
PCD_AUTH_KEY
Open
aNS(255)
a688c...
파트너 인증 후 리턴 받은 인증 Token
카드
계좌
PCD_PAY_WORK
Open
A(20)
LINKREG
링크결제 요청방식
카드
계좌
PCD_PAY_TYPE
Open
a(20)
card
결제수단 선택 (Default : transfer+card) ⦁ 계좌 : transfer ⦁ 카드 : card ※ 파트너사에서 이용하고 있는 결제수단으로만 링크결제를 생성할 수 있으며, 이용하고 있지 않은 결제수단을 보낼 경우, 링크를 생성해도 해당 결제수단으로의 결제는 생성되지 않습니다.
카드
계좌
PCD_PAY_GOODS
Open
aAHNS(255)
티셔츠
카드
계좌
PCD_PAY_TOTAL
Open
N(20)
1000
결제 요청금액
Show All
Search
결제수단
Parameter
더 알아보기
Type (Length)
Parameter value
Reference
카드
PCD_CARD_VER
Open
N(2)
01+02(default) | 01 | 02
PCD_PAY_TYPE이 'card'인 경우에만 해당 - (Default) 01+02 : 페이플 간편결제와 앱카드 결제 모두 - 01: 간편결제(비밀번호 간편결제, 일회성 간편결제) - 02: 앱카드결제
카드
계좌
PCD_PAY_ISTAX
Open
A(1)
Y
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N) ISTAX:Y, TAXTOTAL:공란이면 페이플에서 10% 부가세를 자동으로 적용합니다.
카드
계좌
PCD_PAY_TAXTOTAL
Open
N(11)
10
⦁ 복합과세(과세+면세) 주문건에 필요한 금액이며 이 파라미터에 지정한 값이 부가세로 설정되어서 결제됩니다. - 예시) PCD_PAY_TOTAL = 1000, PCD_PAY_TAXTOTAL = 350 로 보낼경우, 해당 주문건의 복합과세가 보낸 그대로인 350원으로 지정됩니다. ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다. ⦁ 과세 또는 비과세의 경우 사용하지 않습니다. ⦁ 등록만 수행시(PCD_PAY_WORK = AUTH)일 경우에는 미입력
계좌
PCD_TAXSAVE_FLAG
Open
A(1)
Y | N
현금영수증 발행창을 노출하는 옵션Parameter입니다.
카드
계좌
PCD_PAY_GOODS_EXPLAIN
Open
aAHNS(255)
상품설명
상품 설명을 위한 파라메터
카드
계좌
PCD_LINK_EXPIREDATE
Open
N(10)
2021080619
링크결제의 만료일을 지정합니다. 지정하지 않는 경우 무기한 결제가 가능합니다. 년월일을 지정 후 시간을 지정하지 않을 경우 해당일 23시 59분 59초 까지로 자동 설정 됩니다.
카드
계좌
PCD_LINK_PARAMETER
Open
aNS(255)
a=추가1&b=추가2
결제용 링크 생성 시파트너사가 원하는 파라미터값을 추가할 수 있는 기능 입니다. 마케팅 캠페인(UTM)과 유사한 기능으로, 결제 관련한 임의의 속성과 값을 추적하고 싶을 경우 사용합니다.
카드
계좌
PCD_LINK_NOTI_MSG
Open
aNS(200)
결제 완료 페이지에서 표시될 내용을 입력받는 파라미터입니다. 결제자에게 결제가 완료된 이후 판매자가 안내하고 싶은 문구가 있을 경우 사용합니다.
카드
계좌
PCD_LINK_URL
Open
https://www.payple.kr
결제완료 페이지에서 [이동하기] 버튼 클릭 시 이동될 URL 을 위한 파라미터 입니다
카드
계좌
PCD_GOODS_AMOUNT
Open
N(11)
결제 마감 수량을 지정할수 있는 파라메터입니다 ⦁ 수량은 1부터 999 까지 가능합니다.
요청 파라미터의 Type 보는 방법 에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * 링크생성 요청 * Request HTTP URL * ※파트너 인증 후 리턴받은 return_url로 설정해주세요. * (return_url = PCD_PAY_HOST + PCD_PAY_URL) * TEST : https://democpay.payple.kr/(파트너 인증 후 리턴 받은 요청 URL(PCD_PAY_URL)) * REAL : https://cpay.payple.kr/(파트너 인증 후 리턴 받은 요청 URL(PCD_PAY_URL)) */ Request URL: "https://democpay.payple.kr/(파트너 인증후 리턴받은 PCD_PAY_URL)" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Referer: http://localhost:8080
JSON
Body(Payload) 값
{ "PCD_CST_ID": "파트너 인증 후 리턴받은 cst_id", "PCD_CUST_KEY": "파트너 인증 후 리턴받은 custKey", "PCD_AUTH_KEY": "파트너 인증 후 리턴받은 AuthKey", "PCD_PAY_WORK": "LINKREG", "PCD_PAY_TYPE": "card", "PCD_PAY_GOODS": "상품1", "PCD_PAY_GOODS_EXPLAIN": "상품 설명", "PCD_PAY_TOTAL": "100", "PCD_LINK_EXPIREDATE": "2021080619" }
JSON

Response Message

기본 보기
Search
Parameter
더 알아보기
결제수단
Parameter value
Reference
Type
PCD_LINK_RST
Open
카드
계좌
success
요청 결과(success, error)
String
PCD_LINK_MSG
Open
카드
계좌
링크생성이 완료되었습니다.
링크생성 요청 결과 메시지
String
PCD_PAY_TYPE
Open
카드
계좌
card
결제수단 - 카드: card - 계좌이체: transfer
String
PCD_PAY_GOODS
Open
카드
계좌
상품1
상품명
String
PCD_PAY_GOODS_EXPLAIN
Open
카드
계좌
상품설명
상품설명
String
PCD_PAY_TOTAL
Open
카드
계좌
100
결제금액 총액
String
PCD_PAY_ISTAX
Open
카드
계좌
Y
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N)
String
PCD_PAY_TAXTOTAL
Open
카드
계좌
0
- 복합과세(과세+면세) 주문건에 필요한 금액이며, 파트너사에서 지정하여 전송한 값이 리턴됩니다. ※복합과세는 공급가액이 아닌 실제 시고가 된 부가세 금액이 리턴됩니다.
String
PCD_TAXSAVE_FLAG
Open
카드
계좌
Y
현금영수증 발행창을 노출하는 옵션Parameter입니다. (사용: Y)
String
PCD_LINK_EXPIREDATE
Open
카드
계좌
20200806
링크결제의 만료일을 지정합니다.
String
PCD_LINK_KEY
Open
카드
계좌
Mj...
링크요청 키
String
PCD_LINK_URL
Open
카드
계좌
https://..
생성된 링크 URL이며, 결제를 위해 고객에게 전달되어야 합니다.
String
COUNT12
Response sample
{ "PCD_LINK_RST": "success" "PCD_LINK_MSG": "링크생성이 완료되었습니다." "PCD_PAY_TYPE": "card" "PCD_PAY_GOODS": "상품1" "PCD_PAY_GOODS_EXPLAIN": "상품설명" "PCD_PAY_TOTAL": "100" "PCD_PAY_ISTAX": "Y" "PCD_PAY_TAXTOTAL": "0" "PCD_TAXSAVE_FLAG": "N" "PCD_LINK_EXPIREDATE": "20200806" "PCD_LINK_KEY": "Mjox..." "PCD_LINK_URL": "http://link..." }
JSON
PCD_LINK_RST = success 요청성공으로 판단합니다. PCD_LINK_RST = error 일 경우 요청실패로 판단합니다.
실패 리턴(PCD_LINK_RST = error )을 받으신 경우, PCD_LINK_MSG 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.

5. 링크 전달

파트너
링크생성이 완료되고 리턴받은 PCD_LINK_URL 에 있는 링크주소를 고객에게 전달합니다.
거래를 특정하기 위해 링크주소에 주문번호(PCD_PAY_OID)를 지정하고 싶다면 이곳 을 확인해보세요.

6. 결제

고객
고객은 전달받은 링크주소로 접속해서 결제방식을 선택하고, 결제를 진행합니다.

7. 결과 수신

파트너
링크결제를 완료하고, 파트너가 결제이벤트 정보를 확인하는 방법은 다음과 같습니다.

7-1. 파트너 관리자

페이플 파트너 관리자 > 결제수단(계좌이체, 신용카드) 별 결제내역 혹은
페이플 파트너 관리자> 부가서비스 > 링크결제 > 링크별 결제완료 텍스트 클릭 > 완료된 링크결제 내역 에서 확인 가능합니다.

7-2. 이메일

페이플에 등록된 파트너사의 대표이메일로 결제가 발생할때마다 메일이 발송됩니다.
페이플 파트너 관리자> 상점정보 > 기본정보 > 대표이메일 에서 이메일 설정 현황을 확인 가능합니다.

7-3. Webhook URL

등록한 Webhook URL로 결제결과를 수신받을 수 있습니다.
페이플 파트너 관리자> 상점정보 > 기본정보 > 결제결과 수신 URL & 계좌(카드)해지결과 수신 URL 에서 설정정보 확인이 가능합니다.
Webhook URL에 대한 자세한 설명은 이곳에서 확인해보세요.

7-4. slack(슬랙)

사용하시는 슬랙의 특정 채널로 링크결제시 결과를 수신 받을 수 있습니다.
페이플 파트너 관리자> 상점정보 > 환경설정 > Push 알림 에서 설정정보 확인이 가능합니다.
설정방법에 대한 자세한 설명은 이곳에서 확인해보세요.

8. 마무리

링크결제의 연동작업을 완료하였습니다! 축하드립니다!