Search

파라미터(Parameter) 정의

Request Type은 파라미터의 '자료형'을 의미하는것이 아니라, 파라미터 값의 형태를 의미합니다. Request Type 보는 방법에 대해 알아보세요! ※ 자료형Request, Response Parameter 모두 String 입니다.
메시지 포맷JSON(JavaScript Object Notation)입니다. 요청 후 받는 응답 파라미터는 JSON 표준대로 받아서 처리해주세요.

전체 파라미터 정의

전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 상황별 요청 및 응답 파라미터도 확인해보세요.
※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
Search
Parameter
Parameter
Request Value
Request Type (Length)
Reference
Response Value
Response Type
더 알아보기
"abcd1234567890"
aN(255)
파트너 인증키
"T3Jz..."
String
-
-
파트너 인증 후 리턴 받는 인증토큰
"a688cc..."
String
"UFVN..."
aN(255)
파트너 인증 후 리턴 받는 cst_id 토큰
-
-
"T3Jz..."
aN(255)
파트너 인증 후 리턴 받는 custKey 토큰
-
-
"a688cc..."
aNS(255)
파트너 인증 후 리턴 받는 인증 토큰
"a688cc..."
String
"test_EDr34dfe…"
파트너 인증을 위한 클라이언트 키
-
String
"a41ce010ed…"
aN
환불서비스 키
-
-
"Y"
A(1)
결제방식 선택 (비밀번호 간편결제, 빌링키 결제)
"Y" or "N"
String
"card" or "transfer"
a(20)
결제수단
"card" or "transfer"
String
"AUTH" or "PAY" or "CERT" or REST API 사용시 각 API에 해당하는 값
A(20)
결제요청 방식 * REST에서 사용될때는 요청작업의 종류를 표시
"AUTH" or "PAY" or "CERT" or REST API 사용시 각 API에 해당하는 값
String
"Y"
A(1)
결제취소 여부
-
-
"Y"
A(1)
결과조회 여부
-
-
"01" or "02"
N(2)
카드결제 세부 결제방식 선택
"01" or "02"
String
"pwd"
a
비밀번호 결제 인증방식 선택
-
-
"OVA3U…"
aNS(255)
빌링키 (계좌 및 카드정보를 암호화한 키 값)
"OVA3U…"
String
"ORDER_17027809"
aN(255)
주문번호
"ORDER_17027809"
String
"1234"
N(20)
파트너사에서 관리하는 고객번호
"1234"
String
"홍길동"
aAH(80)
결제고객 이름
"홍길동"
String
"01012345678"
N(15)
결제고객 휴대전화번호
"01012345678"
String
"test@payple.kr"
E(100)
결제고객 이메일
"test@payple.kr"
String
"티셔츠"
aAHNS(255)
상품명
"티셔츠"
String
"상품설명"
aAHNS(255)
상품 설명
"상품 설명"
String
"1000"
N(10)
결제 요청금액
"1000"
String
"Y" or "N"
A(1)
과세여부 설정
"Y" or "N"
String
"100"
N(9)
복합과세에서의 과세금액 지정 ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다.
"100"
String
"https://paytest.com"
aNS
요청결과 Return URL / 결제창 호출방식
"/result/.."
String
-
-
요청결과
"success" or "error" or "close"
String
-
-
요청결과 코드
"0000"
String
-
-
요청 결과 메시지
"카드승인완료"
String
"Vnx..."
aNS
(CERT방식) 최종 결제요청 승인키
"Vnx..."
String
"http://test.."
aNS
(CERT방식) 최종 결제요청 URL
"http://test.."
String
"20210101"
N(8)
취소 대상 거래건이 결제된 원거래일자
-
-
-
-
결제완료시간
"20210130154341"
String
"1000"
N(10)
결제취소 요청금액
"1000"
String
"100"
N(9)
취소요청금액의 지정 부가세
"100"
String
-
-
카드사 코드번호
"00"
String
-
-
카드사명
"NH"
String
-
-
카드번호
"1234-****-****-5678"
String
-
-
카드 매출전표 URL
"https://www.danalpay.com/receipt/creditcard/view..."
String
-
-
카드 승인번호
"202312191342223302115099"
String
-
-
카드 할부 개월 수
"00"
String
-
-
고객 구분
"personal" or "corporate"
String
-
-
은행코드
"011"
String
-
-
은행명
"NH농협은행"
String
-
-
계좌번호
"123-*******-456"
String
"Y" or "N"
A(1)
현금영수증 발행창 노출여부
"Y" or "N"
String
-
-
현금영수증 발행 문서번호
"G12345-1"
String
"1000"
N
현금영수증 발행요청 금액
"1000"
String
-
-
현금영수증 발행결과
"Y" or "N"
String
"01012345678"
N
현금영수증 발행대상 번호
-
-
"personal" or "company"
a
현금영수증 발행 구분
-
-
-
-
링크결제 생성 결과
"success" or "error"
String
-
-
링크결제 생성 요청 결과 메시지
"링크생성이 완료되었습니다."
String
-
-
링크결제 요청 KEY
"MjoxNj..."
String
-
-
생성된 링크결제 URL
"https://testlink.payple.kr/MjoxNj...'
String
"2022010101"
N(10)
링크결제 만료일
"2022010101"
String
-
-
파트너 인증 후 리턴 받는 인증 요청 보낸 서버 URL
"democpay.payple.kr"
String
-
-
파트너 인증 요청 결과
"success" or "error"
String
-
-
파트너 인증 후 리턴 받는 메시지
"사용자 인증 완료!!"
String
-
-
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"https://democpay.payple.kr"
String
https://democpay.payple.kr/…
aNS
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"<return_uri>"
String
-
-
파트너 인증 후 본 요청시 필요한 결제요청 URL * PCD_PAY_HOST + PCD_PAY_URL
"<return full uri>"
String
"WebViewTest://"
aNS(128)
모바일 앱 연동시 App Scheme
-
-
"params1=val1&params2=val2…"
aNS(255)
링크결제 생성시 추가로 지정할 수 있는 사용자 정의 파라미터
-
-
-
-
링크결제 생성시 추가로 지정할 수 있는 사용자 정의 파라미터인 PCD_LINK_PARAMETER를 결제완료 후 반환받는 파라미터
"params1=val1&params2=val2…"
String
aNS(200)
결제 완료 페이지에 표시될 내용
"결제완료 판매자 공지"
String
-
결제 완료 페이지에 [이동하기] 버튼 클릭시 이동될 URL
"https://payple.kr"
String
1 ~ 999
N(3)
링크결제 결제마감 수량 설정을 위한 파라미터
1 ~ 999
String
COUNT70

