파라미터
국내 계좌〉정기(빌링) 결제
1. 결제창 호출
아래는 결제창 호출 시 사용 가능한 Request 파라미터 목록입니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| clientKey | String | 128 | 파트너 인증을 위한 클라이언트키입니다. 라이브 클라이언트키는 계약 완료 후 발급가능합니다. | test_DF55F29DA654A8CBC0F0A9DD4B556486 | |
| PCD_PAY_TYPE | String | 20 | 결제수단(카드/계좌)을 선택합니다.
| transfer | |
| PCD_PAY_WORK | String | 20 | 승인 요청 방식이며 카드 등록만 필요하다면 AUTH, 등록과 동시에 결제가 필요하다면 CERT로 설정합니다. | AUTH | |
| PCD_PAY_GOODS | String | 255 | 상품명입니다. | 테스트 상품 | |
| PCD_PAY_TOTAL | Number | 10 | 총 결제금액입니다. | 1000 | |
| PCD_RST_URL | String | 10 | 결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다. 경로지정 방식에 따라 결제창이 다르게 띄워집니다. | https://result-domain.com | |
| PCD_PAY_OID | String | 255 | 주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지 않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다. | order12345 | |
| PCD_PAYER_NO | Number | 18 | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 | |
| PCD_PAYER_NAME | String | 80 | 구매자 이름입니다. | 김이플 | |
| PCD_PAYER_HP | String | 20 | 구매자 휴대폰번호입니다. 구매자에게 결제된 상점정보를 알림톡으로 발송합니다. | 01012345678 | |
| PCD_PAYER_EMAIL | String | 100 | 구매자 이메일입니다. 결제완료, 취소 메일이 발송됩니다. | complete@payer-email.com | |
| PCD_PAY_ISTAX | String | 1 | 과세 여부입니다. 기본값은 Y 이며, 유형별로 아래와 같이 설정해주세요.
| Y | |
| PCD_PAY_TAXTOTAL | Number | 9 | 복합과세 주문 시에만 이용하며, 복합과세 주문의 부가세를 설정합니다.
| 500 | |
| PCD_TAXSAVE_FLAG | String | 1 | 현금영수증 발행창 호출 여부입니다. | Y | |
| callbackFunction | - | - | 클라이언트단에서 결과수신이 필요할 경우 사용합니다. callbackFunction을 사용해도 PCD_RST_URL은 필수로 입력되어야 합니다. | getResult | |
| PCD_USER_DEFINE1 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define1 | |
| PCD_USER_DEFINE2 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define2 |
2. 인증결과 수신
결제 정보가 성공적으로 입력된 경우, 브라우저 리다이렉트 시 수신되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 승인 결과입니다.
| success |
| PCD_PAY_CODE | String | 응답코드입니다. | PBER0000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 계좌등록이 완료되었습니다. |
| PCD_PAY_WORK | String | 승인 요청 방식 결과입니다. | AUTH |
| PCD_AUTH_KEY | String | 내부 인증토큰입니다. | K0VnW… |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)을 선택합니다.
| card |
| PCD_PAYER_NO | String | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 |
| PCD_PAYER_ID | String | 정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
| OVA3… |
| PCD_PAYER_NAME | String | 구매자 이름입니다. | 김이플 |
| PCD_PAYER_EMAIL | String | 구매자 이메일입니다. | complete@payer-email.com |
| PCD_PAYER_HP | String | 구매자 휴대폰번호입니다. | 01012345678 |
| PCD_PAY_BANKACCTYPE | String | 구매자의 개인, 사업자 여부입니다.
| personal |
| PCD_PAY_BANK | String | 은행 코드입니다. | 020 |
| PCD_PAY_BANKNAME | String | 은행명입니다. | 우리은행 |
| PCD_PAY_BANKNUM | String | 계좌번호입니다. | 123-********-456 |
| PCD_RST_URL | String | 결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다. | https://result-domain.com |
| PCD_USER_DEFINE1 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define1 |
| PCD_USER_DEFINE2 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define2 |
3. 파트너 인증 요청
빌링키 승인 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| cst_id | String | 12 | 파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다. | test | |
| custKey | String | 255 | 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
| abcd1234567890 | |
| PCD_PAY_TYPE | String | 20 | 결제수단(카드/계좌)입니다.
| transfer | |
| PCD_SIMPLE_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/SimplePayAct.php?ACT_=PAYM |
| return_url | String | 파트너 인증 결과로 응답되는 URL 입니다. | https://democpay.payple.kr/php/SimplePayAct.php?ACT_=PAYM |
4. 빌링키로 승인 요청
파트너 인증 후 빌링키 승인 요청 시 필요한 Request 파라미터는 아래와 같습니다.
| 파라미터 | 필수 | 타입 | 길이 | 설명 | 값 예시 |
|---|---|---|---|---|---|
| PCD_CST_ID | String | 255 | 파트너 인증 후 수신한 ID입니다. | UFVNNVZ… | |
| PCD_CUST_KEY | String | 255 | 파트너 인증 후 수신한 키입니다. | T3JzRkp5L… | |
| PCD_AUTH_KEY | String | 255 | 파트너 인증 후 수신한 인증 키입니다. | a688ccb3555… | |
| PCD_PAY_TYPE | String | 20 | 결제수단(카드/계좌)을 선택합니다.
| transfer | |
| PCD_PAYER_ID | String | 255 | 정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
| 1000 | |
| PCD_PAY_OID | String | 255 | 주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지 않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다. | OVA3… | |
| PCD_PAY_GOODS | String | 255 | 상품명입니다. | 테스트 상품 | |
| PCD_SIMPLE_FLAG | String | 1 | 정기(빌링), 비밀번호 간편결제 시 필요한 설정값입니다. | Y | |
| PCD_PAY_TOTAL | Number | 10 | 총 결제금액입니다. | 1000 | |
| PCD_PAY_OID | String | 255 | 주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지 않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다. | order12345 | |
| PCD_PAYER_NO | Number | 18 | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 | |
| PCD_PAYER_NAME | String | 80 | 구매자 이름입니다. | 김이플 | |
| PCD_PAYER_HP | String | 20 | 구매자 휴대폰번호입니다. 구매자에게 결제된 상점정보를 알림톡으로 발송합니다. | 01012345678 | |
| PCD_PAYER_EMAIL | String | 100 | 구매자 이메일입니다.결제완료, 취소 메일이 발송됩니다. | complete@payer-email.com | |
| PCD_PAY_ISTAX | String | 1 | 과세 여부입니다. 기본값은 Y 이며, 유형별로 아래와 같이 설정해주세요.
| Y | |
| PCD_PAY_TAXTOTAL | Number | 9 | 복합과세 주문 시에만 이용하며, 복합과세 주문의 부가세를 설정합니다.
| 500 | |
| PCD_TAXSAVE_FLAG | String | 1 | 현금영수증 발행 여부입니다.
| Y | |
| PCD_USER_DEFINE1 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define1 | |
| PCD_USER_DEFINE2 | String | 2048 | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define2 |
빌링키 승인이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.
| 파라미터 | 타입 | 설명 | 값 예시 |
|---|---|---|---|
| PCD_PAY_RST | String | 승인 결과입니다.
| success |
| PCD_PAY_CODE | String | 응답 코드입니다. | SPAY0000 |
| PCD_PAY_MSG | String | 응답 메시지입니다. | 출금이체완료 |
| PCD_PAY_OID | String | 주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다. | order12345 |
| PCD_PAY_TYPE | String | 결제수단(카드/계좌)을 선택합니다.
| transfer |
| PCD_PAYER_NO | String | 파트너(상점)에서 이용하는 회원번호입니다. | 1234 |
| PCD_PAYER_ID | String | 정기(빌링), 비밀번호 간편결제 시 필요한 빌링키입니다.
| OVA3… |
| PCD_PAYER_NAME | String | 구매자 이름입니다. | 김이플 |
| PCD_PAYER_HP | String | 구매자 휴대폰번호입니다. | 01012345678 |
| PCD_PAYER_EMAIL | String | 구매자 이메일입니다. | complete@payer-email.com |
| PCD_PAY_GOODS | String | 상품명입니다. | 테스트 상품 |
| PCD_PAY_TOTAL | String | 총 결제금액입니다. | 1000 |
| PCD_PAY_ISTAX | String | 과세 여부입니다. | Y |
| PCD_PAY_TAXTOTAL | String | 복합과세 부가세입니다. | 500 |
| PCD_PAY_BANK | String | 은행 코드입니다. | 020 |
| PCD_PAY_BANKNAME | String | 은행명입니다. | 우리은행 |
| PCD_PAY_BANKNUM | String | 계좌번호입니다. | 123-********-456 |
| PCD_PAY_TIME | String | 결제를 요청한 시간입니다. | 20231219134223 |
| PCD_TAXSAVE_FLAG | String | 현금영수증 발행 여부입니다.
| Y |
| PCD_TAXSAVE_RST | String | 현금영수증 발행 결과입니다.
| Y |
| PCD_TAXSAVE_MGTNUM | String | 현금영수증 국세청 발행번호입니다.
| G3482429BV2… |
| PCD_SIMPLE_FLAG | String | 정기(빌링), 비밀번호 간편결제 시 필요한 설정값입니다. | Y |
| PCD_USER_DEFINE1 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define1 |
| PCD_USER_DEFINE2 | String | 파트너(상점)에서 입력한 값을 그대로 응답합니다. 단, 특수문자는 공백처리 합니다. | define2 |