로고Developer Center
홈페이지가입문의

파라미터

국내 카드운영


1. 취소

1 .1 파트너 인증 요청

취소 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
cst_idString12파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.test
custKeyString255파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
PCD_PAYCANCEL_FLAGString1취소 요청을 위한 파라미터입니다.Y

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
server_nameString파트너 인증 서버의 Domain을 반환합니다.democpay.payple.kr
resultString응답 코드입니다.
  • success : 성공 / error : 실패
success
result_msgString응답 메시지입니다.사용자 인증 완료!!
cst_idString파트너 ID 입니다.
  • 매 인증 시 변동되는 값입니다.
UFVNNVZ…
custKeyString파트너 키입니다.
  • 매 인증 시 변동되는 값입니다.
T3JzRkp5L…
AuthKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
a688ccb3555...
PCD_PAY_HOSTString페이플 접속 주소입니다.https://democpay.payple.kr
PCD_PAY_URLString파트너 인증 결과로 응답되는 URL Path 입니다./php/account/api/cPayCAct.php
return_urlString파트너 인증 결과로 응답되는 URL 입니다.https://democpay.payple.kr/php/account/api/cPayCAct.php

1.2 취소 요청

파트너 인증 후 취소 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
PCD_CST_IDString255파트너 인증 후 수신한 ID입니다.UFVNNVZ…
PCD_CUST_KEYString255파트너 인증 후 수신한 키입니다.T3JzRkp5L…
PCD_AUTH_KEYString255파트너 인증 후 수신한 인증 키입니다.a688ccb3555…
PCD_REFUND_KEYString255계약이 완료되면 발급되는 취소를 위한 고유 키입니다.
  • 파트너관리자에서 확인 가능
a41c…
PCD_PAYCANCEL_FLAGString1취소 요청을 위한 파라미터입니다.Y
PCD_PAY_OIDString64원거래 주문번호입니다.order12345
PCD_PAY_DATEString8원거래 결제일자입니다.20231219
PCD_REFUND_TOTALString10취소 금액입니다.
  • 원거래 금액보다 적으면 부분취소로 진행
1000
PCD_USER_DEFINE1String2048파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다.define1
PCD_USER_DEFINE2String2048파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다.define2
PCD_REFUND_TAXTOTALString10복합과세 원거래의 취소 시에만 이용하며, 복합과세 주문의 취소할 부가세를 설정합니다.1000

취소 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
PCD_PAY_RSTString요청 결과입니다.
  • success : 성공 / error : 실패
success
PCD_PAY_CODEString응답 코드입니다.PAYC0000
PCD_PAY_MSGString응답 메시지입니다.환불 성공
PCD_PAY_OIDString주문번호입니다.order12345
PCD_PAY_TYPEString결제수단(카드/계좌)입니다.
  • 카드 : card / 계좌: transfer
card
PCD_PAYER_NOString파트너(상점)에서 이용하는 회원번호입니다.1234
PCD_PAYER_IDString정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
  • 앱카드 결제(PCD_CARD_VER = ‘02’)인 경우, 빌링키는 반환되지 않습니다.
OVA3…
PCD_PAY_GOODSString상품명입니다.테스트 상품
PCD_REGULER_FLAGString월 중복방지 거래 설정 여부입니다.N
PCD_PAY_YEARString월 중복방지 거래 - 년(Year)2023
PCD_PAY_MONTHString월 중복방지 거래 - 월(Month)12
PCD_REFUND_TOTALString취소 금액입니다.1000
PCD_REFUND_TAXTOTALString복합과세 주문의 취소 부가세입니다.50
PCD_PAY_TIMEString취소를 요청한 시간입니다.20231219134223
PCD_USER_DEFINE1String파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다.define1
PCD_USER_DEFINE2String파트너(상점)에서 입력한 값을 그대로 응답합니다. 숫자, 영문자, 한글만 입력 가능하며 공백과 특수문자는 제거 됩니다.define2
PCD_PAY_CARDTRADENUMString해당 거래의 고유한 키입니다.202312191342223302115099
PCD_PAY_CARDRECEIPTString매출 전표(영수증) 출력 URL 입니다.https://www.danalpay.com/...