상황별 파라미터 정의

요청, 응답 파라미터를 파트너 인증, 카드결제, 계좌이체 결제로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법
상황별 Request 표에서 필수와 요청 구분을 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
필수 : 요청 구분에서 해당 파라미터의 필수 값 여부
요청 구분 : 해당 파라미터가 쓰이는 결제방식 및 기타 API
예시) 필수가 Y, 요청 구분이 all 이면, 모든 상황에서 필수 파라미터입니다.
필수가 Y, 요청 구분이 결제내역 조회이면, 결제내역 조회시에만 필수파라미터입니다.
필수가 Y, 요청 구분이 빌링키 결제면, 빌링키 결제 요청시에만 필수 파라미터입니다.
필수가 N, 요청 구분이 all 이면, 모든 상황에서 선택 파라미터입니다.
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요

파트너 인증 파라미터

Search
Parameter
Request Value
Type (Length)
필수
요청 구분
Reference
더 알아보기
"test"
aN(8)
Y
all
파트너 ID
"abcd1234567890"
aN(255)
Y
all
파트너 인증키
"card" or "transfer"
a(20)
Y
빌링키 결제
결제수단
"Y"
A(1)
Y
빌링키 결제
결제방식 선택 (비밀번호 간편결제, 빌링키 결제)
"Y"
A(1)
Y
결제취소
결제취소 여부
"Y"
A(1)
Y
결제내역 조회
결과조회 여부
"LINKREG" or "PUSERDEL" or "PUSERINFO"
A(20)
Y
링크결제 생성
등록 해지 및 조회
요청작업의 종류
파트너 인증 요청 필수 파라미터 확인 예시
cst_id , custKey : 모든(all) 파트너 인증 요청 시 필수 파라미터입니다.
PCD_SIMPLE_FLAG : 빌링키 결제 요청 전, 파트너 인증 요청 시 필수 파라미터 입니다.
PCD_PAY_WORK : 링크결제 생성 요청 전, 파트너 인증 요청 시 "LINKREG"로 고정된 필수 파라미터입니다.
PCD_PAY_WORK : 등록 해지 요청 전, 파트너 인증 요청 시 "PUSERDEL"로 고정된 필수 파라미터입니다.
Search
Parameter
Response Value
Type
Reference
더 알아보기
"democpay.payple.kr"
String
파트너 인증 후 리턴 받는 인증 요청 보낸 서버 URL
"success" or "error"
String
파트너 인증 요청 결과
"사용자 인증 완료!!"
String
파트너 인증 후 리턴 받는 메시지
"UFVN..."
String
파트너 ID
"T3Jz..."
String
파트너 인증키
"a688cc..."
String
파트너 인증 후 리턴 받는 인증토큰
"https://democpay.payple.kr"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"<return_uri>"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"<return full uri>"
String
파트너 인증 후 본 요청시 필요한 결제요청 URL * PCD_PAY_HOST + PCD_PAY_URL
COUNT9
파트너 인증 Response 예시
{ "server_name": "democpay.payple.kr", "result": "success", "result_msg": "사용자 인증 완료!!", "cst_id": "bnZMVTdsbGk8...", "custKey": "ek8zUlg0SWw2...", "AuthKey": "K0VnWlZ5TWZSaGNla1Vpay96YmNTbnZdCszOUpZZy9hTks0R1ExVjRUYWc9PQ==...", "PCD_PAY_HOST": "https://democpay.payple.kr", "PCD_PAY_URL": "/index.php?ACT_=PAYM&CPAYVER=202101011630", "return_url": "https://democpay.payple.kr/index.php?ACT_=PAYM&CPAYVER=202101011630" }
JSON
복사

