Search
✂️

등록 해지 (카드 / 계좌)

1. 정의

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

2. 프로세스 개요

3. 파트너 인증

파트너 서버

Request Parameters

Search
파라미터 정보
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
"abcd1234567890"
aN(255)
Y
파트너 인증키
"PUSERDEL"
A(20)
Y
등록 해지용 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": "PUSERDEL" }
JSON
복사
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드
Referer에 대한 자세한 설명은 이곳에서 확인해보세요!

Response Parameters

파트너 인증이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
Parameter
더 알아보기
Parameter value
Reference
Type
"democpay.payple.kr"
파트너 인증시 페이플의 요청 URL
String
"success"
결과확인
String
"사용자 인증 완료!!"
결과메세지
String
"UFVNNVZ..."
파트너 ID
String
"T3JzRkp5L..."
파트너 Key
String
"a688ccb3555..."
파트너 인증토큰
String
"https://democpay.payple.kr"
결제요청 도메인
String
"<return_uri>"
결제요청 URI *고정값으로 사용하지 않기를 권장합니다.
String
"<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 값은 고정값이 아니므로 저장해놓고 계속해서 사용하면 안됩니다. + 한 번의 파트너 인증과 하나의 요청이 매칭되어야 합니다. 즉, 한 번의 파트너 인증으로 받은 cst_id, custKey,AuthKey 값을 여러 요청에 사용하면 안됩니다.
파트너 인증요청 후 API 요청은 30분이내로 진행해주시기 바랍니다.

Request Parameters

Search
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
"UFVN..."
aN(255)
Y
파트너 인증 후 리턴 받은 cst_id Token
"T3Jz..."
aN(255)
Y
파트너 인증 후 리턴 받은 custKey Token
"a688c..."
aNS(255)
Y
파트너 인증 후 리턴 받은 인증 AuthKey Token
"VEJMT0F..."
aNS(255)
Y
카드/계좌등록 후 리턴 받은 빌링키
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": "VEJMT0F..." }
JSON
복사

Response Parameters

Search
Parameter
더 알아보기
결제수단
Parameter value
Reference
Type
카드
계좌
"success"
요청 결과(success, error)
String
카드
계좌
"0000"
요청 결과코드(성공(0000), 실패)
String
카드
계좌
"해지완료"
요청결과 메시지
String
카드
계좌
"transfer"
결제수단 - 카드: card - 계좌이체: transfer
String
카드
계좌
"PUSERDEL"
‘PUSERDEL’ 값이 고정리턴
String
카드
계좌
"VEJMT0F..."
카드/계좌 등록 후 리턴받은 빌링키
String
카드
계좌
"1234"
파트너에서 사용하는 회원번호
String
COUNT7
Response sample
{ "PCD_PAY_RST" : "success", "PCD_PAY_CODE" : "PUSER0000", "PCD_PAY_MSG" : "카드해지완료", "PCD_PAY_TYPE" : "card", "PCD_PAY_WORK" : "PUSERDEL", "PCD_PAYER_ID" : "ekNWNW...", "PCD_PAYER_NO" : "1234" }
JSON
복사
PCD_PAY_RST = success, PCD_PAY_CODE = "0000"이 포함될 경우 요청성공으로 판단합니다. PCD_PAY_RST = error 일 경우 요청실패로 판단합니다.
실패 리턴(PCD_PAY_RST = error )을 받으신 경우, PCD_PAY_CODE 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.