1. 정의
•
링크결제는 결제링크를 생성하여 문자, 카카오톡, 이메일 등의
다양한 채널에서 고객에게 결제를 받을 수 있는 서비스입니다.
•
해당 문서에서는 API를 통해 자동으로 링크를 생성하는 방법을 소개드립니다.
•
아래 링크를 클릭해서 링크결제를 직접 체험해보세요.
◦
체험링크이며, 결제된 금액은 자동 취소됩니다.
2. 프로세스 개요
3. 파트너 인증
파트너 서버
Request Parameters
기본 보기
Search
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 Parameters
•
파트너 인증이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
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 Parameters
Show All
Search
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 Parameters
기본 보기
Search
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_ADD_PARAM": "params1=val1¶ms2=val2",
"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 에서 설정정보 확인이 가능합니다.
> 상점정보 > 기본정보 > 결제결과 수신 URL & 계좌(카드)해지결과 수신 URL 에서 설정정보 확인이 가능합니다.Webhook URL에 대한 자세한 설명은 이곳에서 확인해보세요.
에서 확인해보세요.7-4. slack(슬랙)
•
사용하시는 슬랙의 특정 채널로 링크결제시 결과를 수신 받을 수 있습니다.
◦
페이플 파트너 관리자> 상점정보 > 환경설정 > Push 알림 에서 설정정보 확인이 가능합니다.
> 상점정보 > 환경설정 > Push 알림 에서 설정정보 확인이 가능합니다.설정방법에 대한 자세한 설명은 이곳에서 확인해보세요.
에서 확인해보세요.8. 마무리
•
링크결제의 연동작업을 완료하였습니다! 축하드립니다!