2. 결과조회

2.1 파트너 인증 요청

결과조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다. 한 번의 파트너 인증 후 30분의 유효 시간 동안 조회 요청을 해야 하며, 10분당 1,000건을 초과하는 요청은 거부됩니다.

파라미터필수타입길이설명값 예시
cst_idString12파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.test
custKeyString255파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
PCD_PAYCHK_FLAGString1단건 조회 인증용 플래그입니다.Y

단건 조회를 위한 인증 요청 시 PCD_PAYCHK_FLAG를 Y로 전송하고, 다건 조회를 위한 인증 요청 시 PCD_PAYCHK_LIST_FLAG를 Y로 전송하세요. 두 파라미터를 동시에 인증 요청에 사용할 경우 인증 응답이 안내와 다를 수 있습니다.

PCD_PAYCHK_LIST_FLAGString1다건 조회 인증용 플래그입니다.Y

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
server_nameString파트너 인증 서버의 Domain을 반환합니다.https://democpay.payple.kr
resultString응답 코드입니다.
  • success : 성공 / error : 실패
success
result_msgString응답 메시지입니다.사용자 인증 완료!!
cst_idString파트너 ID 입니다.
  • 매 인증 시 변동되는 값입니다.
UFVNNVZ…
custKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
T3JzRkp5L…
AuthKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
a688ccb3555...
PCD_PAY_HOSTString페이플 접속 주소입니다.https://democpay.payple.kr
PCD_PAY_URLString파트너 인증 결과로 수신하는 URL Path 입니다.단건 : /php/PayChkAct.php 다건 : /php/PayChkActList.php
return_urlString파트너 인증 결과로 수신하는 URL 입니다.단건 : https://democpay.payple.kr/php/PayChkAct.php 다건 : https://democpay.payple.kr/php/PayChkActList.php

2.2 단건 결과조회 요청

파트너 인증 후 단건 결과조회 요청 시 필요한 Request 파라미터는 아래와 같습니다. 단건 조회는 1초에 2건, 10분당 1,000건을 초과하는 요청은 거부됩니다.

파라미터필수타입길이설명값 예시
PCD_CST_IDString255파트너 인증 후 수신한 ID입니다.UFVNNVZ…
PCD_CUST_KEYString255파트너 인증 후 수신한 키입니다.T3JzRkp5L…
PCD_AUTH_KEYString255파트너 인증 후 수신한 인증 키입니다.a688ccb3555…
PCD_PAYCHK_FLAGString1단건 결과조회 요청을 위한 파라미터입니다.Y
PCD_PAY_TYPEString10결제수단입니다.
  • card : 카드결제 / transfer : 계좌결제
card
PCD_PAY_OIDString64원거래 주문번호입니다.order12345
PCD_PAY_DATEString8원거래 결제일자입니다.20231219

단건 조회로 월 중복 방지 결제건을 조회하기 위해서는 아래 파라미터를 포함해야합니다.

PCD_REGULER_FLAGString1월 중복 결제 방지 사용여부 플래그입니다. Y로 전송 시, 월 중복 결제 방지 결제건만 조회됩니다.Y
PCD_PAY_YEARString4월 중복 방지 결제의 정기결제 년도 입니다.2023
PCD_PAY_MONTHString2월 중복 방지 결제의 정기결제 월 입니다.12

단건 결과조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
PCD_PAY_RSTString승인 결과입니다.
  • success : 성공 / error: 실패
success
PCD_PAY_CODEString응답코드입니다.PCHK0000
PCD_PAY_MSGString응답 메시지입니다.결제 완료
PCD_PAY_OIDString주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다.order12345
PCD_PAY_TYPEString결제수단(카드/계좌)입니다.
  • 카드 : card / 계좌: transfer
