Request Type은 파라미터의 '자료형'을 의미하는것이 아니라, 파라미터 값의 형태를 의미합니다. Request Type 보는 방법에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다.
에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다. 메시지 포맷은 JSON(JavaScript Object Notation)입니다. 요청 후 받는 응답 파라미터는 JSON 표준대로 받아서 처리해주세요.
전체 파라미터 정의
전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 상황별 요청 및 응답 파라미터도 확인해보세요.
※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
기본 보기
Search
상황별 파라미터 정의
요청, 응답 파라미터를 파트너 인증, 카드결제, 계좌이체 결제로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법 상황별 Request 표에서 필수와 요청 구분을 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
•
필수 : 요청 구분에서 해당 파라미터의 필수 값 여부
•
요청 구분 : 해당 파라미터가 쓰이는 결제방식 및 기타 API
예시) 필수가 Y, 요청 구분이 all 이면, 모든 상황에서 필수 파라미터입니다.
필수가 Y, 요청 구분이 결제내역 조회이면, 결제내역 조회시에만 필수파라미터입니다.
필수가 Y, 요청 구분이 빌링키 결제면, 빌링키 결제 요청시에만 필수 파라미터입니다.
필수가 N, 요청 구분이 all 이면, 모든 상황에서 선택 파라미터입니다.
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요
파트너 인증 파라미터
기본 보기
Search
파트너 인증 요청 필수 파라미터 확인 예시
•
cst_id , custKey : 모든(all) 파트너 인증 요청 시 필수 파라미터입니다.
•
PCD_SIMPLE_FLAG : 빌링키 결제 요청 전, 파트너 인증 요청 시 필수 파라미터 입니다.
•
PCD_PAY_WORK : 링크결제 생성 요청 전, 파트너 인증 요청 시 "LINKREG"로 고정된 필수 파라미터입니다.
•
PCD_PAY_WORK : 등록 해지 요청 전, 파트너 인증 요청 시 "PUSERDEL"로 고정된 필수 파라미터입니다.
기본 보기
Search
파트너 인증 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
카드결제 요청 필수 파라미터 확인 예시
•
PCD_PAY_TYPE : 모든(all) 카드 결제요청 시, "card"로 고정된 필수 파라미터입니다.
•
PCD_PAYER_ID : 빌링키 결제 요청 시, 필수 파라미터 입니다.
•
PCD_PAY_OID : 모든(all) 카드 결제요청 시, 선택 파라미터입니다.
•
PCD_REFUND_KEY: 결제취소 요청 시, 필수 파라미터입니다.
기본 보기
Search
카드결제 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
계좌이체 요청 필수 파라미터 확인 예시
•
PCD_PAY_TYPE : 모든(all) 계좌이체 결제요청 시, "transfer"로 고정된 필수 파라미터입니다.
•
PCD_PAYER_ID : 빌링키 결제 요청 시, 필수 파라미터 입니다.
•
PCD_PAY_OID : 모든(all) 계좌이체 결제요청 시, 선택 파라미터입니다.
•
PCD_REFUND_KEY: 결제취소 요청 시, 필수 파라미터입니다.
기본 보기
Search
계좌이체 결제 Response 예시
{
"PCD_PAY_RST": "success",
"PCD_PAY_CODE": "BILL0000",
"PCD_PAY_MSG": "출금이체완료",
"PCD_PAY_TYPE": "transfer",
"PCD_PAY_WORK": "PAY",
"PCD_AUTH_KEY": "KExaVFNEQy9jOFJNSmhWZJVFE2dmFpd1ZqbkdrejVRdTV3PT0=",
"PCD_PAY_REQKEY": "null",
"PCD_PAY_HOST": "https://democpay.payple.kr",
"PCD_PAY_URL": "null",
"PCD_PAY_COFURL": "null",
"PCD_PAYER_ID": "VC9NVW5DMUNxVkZoUmQ...",
"PCD_PAYER_NO": "1234",
"PCD_PAYER_NAME": "홍길동",
"PCD_PAYER_HP": "01012345678",
"PCD_PAYER_EMAIL": "test@payple.kr",
"PCD_PAY_BANKACCTYPE": "personal",
"PCD_PAY_OID": "test2021010115065376005774",
"PCD_PAY_GOODS": "휴대폰",
"PCD_PAY_AMOUNT": "1000",
"PCD_PAY_DISCOUNT": "",
"PCD_PAY_AMOUNT_REAL": "1000",
"PCD_PAY_TOTAL": "1000",
"PCD_PAY_ISTAX": "Y",
"PCD_PAY_TAXTOTAL": "10",
"PCD_PAY_BANK": "011",
"PCD_PAY_BANKNAME": "NH농협은행",
"PCD_PAY_BANKNUM": "123-*******-456",
"PCD_PAY_TIME": "20210101150653",
"PCD_TAXSAVE_FLAG": "Y",
"PCD_TAXSAVE_RST": "Y",
"PCD_TAXSAVE_MGTNUM": "G12345",
"PCD_RST_URL": "/result"
}
JSON
결제요청 방식(PCD_PAY_WORK)이 'PAY'방식인 경우
기본 보기
Search