파라미터
국내 카드〉운영
1. 취소
1 .1 파트너 인증 요청
취소 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAYCANCEL_FLAG | String | 1 | 취소 요청을 위한 파라미터입니다. | Y |
파트너 인증이 성공적으로 완료된 후에 받게 되는 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/account/api/cPayCAct.php |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/account/api/cPayCAct.php |
1.2 취소 요청
파트너 인증 후 취소 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_REFUND_KEY | String | 255 | 계약이 완료되면 발급되는 취소를 위한 고유 키입니다.
| a41c… | |
| PCD_PAYCANCEL_FLAG | String | 1 | 취소 요청을 위한 파라미터입니다. | Y | |
| PCD_PAY_OID | String | 255 | 원거래 주문번호입니다. | order12345 | |
| PCD_PAY_DATE | String | 8 | 원거래 결제일자입니다. | 20231219 | |
| PCD_REFUND_TOTAL | String | 10 | 취소 금액입니다.
| 1000 | |
| PCD_USER_DEFINE1 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다. | define1 | |
| PCD_USER_DEFINE2 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다. | define2 | |
| PCD_REFUND_TAXTOTAL | String | 10 | 복합과세 원거래의 취소 시에만 이용하며, 복합과세 주문의 취소할 부가세를 설정합니다. | 1000 |
취소 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 요청 결과입니다.
| success |
| PCD_PAY_CODE | String | 응답 코드입니다. | PAYC0000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 환불 성공 |
| PCD_PAY_OID | String | 주문번호입니다. | order12345 |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)입니다.
| card |
| PCD_PAYER_NO | String | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 |
| PCD_PAYER_ID | String | 정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
| OVA3… |
| PCD_PAY_GOODS | String | 상품명입니다. | 테스트 상품 |
| PCD_REGULER_FLAG | String | 월 중복방지 거래 설정 여부입니다. | N |
| PCD_PAY_YEAR | String | 월 중복방지 거래 - 년(Year) | 2023 |
| PCD_PAY_MONTH | String | 월 중복방지 거래 - 월(Month) | 12 |
| PCD_REFUND_TOTAL | String | 취소 금액입니다. | 1000 |
| PCD_REFUND_TAXTOTAL | String | 복합과세 주문의 취소 부가세입니다. | 50 |
| PCD_PAY_TIME | String | 취소를 요청한 시간입니다. | 20231219134223 |
| PCD_USER_DEFINE1 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다. | define1 |
| PCD_USER_DEFINE2 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다. | define2 |
| PCD_PAY_CARDTRADENUM | String | 해당 거래의 고유한 키입니다. | 202312191342223302115099 |
| PCD_PAY_CARDRECEIPT | String | 매출 전표(영수증) 출력 URL 입니다. | https://www.danalpay.com/... |
2. 결과조회
2.1 파트너 인증 요청
결과조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
한 번의 파트너 인증 후 30분의 유효 시간 동안 조회 요청을 해야 하며, 10분당 1,000건을 초과하는 요청은 거부됩니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAYCHK_FLAG | String | 1 | 결과조회 요청을 위한 파라미터입니다. | Y |
파트너 인증이 성공적으로 완료된 후에 받게 되는 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/PayChkAct.php |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/ php/PayChkAct.php |
2.2 결과조회 요청
파트너 인증 후 결과조회 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAYCHK_FLAG | String | 1 | 결과조회 요청을 위한 파라미터입니다. | Y | |
| PCD_PAY_TYPE | String | 10 | 결제수단입니다.
| card | |
| PCD_PAY_OID | String | 255 | 원거래 주문번호입니다. | order12345 | |
| PCD_PAY_DATE | String | 8 | 원거래 결제일자입니다. | 20231219 |
결과조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 승인 결과입니다. ·success : 성공 / error: 실패 | success |
| PCD_PAY_CODE | String | 응답코드입니다. | PCHK000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 결제 완료 |
| PCD_PAY_OID | String | 주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다. | order12345 |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)입니다.
| card |
| PCD_PAYER_NO | String | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 |
| PCD_PAYER_ID | String | 정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다. ·앱카드 결제(PCD_CARD_VER=‘02’)인 경우, 빌링키는 반환되지 않으며 빈값으로 응답합니다. | OVA3… |
| PCD_PAYER_EMAIL | String | 구매자 이메일입니다. | complete@payer-email.com |
| PCD_REGULER_FLAG | String | 월 중복방지 거래 설정 여부입니다. | N |
| PCD_PAY_YEAR | String | 월 중복방지 거래 - 년(Year) | 2023 |
| PCD_PAY_MONTH | String | 월 중복방지 거래 - 월(Month) | 12 |
| PCD_PAY_GOODS | String | 상품명입니다. | 테스트 상품 |
| PCD_PAY_AMOUNT | String | (현재는 이용하지 않는) 총 결제금액입니다. | |
| PCD_PAY_DISCOUNT | String | (현재는 이용하지 않는) 할인금액입니다. | |
| PCD_PAY_AMOUNT_REAL | String | (현재는 이용하지 않는) 총 결제금액 - 할인금액입니다. | |
| PCD_PAY_TOTAL | String | 총 결제금액입니다. | 1000 |
| PCD_PAY_ISTAX | String | 과세 여부입니다. | Y |
| PCD_PAY_TAXTOTAL | String | 복합과세 부가세입니다. | 500 |
| PCD_PAY_CARDNAME | String | 카드사명입니다. | 삼성카드 |
| PCD_PAY_CARDNUM | String | 카드번호입니다. | 1234-****-****-5678 |
| PCD_PAY_CARDTRADENUM | String | 해당 거래의 고유한 키입니다. | 202312191342223302115099 |
| PCD_PAY_CARDAUTHNO | String | 승인번호입니다. | 85324231 |
| PCD_PAY_CARDRECEIPT | String | 매출 전표(영수증) 출력 URL 입니다. | https://www.danalpay.com/... |
| PCD_PAY_PAYMENT_TYPE | String | 카드 결제수단 중 세부 결제방식입니다.
| 앱카드 |
| PCD_PAY_CARDQUOTA | String | 카드 할부 개월 수입니다. | - 00 : 일시불 - 02,03... |
| PCD_PAY_TIME | String | 결제를 요청한 시간입니다. | 2023-12-19 13:42:23 |
3. 빌링키 조회
3.1 파트너 인증 요청
빌링키 조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
한 번의 파트너 인증으로 30분 동안 조회 요청이 가능합니다. 매 조회마다 새로운 인증이 필요하지 않습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 255 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAY_WORK | String | 20 | 빌링키 조회 요청을 위한 파라미터입니다. | PUSERINFO |
파트너 인증이 성공적으로 완료된 후에 받게 되는 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/cPayUser/api/cPayUserAct.php?ACT_=PUSERINFO |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/cPayUser/api/cPayUserAct.php?ACT_=PUSERINFO |
3.2 빌링키 조회 요청
파트너 인증 후 빌링키 조회 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAYER_ID | String | 255 | 빌링키입니다. | OVA3… |
빌링키 조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 요청 결과입니다.
| success |
| PCD_PAY_CODE | String | 응답 코드입니다. | 0000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 회원조회 성공 |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)입니다. | card |
| PCD_PAYER_ID | String | 빌링키입니다. | OVA3... |
| PCD_PAYER_NAME | String | 구매자 이름입니다. | 김이플 |
| PCD_PAYER_HP | String | 구매자 휴대폰번호입니다. | 01012345678 |
| PCD_PAY_CARD | String | 카드사 코드입니다. | 0200 |
| PCD_PAY_CARDNAME | String | 카드사명입니다. | 삼성카드 |
| PCD_PAY_CARDNUM | String | 카드번호입니다. | 1234-****-****-5678 |
4. 빌링키 해지
4.1 파트너 인증 요청
빌링키 해지 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
한 번의 파트너 인증으로 30분 동안 조회 요청이 가능합니다. 매 조회마다 새로운 인증이 필요하지 않습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAY_WORK | String | 20 | 빌링키 해지 요청을 위한 파라미터입니다. | PUSERDEL |
파트너 인증이 성공적으로 완료된 후에 받게 되는 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/cPayUser/api/cPayUserAct.php?ACT_=PUSERDEL |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/cPayUser/api/cPayUserAct.php?ACT_=PUSERDEL |
4.2 빌링키 해지 요청
파트너 인증 후 빌링키 해지 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAYER_ID | String | 255 | 빌링키입니다. | OVA3 |
빌링키 해지 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 요청 결과입니다.
| success |
| PCD_PAY_CODE | String | 응답 코드입니다. | PUER0000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 카드해지 완료 |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)입니다. | card |
| PCD_PAY_WORK | String | 빌링키 해지 요청을 위한 파라미터입니다.. | PUSERDEL |
| PCD_PAYER_ID | String | 빌링키입니다. | OVA3… |
| PCD_PAYER_NO | String | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 |