card
PCD_PAYER_NOString파트너(상점)에서 이용하는 회원번호입니다.1234
PCD_PAYER_IDString정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
  • 앱카드 결제(PCD_CARD_VER=’02’)인 경우, 빌링키는 반환되지 않으며 빈값으로 응답합니다.
OVA3…
PCD_PAYER_EMAILString구매자 이메일입니다.complete@payer-email.com
PCD_REGULER_FLAGString월 중복방지 거래 설정 여부입니다.N
PCD_PAY_YEARString월 중복방지 거래 - 년(Year)2023
PCD_PAY_MONTHString월 중복방지 거래 - 월(Month)12
PCD_PAY_GOODSString상품명입니다.테스트 상품
PCD_PAY_AMOUNTString(현재는 이용하지 않는) 총 결제금액입니다.
PCD_PAY_DISCOUNTString(현재는 이용하지 않는) 할인금액입니다.
PCD_PAY_AMOUNT_REALString(현재는 이용하지 않는) 총 결제금액 - 할인금액입니다.
PCD_PAY_TOTALString총 결제금액입니다.1000
PCD_PAY_ISTAXString과세 여부입니다.Y
PCD_PAY_TAXTOTALString복합과세 부가세입니다.500
PCD_PAY_CARDNAMEString카드사명입니다.삼성카드
PCD_PAY_CARDNUMString카드번호입니다.1234-**-**-5678
PCD_PAY_CARDTRADENUMString해당 거래의 고유한 키입니다.202312191342223302115099
PCD_PAY_CARDAUTHNOString승인번호입니다.85324231
PCD_PAY_CARDRECEIPTString매출 전표(영수증) 출력 URL 입니다.https://www.danalpay.com/...
PCD_PAY_PAYMENT_TYPEString카드 결제수단 중 세부 결제방식입니다.
  • 앱카드/간편결제
앱카드
PCD_PAY_CARDQUOTAString카드 할부 개월 수입니다.- 00 : 일시불 - 02,03...
PCD_PAY_TIMEString결제를 요청한 시간입니다.2023-12-19 13:42:23

2.3 다건 결과조회 요청

파트너 인증 후 다건 결과조회 요청 시 필요한 Request 파라미터는 아래와 같습니다. 조회 날짜 범위(PCD_START_DATE~PCD_END_DATE)는 최대 1년까지 가능합니다. 첫 요청에서는 PCD_LASTKEY를 생략하고, 응답의 PCD_HAS_MORE가 true일 때 반환된 PCD_LASTKEY로 다음 페이지를 조회합니다. 다건 조회는 1초에 1건, 2분당 20건을 초과하는 요청은 거부됩니다.

파라미터필수타입길이설명값 예시
PCD_CST_IDString255파트너 인증 후 수신한 ID입니다.UFVNNVZ…
PCD_CUST_KEYString255파트너 인증 후 수신한 키입니다.T3JzRkp5L…
PCD_AUTH_KEYString255파트너 인증 후 수신한 인증 키입니다.a688ccb3555…
PCD_PAYCHK_LIST_FLAGString1다건 결과조회 요청을 위한 파라미터입니다.Y
PCD_START_DATEString8조회 시작일입니다. YYYYMMDD 형식으로 전송합니다. PCD_END_DATE와의 조회 날짜 범위는 최대 1년입니다.20231219
PCD_END_DATEString8조회 종료일입니다. YYYYMMDD 형식으로 전송합니다. PCD_START_DATE와의 조회 날짜 범위는 최대 1년입니다.20231219
PCD_PAY_TYPEString10결제수단입니다.
  • card : 카드결제 / transfer : 계좌결제
card
PCD_LIMITNumber-조회 건수 제한 값입니다. 미전송 시 기본값은 100이며, 최소 1부터 최대 5000까지 설정할 수 있습니다.5000
PCD_LASTKEYString255첫 요청에서는 생략합니다. 응답의 PCD_DATA.PCD_HAS_MORE가 true인 경우 반환된 PCD_DATA.PCD_LASTKEY를 다음 요청에 전송합니다.gmUZOwXKxH64MWh3CsL3xg==
PCD_REGULER_FLAGString1월 중복 결제 방지 사용여부 플래그입니다. Y로 전송 시, 월 중복 결제 방지 결제건만 조회됩니다.N