카드 결제 파라미터

Search
Parameter
Request Value
Type (Length)
필수
요청 구분
Reference
더 알아보기
"card"
a(20)
Y
all
결제수단
"01" or "02"
N(2)
Y
all
신용카드 세부 결제방식 선택
"AUTH" or "PAY" or "CERT"
A(20)
Y
all
결제요청 방식
"티셔츠"
aAHNS(255)
Y
all
상품명
"1000"
N(10)
Y
all
결제 요청금액
"https://paytest.com"
aNS
Y
all
요청결과 Return URL / 결제창 호출방식
"https://democpay.payple.kr/index.php?ACT_=PAYM&CPAYVER=...."
aNS
Y
all
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"a688cc..."
aNS(255)
Y
all
파트너 인증 후 리턴 받는 인증 토큰
"UFVN..."
aN(255)
Y
빌링키 결제
파트너 인증 후 리턴 받는 cst_id 토큰
"T3Jz..."
aN(255)
Y
빌링키 결제
파트너 인증 후 리턴 받는 custKey 토큰
"d0to..."
aNS(255)
Y
빌링키 결제
빌링키 (계좌 및 카드정보를 암호화한 키 값)
"Y"
A(1)
Y
빌링키 결제
비밀번호 간편결제
결제방식 선택 (비밀번호 간편결제, 빌링키 결제)
"pwd"
a
Y
비밀번호 간편결제
비밀번호 결제 인증방식 선택
"test987654321"
aN(255)
N
all
주문번호
"1234"
N(20)
N
all
파트너사에서 관리하는 고객번호
"홍길동"
aAH(80)
N
all
결제고객 이름
"01012345678"
N(20)
N
all
결제고객 휴대전화번호
"test@payple.kr"
E(100)
N
all
결제고객 이메일
"Y" or "N"
A(1)
N
all
과세여부 설정
"100"
N(9)
N
all
복합과세에서의 과세금액 지정 ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다.
"Vnx..."
aNS
Y
CERT방식
(CERT방식) 최종 결제요청 승인키
"http://test.."
aNS
Y
CERT방식
(CERT방식) 최종 결제요청 URL
COUNT22
카드결제 요청 필수 파라미터 확인 예시
PCD_PAY_TYPE : 모든(all) 카드 결제요청 시, "card"로 고정된 필수 파라미터입니다.
PCD_PAYER_ID : 빌링키 결제 요청 시, 필수 파라미터 입니다.
PCD_PAY_OID : 모든(all) 카드 결제요청 시, 선택 파라미터입니다.
PCD_REFUND_KEY: 결제취소 요청 시, 필수 파라미터입니다.
Search
Parameter
Response Value
Type
Reference
더 알아보기
"success" or "error" or "close"
String
요청결과
"0000"
String
요청결과 코드
"카드승인완료"
String
요청 결과 메시지
"card"
String
결제수단
"01" or "02"
String
신용카드 세부 결제방식 선택
"AUTH" or "PAY" or "CERT"
String
결제요청 방식
"a688cc..."
String
파트너 인증 후 리턴 받는 인증 토큰
"Vnx..."
String
(CERT방식) 최종 결제요청 승인키
"https://democpay.payple.kr"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"<return_uri>"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"http://test.."
String
(CERT방식) 최종 결제요청 URL
"d0to..."
String
빌링키 (계좌 및 카드정보를 암호화한 키 값)
"1234"
String
파트너사에서 관리하는 고객번호
"홍길동"
String
결제고객 이름
"01012345678"
String
결제고객 휴대전화번호
"test@payple.kr"
String
결제고객 이메일
"test987654321"
String
주문번호
"티셔츠"
String
상품명
"1000"
String
결제 요청금액
"100"
String
복합과세에서의 과세금액 지정 ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다.
"Y" or "N"
String
과세여부 설정
"00"
String
카드사 코드번호
"NH"
String
카드사명
"1234-****-****-5678"
String
카드번호
"12345678"
String
카드 승인번호
"https://www.danalpay.com/receipt/creditcard/view..."
String
카드 매출전표 URL
"20210130154341"
String
결제완료시간
"Y" or "N"
String
결제방식 선택 (비밀번호 간편결제, 빌링키 결제)
"/result/.."
String
요청결과 Return URL / 결제창 호출방식
COUNT29
카드결제 Response 예시
{ "PCD_PAY_RST": "success", "PCD_PAY_CODE": "0000", "PCD_PAY_MSG": "카드승인완료", "PCD_PAY_TYPE": "card", "PCD_CARD_VER": "01", "PCD_PAY_WORK": "PAY", "PCD_AUTH_KEY": "K0VnVVJWVNwUXhKZ25ho1YW5tRWtRWWhdVY4aWRqS3NOT1hhb2c9PQ==", "PCD_PAY_REQKEY": "", "PCD_PAY_HOST": "https://democpay.payple.kr", "PCD_PAY_URL": "", "PCD_PAY_COFURL": "", "PCD_PAYER_ID": "U2NGZ09oRjV...", "PCD_PAYER_NO": "1234", "PCD_PAYER_NAME": "홍길동", "PCD_PAYER_HP": "01012345678", "PCD_PAYER_EMAIL": "test@payple.kr", "PCD_PAY_OID": "test202109011630459749338", "PCD_PAY_GOODS": "휴대폰", "PCD_PAY_AMOUNT": "1000", "PCD_PAY_DISCOUNT": "0", "PCD_PAY_AMOUNT_REAL": "1000", "PCD_PAY_TOTAL": "1000", "PCD_PAY_TAXTOTAL": "10", "PCD_PAY_ISTAX": "Y", "PCD_PAY_CARDNAME": "BC카드", "PCD_PAY_CARDNUM": "1234-****-****-5678", "PCD_PAY_CARDQUOTA": "00", "PCD_PAY_CARDTRADENUM": "202101011030228522684400", "PCD_PAY_CARDAUTHNO": "123456789", "PCD_PAY_CARDRECEIPT": "https://www.danalpay.com/receipt/creditcard/view...", "PCD_PAY_TIME": "20210101103022", "PCD_SIMPLE_FLAG": "N", "PCD_RST_URL": "/result" }
JSON
복사
결제요청 방식(PCD_PAY_WORK)이 'PAY'방식인 경우

