1. 정의
•
결제 취소란 결제된 거래건을 취소하는 기능입니다.
신용카드 취소는 취소수수료가 발생하지 않기 때문에
기본적으로 서비스가 오픈되어 있지만,
계좌이체 취소는 취소수수료가 발생하기 때문에 파트너사의 요청이 있어야 오픈됩니다.
테스트 서버에서는 카드결제 부분취소 및 비과세 설정이 불가합니다.
서버 환경별 결제 기능 비교는 이곳에서 확인해보세요.
2. 프로세스 개요
3. 파트너 인증
파트너 서버
Request Parameters
기본 보기
Search
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_PAYCANCEL_FLAG": "Y"
}
JSON
복사
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드
Response Message
•
파트너 인증이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
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
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_REFUND_KEY" : "a41ce010e...",
"PCD_PAYCANCEL_FLAG": "Y",
"PCD_PAY_OID": "test099942200156938",
"PCD_PAY_DATE": "20200320",
"PCD_REFUND_TOTAL": "1000"
}
JSON
복사
Response Parameters
기본 보기
Search
•
카드 취소 응답 예시
Response sample
{
"PCD_PAY_RST": "success",
"PCD_PAY_CODE": "PAYC0000",
"PCD_PAY_MSG": "승인취소성공",
"PCD_PAY_OID": "test201804000001",
"PCD_PAY_TYPE": "card",
"PCD_PAYER_ID": "d0to...",
"PCD_PAY_GOODS": "상품1",
"PCD_REFUND_TOTAL": "100",
"PCD_REFUND_TAXTOTAL": "10",
"PCD_PAY_TIME": "20211020140706",
"PCD_PAY_CARDTRADENUM": "20221...",
"PCD_PAY_CARDRECEIPT": "https://..."
}
JSON
복사
•
계좌이체 취소 응답 예시
Response sample
{
"PCD_PAY_RST": "success",
"PCD_PAY_CODE": "PAYC0000",
"PCD_PAY_MSG": "환불성공",
"PCD_PAY_OID": "test201804000001",
"PCD_PAY_TYPE": "transfer",
"PCD_PAYER_ID": "NS9qNTgzU2xRNH...",
"PCD_PAY_GOODS": "상품1",
"PCD_REFUND_TOTAL": "1000",
"PCD_REFUND_TAXTOTAL": "10",
"PCD_PAY_TIME": "20211020140706",
"PCD_TAXSAVE_RST": "0000",
"PCD_TAXSAVE_MSG": "현금영수증 발행취소 성공",
}
JSON
복사
PCD_PAY_RST = success, PCD_PAY_CODE = "0000"이 포함될 경우 요청성공으로 판단합니다.
PCD_PAY_RST = error 일 경우 요청실패로 판단합니다.
실패 리턴(PCD_PAY_RST = error )을 받으신 경우,
PCD_PAY_MSG 의 응답코드를 확인하고 잘못된 부분을 수정합니다.
응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.
에서 확인하실 수 있습니다.