파라미터
링크결제
1. 파트너 인증 요청
링크 생성 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 클라이언트키입니다. 라이브 클라이언트키는 계약 완료 후 발급가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAY_WORK | String | 10 | 결제링크 생성을 요청합니다. | LINKREG |
파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| server_name | String | 파트너 인증 서버의 Domain을 반환합니다. | democpay.payple.kr |
| result | String | 인증 결과입니다. | success |
| result_msg | String | 결과 메시지입니다. | 사용자 인증 완료!! |
| cst_id | String | 파트너 ID 입니다.
| UFVNNVZ… |
| custKey | String | 파트너 인증 키입니다.
| T3JzRkp5L… |
| AuthKey | String | 파트너 인증 키입니다.
| a688ccb3555... |
| PCD_PAY_HOST | String | 페이플 접속 주소입니다. | https://democpay.payple.kr |
| PCD_PAY_URL | String | 파트너 인증 결과로 응답되는 URL Path 입니다. | /php/link/api/LinkRegAct.php?ACT_=LINKREG |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/link/api/LinkRegAct.php?ACT_=LINKREG |
2. 링크 생성 요청
파트너 인증 후 링크 생성 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 결제수단 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|---|
| PCD_CST_ID | 전체 | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | 전체 | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | 전체 | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAY_WORK | 전체 | String | 255 | 결제링크 생성을 요청합니다. | LINKREG | |
| PCD_PAY_TYPE | 전체 | String | 255 | 결제수단을 선택합니다.
| transfer+card | |
| PCD_PAY_GOODS | 전체 | String | 255 | 상품명입니다. | 테스트 상품 | |
| PCD_PAY_TOTAL | 전체 | Number | 255 | 총 결제금액입니다. | 1000 | |
| PCD_PAY_GOODS_EXPLAIN | 전체 | String | 255 | 상품 설명입니다. | 해당 상품은 테스트를 위한 상품으로 실결제가 진행되지 않는 상품입니다 | |
| PCD_PAY_ISTAX | 전체 | String | 1 | 과세 여부입니다. 기본값은 Y 이며, 유형별로 아래와 같이 설정해주세요.
| Y | |
| PCD_PAY_TAXTOTAL | 전체 | Number | 9 | 복합과세 주문 시에만 이용하며, 복합과세 주문의 부가세를 설정합니다.
| 500 | |
| PCD_LINK_EXPIREDATE | 전체 | String | 10 | 결제 만료일시를 설정합니다. 미지정 시 무기한으로 만료일시가 설정됩니다. | 2025010122 | |
| PCD_LINK_PARAMETER | 전체 | String | 255 | 사용자 정의 파라미터입니다. | params1=val1¶ms2=val2 | |
| PCD_LINK_NOTI_MSG | 전체 | String | 255 | 결제완료 화면에서 표시될 내용을 입력합니다. 결제 완료 후 구매자에게 전달하고자 하는 안내 문구가 있으면 이를 사용할 수 있습니다. | ||
| PCD_LINK_MEMO | 전체 | String | 1024 | 상점 관리자에서 표시될 메모입니다. | 테스트 링크결제 | |
| PCD_LINK_URL | 전체 | String | 255 | 결제 완료 화면에서 구매자가 '이동하기' 버튼을 클릭하면 이동할 URL을 지정할 수 있습니다. | www.your-domain.com | |
| PCD_GOODS_AMOUNT | 전체 | Number | 3 | 결제 마감 수량을 지정합니다.
| 15 | |
| PCD_CARD_VER | 카드 | String | 2 | 카드 결제방식을 선택합니다.
| 01+02 | |
| PCD_TAXSAVE_FLAG | 계좌 | String | 1 | 현금영수증 발행창 호출 여부입니다.
| Y |
링크 생성이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_LINK_RST | String | 생성 결과입니다.
| success |
| PCD_LINK_MSG | String | 응답 메시지입니다. | 링크생성이 완료되었습니다. |
| PCD_PAY_TYPE | String | 결제수단입니다. | transfer+card |
| PCD_PAY_GOODS | String | 상품명입니다. | 테스트 상품 |
| PCD_PAY_GOODS_EXPLAIN | String | 상품 설명입니다. | 해당 상품은 테스트를 위한 상품으로 실결제가 진행되지 않는 상품입니다. |
| PCD_PAY_TOTAL | String | 총 결제금액입니다. | 1000 |
| PCD_PAY_ISTAX | String | 과세 여부입니다. | Y |
| PCD_PAY_TAXTOTAL | String | 복합과세 부가세입니다. | 500 |
| PCD_REGULER_FLAG | String | 월 중복방지 거래 설정 여부입니다. | N |
| PCD_PAY_YEAR | String | 월 중복방지 거래 - 년(Year) | 2023 |
| PCD_PAY_MONTH | String | 월 중복방지 거래 - 월(Month) | 12 |
| PCD_TAXSAVE_FLAG | String | 현금영수증 발행 여부입니다. | Y |
| PCD_LINK_EXPIREDATE | String | 결제 만료일시입니다. | 2025-01-01 22:00:00 |
| PCD_LINK_ADD_PARAM | String | 사용자 정의 파라미터입니다. | params1=val1¶ms2=val2 |
| PCD_LINK_KEY | String | 생성된 링크의 고유 키입니다. | MTI6MTU4NDYwNzI4Mg |
| PCD_LINK_URL | String | 생성된 링크의 전체 주소입니다. | https://democpay.payple.kr/php/link/?SID=MTI6MTU4NDYwNzI4Mg |
3. 링크 만료처리 요청
3.1 파트너 인증 요청
링크 만료처리 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
한 번의 파트너 인증으로 30분 동안 조회 요청이 가능합니다. 매 조회마다 새로운 인증이 필요하지 않습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 클라이언트키입니다. 라이브 클라이언트키는 계약 완료 후 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAY_WORK | String | 20 | 링크 만료처리 요청을 위한 파라미터입니다. | LINKEXPIRE |
파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| server_name | String | 파트너 인증 서버의 Domain을 반환합니다. | democpay.payple.kr |
| result | String | 인증 결과입니다. | success |
| result_msg | String | 결과 메시지입니다. | 사용자 인증 완료!! |
| cst_id | String | 파트너 ID 입니다.
| UFVNNVZ… |
| custKey | String | 파트너 인증 키입니다.
| T3JzRkp5L… |
| AuthKey | String | 파트너 인증 키입니다.
| a688ccb3555... |
| PCD_PAY_HOST | String | 페이플 접속 주소입니다. | https://democpay.payple.kr |
| PCD_PAY_URL | String | 파트너 인증 결과로 응답되는 URL Path 입니다. | /php/link/api/LinkRegAct.php?ACT_=LINKEXPIRE |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/link/api/LinkRegAct.php?ACT_=LINKEXPIRE |
3.2 링크 만료처리 요청
파트너 인증 후 만료처리 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_LINK_KEY | String | 12 | 생성된 링크의 고유 키입니다. | MTI6MTU4NDYwNzI4Mg |
만료처리 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 인증 결과입니다.
| success |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 링크결제 만료 처리가 완료되었습니다. |
| PCD_LINK_KEY | String | 생성된 링크의 고유 주소입니다. | MTI6MTU4NDYwNzI4Mg |
| PCD_LINK_URL | String | 생성된 링크의 전체 주소입니다. | https://democpay.payple.kr/php/link/?SID=MTI6MTU4NDYwNzI4Mg |