계좌이체 파라미터

Search
Parameter
Request Value
Type (Length)
필수
요청 구분
Reference
더 알아보기
"transfer"
a(20)
Y
all
결제수단
"AUTH" or "PAY" or "CERT"
A(20)
Y
all
결제요청 방식
"티셔츠"
aAHNS(255)
Y
all
상품명
"1000"
N(10)
Y
all
결제 요청금액
"https://paytest.com"
aNS
Y
all
요청결과 Return URL / 결제창 호출방식
"https://democpay.payple.kr/index.php?ACT_=PAYM&CPAYVER=...."
aNS
Y
all
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"a688cc..."
aNS(255)
Y
all
파트너 인증 후 리턴 받는 인증 토큰
"UFVN..."
aN(255)
Y
빌링키 결제
파트너 인증 후 리턴 받는 cst_id 토큰
"T3Jz..."
aN(255)
Y
빌링키 결제
파트너 인증 후 리턴 받는 custKey 토큰
"d0to..."
aNS(255)
Y
빌링키 결제
빌링키 (계좌 및 카드정보를 암호화한 키 값)
"Y"
A(1)
Y
빌링키 결제
비밀번호 간편결제
결제방식 선택 (비밀번호 간편결제, 빌링키 결제)
"pwd"
a
Y
비밀번호 간편결제
비밀번호 결제 인증방식 선택
"test987654321"
aN(255)
N
all
주문번호
"1234"
N(20)
N
all
파트너사에서 관리하는 고객번호
"홍길동"
aAH(80)
N
all
결제고객 이름
"01012345678"
N(20)
N
all
결제고객 휴대전화번호
"test@payple.kr"
E(100)
N
all
결제고객 이메일
"Y" or "N"
A(1)
N
all
현금영수증 발행창 노출여부
"Y" or "N"
A(1)
N
all
과세여부 설정
"100"
N(9)
N
all
복합과세에서의 과세금액 지정 ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다.
"Vnx..."
aNS
Y
CERT방식
(CERT방식) 최종 결제요청 승인키
"http://test.."
aNS
Y
CERT방식
(CERT방식) 최종 결제요청 URL
COUNT22
계좌이체 요청 필수 파라미터 확인 예시
PCD_PAY_TYPE : 모든(all) 계좌이체 결제요청 시, "transfer"로 고정된 필수 파라미터입니다.
PCD_PAYER_ID : 빌링키 결제 요청 시, 필수 파라미터 입니다.
PCD_PAY_OID : 모든(all) 계좌이체 결제요청 시, 선택 파라미터입니다.
PCD_REFUND_KEY: 결제취소 요청 시, 필수 파라미터입니다.
Search
Parameter
Response Value
Response Type
Reference
더 알아보기
"success" or "error" or "close"
String
요청결과
"BILL0000"
String
요청결과 코드
"출금이체완료"
String
요청 결과 메시지
"transfer"
String
결제수단
"AUTH" or "PAY" or "CERT"
String
결제요청 방식
"a688cc..."
String
파트너 인증 후 리턴 받는 인증 토큰
"Vnx..."
String
(CERT방식) 최종 결제요청 승인키
"https://democpay.payple.kr"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"<return_uri>"
String
파트너 인증 후 본 요청시 필요한 페이플 도메인 주소
"http://test.."
String
(CERT방식) 최종 결제요청 URL
"d0to..."
String
빌링키 (계좌 및 카드정보를 암호화한 키 값)
"1234"
String
파트너사에서 관리하는 고객번호
"홍길동"
String
결제고객 이름
"01012345678"
String
결제고객 휴대전화번호
"test@payple.kr"
String
결제고객 이메일
"personal" or "corporate"
String
고객 구분
"test987654321"
String
주문번호
"티셔츠"
String
상품명
"1000"
String
결제 요청금액
"Y" or "N"
String
과세여부 설정
"10"
String
복합과세에서의 과세금액 지정(단위: 원) ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다.
"011"
String
은행코드
"NH농협은행"
String
은행명
"123-*******-456"
String
계좌번호
"20210130154341"
String
결제완료시간
"Y" or "N"
String
현금영수증 발행창 노출여부
"Y" or "N"
String
현금영수증 발행결과