다건 결과조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
PCD_PAY_CODEString다건 조회 응답코드입니다.PCHK0000
PCD_PAY_MSGString다건 조회 응답 메시지입니다.success
PCD_DATAObject다건 조회 결과 데이터입니다.
PCD_HAS_MOREBoolean조회 건수가 PCD_LIMIT를 초과해 추가 조회가 필요한지 여부입니다.true
PCD_LASTKEYStringPCD_HAS_MORE가 true인 경우 다음 요청에 사용할 커서 값입니다. false인 경우 null입니다.gmUZOwXKxH64MWh3CsL3xg==
PCD_LIMITNumber요청에 적용된 limit 값입니다.5000
PCD_CONTENTObject[]조회된 결제 내역 목록입니다.
PCD_CST_IDString파트너 ID입니다.PAYLAP01
PCD_PAY_OIDString원거래 주문번호입니다.order12345
PCD_PAY_TIMEString결제 요청 시각입니다.2023-12-19 13:42:23
PCD_PAY_TYPEString결제수단입니다.card
PCD_PAYER_NOString파트너(상점) 회원번호입니다.1234
PCD_PAYER_IDString빌링키입니다.OVA3...
PCD_PAYER_EMAILString구매자 이메일입니다.complete@payer-email.com
PCD_PAY_YEARString월 중복방지 거래 - 년(Year)2023
PCD_PAY_MONTHString월 중복방지 거래 - 월(Month)12
PCD_PAY_GOODSString상품명입니다.테스트 상품
PCD_PAY_AMOUNTNumber결제 금액입니다.1000
PCD_PAY_TOTALNumber총 결제금액입니다.1000
PCD_PAY_ISTAXString과세 여부입니다.Y
PCD_PAY_TAXTOTALNumber복합과세 부가세입니다.500
PCD_REGULER_FLAGString월 중복방지 거래 설정 여부입니다.N
PCD_PAY_STATEString결제 상태입니다.결제완료
PCD_PAYER_NAMEString구매자명입니다.홍길동
PCD_PAYER_HPString구매자 연락처입니다.01012345678
PCD_PAY_CARDQUOTAString카드 할부 개월 수입니다.00
PCD_PAY_CARDNAMEString카드사명입니다.삼성카드
PCD_PAY_CARDNUMString카드번호입니다.1234-**-**-5678
PCD_PAY_CARDTRADENUMString해당 거래의 고유한 키입니다.paypletttm0101231219134223a123
PCD_PAY_CARDAUTHNOString승인번호입니다.12345678
PCD_PAY_PAYMENT_TYPEString카드 결제수단 중 세부 결제방식입니다.앱카드

3. 빌링키 조회

3.1 파트너 인증 요청

빌링키 조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다. 한 번의 파트너 인증으로 30분 동안 조회 요청이 가능합니다. 매 조회마다 새로운 인증이 필요하지 않습니다.

파라미터필수타입길이설명값 예시
cst_idString255파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.test
custKeyString255파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
PCD_PAY_WORKString20빌링키 조회 요청을 위한 파라미터입니다.PUSERINFO

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
server_nameString파트너 인증 서버의 Domain을 반환합니다.democpay.payple.kr
resultString응답 코드입니다.
  • success : 성공 / error : 실패
success
result_msgString결과 메시지입니다.사용자 인증 완료!!
cst_idString파트너 ID 입니다.
  • 매 인증 시 변동되는 값입니다.
UFVNNVZ…
custKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
T3JzRkp5L…
AuthKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
a688ccb3555...
PCD_PAY_HOSTString페이플 접속 주소입니다.https://democpay.payple.kr
PCD_PAY_URLString파트너 인증 결과로 응답되는 URL Path 입니다./php/cPayUser/api/cPayUserAct.php?ACT_=PUSERINFO
return_urlString파트너 인증 결과로 응답되는 URL 입니다.https://democpay.payple.kr/php/cPayUser/api/cPayUserAct.php?ACT_=PUSERINFO

