Search
🔎

등록 조회 (카드 / 계좌)

1. 정의

재결제를 위해 등록했던 카드/계좌의 빌링키(PCD_PAYER_ID)의 상태를 조회하는 API입니다.

2. 프로세스 개요

3. 파트너 인증

파트너 서버

Request Message

기본 보기
Search
파라미터 정보
Parameter
더 알아보기
Type (Length)
Parameter value
Reference
custKey
Open
aN(255)
abcd1234567890
파트너 인증키
PCD_PAY_WORK
Open
A(20)
PUSERINFO
등록 조회용 Parameter
COUNT3
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://democpay.payple.kr/php/auth.php * REAL : https://cpay.payple.kr/php/auth.php */ Request URL: "https://democpay.payple.kr/php/auth.php" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Referer: https://파트너사 도메인 /* ※ Referer 설정 방법 * REAL : referer에는 파트너사 도메인으로 등록된 도메인을 넣어주셔야합니다. * 다른 도메인을 넣으시면 [AUTH0004] 응답이 발생합니다. */
JSON
Referer에 대한 자세한 설명은 이곳에서 확인해보세요!
Body(Payload) 값
{ "cst_id": "test", "custKey": "abcd1234567890", "PCD_PAY_WORK": "PUSERINFO" }
JSON
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드

Response Message

파트너 인증이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
Parameter
더 알아보기
Parameter value
Reference
Type
server_name
Open
"democpay.payple.kr"
파트너 인증시 페이플의 요청 URL
String
result
Open
"success"
결과확인
String
result_msg
Open
"사용자 인증 완료!!"
결과메세지
String
cst_id
Open
"UFVNNVZ..."
파트너 ID
String
custKey
Open
"T3JzRkp5L..."
파트너 Key
String
AuthKey
Open
"a688ccb3555..."
파트너 인증토큰
String
PCD_PAY_HOST
Open
"https://democpay.payple.kr"
결제요청 도메인
String
PCD_PAY_URL
Open
"<return_uri>"
결제요청 URI *고정값으로 사용하지 않기를 권장합니다.
String
return_url
Open
"<return full uri>"
결제요청 URI (PCD_PAY_HOST + PCD_PAY_URL) *요청시 Request URL *고정값으로 사용하지 않기를 권장합니다.
String
COUNT9
Response sample
{ "server_name": "요청 URL", "result": "결과확인", "result_msg": "결과 메시지", "cst_id": "파트너사 아이디", "custKey": "파트너사 키", "AuthKey": "파트너사 인증토큰", "PCD_PAY_HOST": "요청 도메인, (예: https://democpay.payple.kr)", "PCD_PAY_URL": "요청 URL, (예: /auth.php)", "return_url": "요청 URL (PCD_PAY_HOST + PCD_PAY_URL)" }
JSON
실패 리턴 (result = error)을 받으신 경우, result_msg 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.

4. 등록 조회 요청

파트너 서버
파트너는 파트너 인증 완료 후 등록 조회요청을 수행합니다.
이때 파트너 인증 후 Response 받은 cst_id, custKey, AuthKey 값을 각각 PCD_CST_ID, PCD_CUST_KEY, PCD_AUTH_KEY 에 넣어 요청을 보냅니다.
파트너 인증 후 Response 받은 인증토큰 ( cst_id, custKey,AuthKey ) - 해당 값의 유효기간은 30분입니다. - 한 번의 파트너 인증으로 유효기간(30분) 이내에 조회 요청을 보내셔야 합니다. - 매 조회요청마다 새로운 파트너 인증을 하지 않아도, 한 번의 파트너 인증 요청 후 받은 응답값으로 30분이내의 조회 요청건들은 모두 정상처리 됩니다. 즉, 최초 1회 파트너 인증 요청 후 Response 받은 인증토큰으로 조회 요청을 진행해주시길 바랍니다.

Request Message

