파라미터
대사〉국내 거래
1. 파트너 인증 요청
한 번의 파트너 인증 후 30분의 유효 시간 동안 조회 요청을 해야 합니다. 거래내역 조회는 1초에 1회, 2분당 20회를 초과하는 요청은 거부됩니다. 거래내역 조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAYCHK_LIST_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… |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/PayChkActList.php |
2. 거래내역 조회
파트너 인증 후 거래내역 조회 요청 시 필요한 Request 파라미터는 아래와 같습니다. 거래내역 조회는 1초에 1회, 2분당 20회를 초과하는 요청은 거부됩니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAYCHK_LIST_FLAG | String | 1 | 거래내역 조회 요청을 위한 파라미터입니다. 다건 결과조회와 동일한 플래그를 사용합니다. | Y | |
| PCD_START_DATE | String | 8 | 조회 시작일입니다. YYYYMMDD 형식으로 전송합니다. PCD_END_DATE와의 조회 날짜 범위는 최대 1년입니다. | 20260501 | |
| PCD_END_DATE | String | 8 | 조회 종료일입니다. YYYYMMDD 형식으로 전송합니다. PCD_START_DATE와의 조회 날짜 범위는 최대 1년입니다. | 20260501 | |
| PCD_PAY_TYPE | String | 10 | 결제수단입니다.
| card | |
| PCD_DATE_TYPE | String | 10 | 거래내역 조회를 위해 반드시 EVENT_DATE를 전송해야 합니다.
PAY_DATE 모드는 국내 카드 > 결과조회 또는 국내 계좌 > 결과조회의 다건 조회를 사용합니다.
| EVENT_DATE | |
| PCD_PAY_OID | String | 64 | 특정 원거래 주문번호로 조회 결과를 필터링합니다. 전송 시 해당 주문번호의 거래내역만 조회되며, 미전송 시 조회 기간 내 전체 거래를 조회합니다. | order12345 | |
| PCD_LIMIT | Number | - | 조회 건수 제한 값입니다. 미전송 시 기본값은 100이며, 최소 1부터 최대 1000까지 설정할 수 있습니다. (EVENT_DATE 모드 전용 상한) | 1000 | |
| PCD_LASTKEY | String | 255 | 첫 요청에서는 생략합니다. 응답의 PCD_DATA.PCD_HAS_MORE가 true인 경우 반환된 PCD_DATA.PCD_LASTKEY를 다음 요청에 전송합니다. EVENT_DATE 모드에서 발급된 PCD_LASTKEY는 PAY_DATE 모드 요청에 사용할 수 없습니다. | gmUZOwXKxH64MWh3CsL3xg== | |
| PCD_REGULER_FLAG | String | 1 | 월 중복 결제 방지 사용여부 플래그입니다. Y로 전송 시, 월 중복 결제 방지 결제건만 조회됩니다. | N |
거래내역 조회 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_CODE | String | 거래내역 조회 응답코드입니다. | PCHK0000 |
| PCD_PAY_MSG | String | 거래내역 조회 응답 메시지입니다. | success |
| PCD_DATA | Object | 거래내역 조회 결과 데이터입니다. | |
| PCD_HAS_MORE | Boolean | 조회 건수가 PCD_LIMIT를 초과해 추가 조회가 필요한지 여부입니다. | false |
| PCD_LASTKEY | String | PCD_HAS_MORE가 true인 경우 다음 요청에 사용할 커서 값입니다. false인 경우 null입니다. EVENT_DATE 모드 전용 커서로, PAY_DATE 모드와 호환되지 않습니다. | gmUZOwXKxH64MWh3CsL3xg== |
| PCD_LIMIT | Number | 요청에 적용된 limit 값입니다. | 1000 |
| PCD_CONTENT | Object[] | 조회된 결제 내역 목록입니다. 조회 기간 내 거래 이력이 발생한 원결제 1건당 1개 객체로 반환됩니다. 거래가 없으면 빈 배열([])로 응답됩니다. | |
| PCD_CST_ID | String | 파트너 ID입니다. | PAYLAP01 |
| PCD_PAY_OID | String | 원거래 주문번호입니다. | order12345 |
| PCD_PAY_TIME | String | 원결제 승인 요청 시각입니다. | 2023-12-19 13:42:23 |
| PCD_PAY_TYPE | String | 결제수단입니다. (card / transfer) | card |
| PCD_PAYER_NO | String | 파트너(상점) 회원번호입니다. | 1234 |
| PCD_PAYER_ID | String | 빌링키입니다. | OVA3... |
| PCD_PAYER_EMAIL | String | 구매자 이메일입니다. | complete@payer-email.com |
| PCD_PAY_GOODS | String | 원결제의 상품명입니다. | 테스트 상품 |
| PCD_PAY_AMOUNT | Number | 원결제 승인 금액입니다. | 20000 |
| PCD_PAY_TOTAL | Number | 원결제 금액에서 누적 환불금액을 차감한 잔액입니다. 응답 시점 기준의 현재 잔액으로 반환됩니다. | 0 |
| PCD_PAY_ISTAX | String | 원결제의 과세 여부입니다. | Y |
| PCD_PAY_TAXTOTAL | Number | 원결제 부가세에서 누적 환불 부가세를 차감한 값입니다. | 0 |
| PCD_REGULER_FLAG | String | 월 중복방지 거래 설정 여부입니다. | N |
| PCD_PAY_STATE | String | 원결제의 현재 상태입니다. 응답값은 다음과 같습니다. - 결제완료 : 승인 완료 상태 - 부분승인취소완료 : 일부 환불 후 잔액이 남아 있는 상태 - 승인취소완료 : 전체 취소 완료 상태 기간 내 발생한 거래 이력은 PCD_TRANSACTIONS에서 확인합니다. | 승인취소완료 |
| PCD_PAYER_NAME | String | 구매자명입니다. | 홍길동 |
| PCD_PAYER_HP | String | 구매자 연락처입니다. | 01012345678 |
| PCD_PAY_CARDQUOTA | String | [카드 결제 시] 카드 할부 개월 수입니다. | 00 |
| PCD_PAY_CARDNAME | String | [카드 결제 시] 카드사명입니다. | 삼성카드 |
| PCD_PAY_CARDNUM | String | [카드 결제 시] 카드번호입니다. | 1234-**-**-5678 |
| PCD_PAY_CARDTRADENUM | String | [카드 결제 시] 원결제 거래의 고유 키입니다. | paypletttm0101231219134223a123 |
| PCD_PAY_CARDAUTHNO | String | [카드 결제 시] 원결제의 카드 승인번호입니다. | 12345678 |
| PCD_PAY_PAYMENT_TYPE | String | [카드 결제 시] 원결제의 카드 결제수단 중 세부 결제방식입니다. | 앱카드 |
| PCD_PAY_BANK | String | [계좌 결제 시] 은행 코드입니다. | 020 |
| PCD_PAY_BANKNAME | String | [계좌 결제 시] 은행명입니다. | 우리은행 |
| PCD_PAY_BANKNUM | String | [계좌 결제 시] 계좌번호입니다. | 123-****-456 |
| PCD_TAXSAVE_FLAG | String | [계좌 결제 시] 현금영수증 발행 여부입니다. | Y |
| PCD_TAXSAVE_RST | String | [계좌 결제 시] 현금영수증 발행 결과입니다. | Y |
| PCD_TAXSAVE_MGTNUM | String | [계좌 결제 시] 현금영수증 국세청 발행번호입니다. | G123456 |
| PCD_TRANSACTIONS | Object[] | 조회 기간 내 발생한 승인/취소 거래 이력입니다. 응답 본문(PCD_CONTENT[i])이 원결제 기준인 반면, 이 배열은 기간 내 발생한 거래만 포함합니다. | |
| PCD_TX_TYPE | String | 거래 유형입니다. APPROVAL: 승인, CANCEL: 취소 | CANCEL |
| PCD_TX_TIME | String | 거래 발생일시입니다. 승인은 결제일시, 취소는 환불 처리일시를 반환합니다. | 2026-05-01 00:01:15 |
| PCD_TX_AMOUNT | Number | 거래 금액입니다. APPROVAL은 양수, CANCEL은 음수로 반환됩니다. | -20000 |
| PCD_TX_TAX_AMOUNT | Number | 거래 부가세입니다. APPROVAL은 양수, CANCEL은 음수로 반환됩니다. | -1818 |