3.2 빌링키 조회 요청

파트너 인증 후 빌링키 조회 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
PCD_CST_IDString255파트너 인증 후 수신한 ID입니다.UFVNNVZ…
PCD_CUST_KEYString255파트너 인증 후 수신한 키입니다.T3JzRkp5L…
PCD_AUTH_KEYString255파트너 인증 후 수신한 인증 키입니다.a688ccb3555…
PCD_PAYER_IDString255빌링키입니다.OVA3…

빌링키 조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
PCD_PAY_RSTString요청 결과입니다.
  • success : 성공 / error : 실패
success
PCD_PAY_CODEString응답 코드입니다.0000
PCD_PAY_MSGString응답 메시지입니다.회원조회 성공
PCD_PAY_TYPEString결제수단(카드/계좌)입니다.card
PCD_PAYER_IDString빌링키입니다.OVA3...
PCD_PAYER_NAMEString구매자 이름입니다.김이플
PCD_PAYER_HPString구매자 휴대폰번호입니다.01012345678
PCD_PAY_CARDString카드사 코드입니다.0200
PCD_PAY_CARDNAMEString카드사명입니다.삼성카드
PCD_PAY_CARDNUMString카드번호입니다.1234-**-**-5678

4. 빌링키 해지

4.1 파트너 인증 요청

빌링키 해지 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다. 한 번의 파트너 인증으로 30분 동안 조회 요청이 가능합니다. 매 조회마다 새로운 인증이 필요하지 않습니다.

파라미터필수타입길이설명값 예시
cst_idString12파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.test
custKeyString255파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
PCD_PAY_WORKString20빌링키 해지 요청을 위한 파라미터입니다.PUSERDEL

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
server_nameString파트너 인증 서버의 Domain을 반환합니다.democpay.payple.kr
resultString응답 코드입니다.
  • success : 성공 / error : 실패
success
result_msgString결과 메시지입니다.사용자 인증 완료!!
cst_idString파트너 ID 입니다.
  • 매 인증 시 변동되는 값입니다.
UFVNNVZ…
custKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
T3JzRkp5L…
AuthKeyString파트너 인증 키입니다.
  • 매 인증 시 변동되는 값입니다.
a688ccb3555...
PCD_PAY_HOSTString페이플 접속 주소입니다.https://democpay.payple.kr
PCD_PAY_URLString파트너 인증 결과로 응답되는 URL Path 입니다./php/cPayUser/api/cPayUserAct.php?ACT_=PUSERDEL
return_urlString파트너 인증 결과로 응답되는 URL 입니다.https://democpay.payple.kr/php/cPayUser/api/cPayUserAct.php?ACT_=PUSERDEL

4.2 빌링키 해지 요청

파트너 인증 후 빌링키 해지 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
PCD_CST_IDString255파트너 인증 후 수신한 ID입니다.UFVNNVZ…
PCD_CUST_KEYString255파트너 인증 후 수신한 키입니다.T3JzRkp5L…
PCD_AUTH_KEYString255파트너 인증 후 수신한 인증 키입니다.a688ccb3555…
PCD_PAYER_IDString255빌링키입니다.OVA3

빌링키 해지 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
PCD_PAY_RSTString요청 결과입니다.
  • success : 성공 / error : 실패
success
PCD_PAY_CODEString응답 코드입니다.PUER0000
PCD_PAY_MSGString응답 메시지입니다.카드해지 완료
PCD_PAY_TYPEString결제수단(카드/계좌)입니다.card
PCD_PAY_WORKString빌링키 해지 요청을 위한 파라미터입니다..PUSERDEL
PCD_PAYER_IDString빌링키입니다.OVA3…
PCD_PAYER_NOString파트너(상점)에서 이용하는 회원번호입니다.1234