기본 보기
Search
Parameter
더 알아보기
Type (Length)
Parameter value
Reference
PCD_CST_ID
Open
aN(255)
UFVN...
파트너 인증 후 리턴 받은 cst_id Token
PCD_CUST_KEY
Open
aN(255)
T3Jz...
파트너 인증 후 리턴 받은 custKey Token
PCD_AUTH_KEY
Open
aNS(255)
a688c...
파트너 인증 후 리턴 받은 인증 Token
PCD_PAYER_ID
Open
aNS(255)
VEJMT0F...
카드/계좌등록 후 리턴 받은 빌링키
COUNT4
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * 등록조회 요청 * Request HTTP URL * ※파트너 인증 후 리턴받은 return_url로 설정해주세요. * (return_url = PCD_PAY_HOST + PCD_PAY_URL) * TEST : https://democpay.payple.kr/(파트너 인증 후 리턴 받은 요청 URL(PCD_PAY_URL)) * REAL : https://cpay.payple.kr/(파트너 인증 후 리턴 받은 요청 URL(PCD_PAY_URL)) */ Request URL: "https://democpay.payple.kr/(파트너 인증후 리턴받은 PCD_PAY_URL)" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Referer: http://localhost:8080
JSON
Body(Payload) 값
{ "PCD_CST_ID": "파트너 인증 후 리턴받은 cst_id", "PCD_CUST_KEY": "파트너 인증 후 리턴받은 custKey", "PCD_AUTH_KEY": "파트너 인증 후 리턴받은 AuthKey", "PCD_PAYER_ID": "d0toSS9sT084bVJSNThScnFX..." }
JSON

Response Message

기본 보기
Search
Parameter
더 알아보기
결제수단
Parameter value
Reference
Type
PCD_PAY_RST
Open
카드
계좌
success
요청 결과(success, error)
String
PCD_PAY_CODE
Open
카드
계좌
0000
요청 결과코드(성공(0000), 실패)
String
PCD_PAY_MSG
Open
카드
계좌
회원조회 성공
요청결과 메시지
String
PCD_PAY_TYPE
Open
카드
계좌
transfer
결제수단 - 카드: card - 계좌이체: transfer
String
PCD_PAY_BANKACCTYPE
Open
카드
계좌
개인
고객 인증 구분
String
PCD_PAYER_ID
Open
카드
계좌
d0to...
카드/계좌 등록 후 리턴받은 빌링키
String
PCD_PAYER_NAME
Open
카드
계좌
홍길동
결제고객 이름
String
PCD_PAYER_HP
Open
카드
계좌
010-****-5678
결제고객 휴대전화번호
String
PCD_PAY_CARD
Open
카드
0200
카드사 코드
String
PCD_PAY_CARDNAME
Open
카드
BC카드
카드사명
String
PCD_PAY_CARDNUM
Open
카드
1111- ****-**** -2222
카드번호
String
PCD_PAY_ISTAX
Open
카드
Y
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N)
String
PCD_PAY_BANKNAME
Open
계좌
KEB하나은행
계좌명
String
PCD_PAY_BANKNUM
Open
계좌
123- ******** -021
계좌번호
String
COUNT14
카드 응답 예시
Response sample
{ "PCD_PAY_RST": "success", "PCD_PAY_CODE": "0000", "PCD_PAY_MSG": "회원조회 성공", "PCD_PAY_TYPE": "card", "PCD_PAY_BANKACCTYPE": "개인", "PCD_PAYER_ID": "NS9qNTgzU2xRNHR2RmFBWWFBTWk5UT09", "PCD_PAYER_NAME": "홍길동", "PCD_PAYER_HP": "010-****-5678", "PCD_PAY_CARD": "0200", "PCD_PAY_CARDNAME": "BC카드", "PCD_PAY_CARDNUM": "1111-****-****-2222", "PCD_PAY_ISTAX": "Y" }
JSON
계좌이체 응답 예시
Response sample
{ "PCD_PAY_RST": "success", "PCD_PAY_CODE": "0000", "PCD_PAY_MSG": "회원조회 성공", "PCD_PAY_TYPE": "transfer", "PCD_PAY_BANKACCTYPE": "개인", "PCD_PAYER_ID" : "NS9qNTgzU2xRNHR2RmFBWWFBTWk5UT09", "PCD_PAYER_NAME": "홍길동", "PCD_PAYER_HP": "010-****-5678", "PCD_PAY_BANK": "081", "PCD_PAY_BANKNAME": "KEB하나은행", "PCD_PAY_BANKNUM": "123-********-021" }
JSON
PCD_PAY_RST = success, PCD_PAY_CODE = "0000"이 포함될 경우 요청성공으로 판단합니다. PCD_PAY_RST = error 일 경우 요청실패로 판단합니다.
실패 리턴(PCD_PAY_RST = error )을 받으신 경우, PCD_PAY_CODE 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.