Search

일회성 간편결제 (카드 / 계좌)

1. 시작하면서

KEY 정보를 확인했다면, 이제 본격적으로 연동을 준비할 수 있습니다.
페이플 API를 통해 파트너는 서비스 특성에 맞춘 결제수단과 결제방식을 구현할 수 있습니다.
퀵가이드에서는 일반적인 온라인 쇼핑몰에서 사용할 수 있는 일회성 간편결제를 연동하는 방법을 설명합니다.
다른 결제방식의 연동방식을 안내받고 싶다면 이곳 을 클릭해서 확인해보세요.

일회성 간편결제창 미리보기

카드 결제
 개인계좌 결제
 법인계좌 결제

2. 프로세스 개요

일회성 간편결제의 결제 프로세스는 다음과 같이 진행됩니다.

3. 결제

3-1. 구매버튼 클릭

고객 결제페이지(Web)
고객이 파트너의 쇼핑몰에서 1,000원짜리 '테스트 상품' 구매를 결정했습니다.

3-2. 파트너 인증

파트너 서버
고객이 구매버튼을 누르면 파트너는 요청을 할 수 있는 사전 준비 단계인 파트너 인증 프로세스를 진행합니다.

Request Parameters

기본 보기
Search
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
"abcd1234567890"
aN(255)
Y
파트너 인증키
COUNT2
요청 파라미터의 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 설정 방법 * TEST : referer에는 테스트 결제창을 띄우는 도메인을 넣어주셔야합니다. * 결제창을 띄울 도메인과 referer값이 다르면 [AUTH0007] 응답이 발생합니다. * REAL : referer에는 파트너사 도메인으로 등록된 도메인을 넣어주셔야합니다. * 다른 도메인을 넣으시면 [AUTH0004] 응답이 발생합니다. * 또한, TEST에서와 마찬가지로 결제창을 띄우는 도메인과 같아야 합니다. */
JSON
복사
Referer에 '결제창을 띄우는 도메인'과 다른 도메인을 넣어서 보내실 경우, 결제창 호출이 차단 (AUTH0007 응답발생) 될 수 있으니 유의해주시기 바랍니다. [AUTH0007]에 대한 설명을 이곳에서 확인해보세요.
Referer에 대한 자세한 설명은 이곳에서 확인해보세요!
Body(Payload) 값
{ "cst_id": "test", "custKey": "abcd1234567890" }
JSON
복사
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드

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 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.

3-3. 결제요청

파트너 결제페이지(Web)
파트너 인증 완료 후 결제창을 호출할 수 있는 스크립트를 추가하여 페이플에 요청합니다.
<!-- Payple JavaScript 호출. (테스트/운영 선택) --> <script src="https://democpay.payple.kr/js/cpay.payple.1.0.1.js">< /script> <!-- 테스트 --> <script src="https://cpay.payple.kr/js/cpay.payple.1.0.1.js">< /script> <!-- 운영 -->
PHP
복사
페이플 결제창 스크립트 추가
샘플코드는 파라미터 정보 하단연동가이드 > 샘플코드에서 확인해보세요!
파트너 인증시 받은 AuthKeyreturn_url Parameter 값을 각각 PCD_AUTH_KEYPCD_PAY_URL에 추가하여 요청해주세요.
파트너 인증요청 후 결제는 30분이내로 진행해주시기 바랍니다.
파트너 인증 후 Response 받은 AuthKey 값은 고정값이 아니므로 저장해놓고 계속해서 사용하면 안됩니다. + 한 번의 파트너 인증과 하나의 요청이 매칭되어야 합니다. 즉 한번의 파트너 인증으로 받은 AuthKey 값을 여러 요청에 사용하면 안됩니다.
PCD_PAY_OID Parameter는 거래의 고유식별번호입니다. 요청시마다 유니크하게 새로 지정해 주세요. PCD_PAY_OID 가 중복되면 처음 처리완료된 거래보다 나중에 들어온 거래요청건은 중복시도로 판단되어 거절됩니다.
→ 이러한 이유로, 파트너사에서 유니크하게 주문번호를 지정할 수 없을 경우에는 주문번호는 미지정하는 것을 권장하고 있습니다.
※ 파트너가 주문번호를 미지정 시, 페이플에서는 임의의 주문번호를 생성하여 리턴하여 드립니다.

Request Parameters

Search
결제수단
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
카드
계좌
"card"
a(20)
Y
결제수단 선택 - card: 카드 | transfer: 계좌
카드
계좌
"PAY"
A(20)
Y
결제요청 방식
카드
"01"
N(2)
Y
01 : 페이플 간편결제
카드
계좌
"테스트 상품명"
aAHNS(255)
Y
결제 상품명
카드
계좌
"1000"
N(10)
Y
결제 요청금액
카드
계좌
"https://paytest.com"
aNS
Y
결제결과 반환URL - 상세한 설명은 여기 에서 확인 할 수 있습니다. <PCD_RST_URL의 두 가지 역할> 1. 결제결과 수신 - 콜백함수(callbackFunction)를 사용하면 PCD_RST_URL에 설정한 URL로 결과를 수신할 수 없습니다. 2. 결제창 호출방식 지정 - 결제창 호출방식 설정경로를 상대경로로 지정하면 팝업방식으로, 절대경로로 지정하면 다이렉트 방식으로 결제창이 호출됩니다.
카드
계좌
"E34…"
aNS(255)
Y
파트너 인증시 받은 AuthKey 값
카드
계좌
"https://democpay.payple.kr…"
aNS
Y
파트너 인증시 받은 return_url 값 입력
카드
계좌
"ORDER_17027809"
aN(255)
N
주문번호 - 거래에 대한 고유식별번호이므로 항상 유니크하게 지정하여야 합니다. - 파트너사에서 유니크하게 주문번호를 지정할 수 없는 경우 주문번호는 미지정 하는것을 권장합니다.
카드
계좌
"1234"
N(20)
N
파트너에서 사용하는 회원번호 *회원번호의 maxValue는 18446744073709551615 이니 요청시 유의해주세요.
카드
계좌
"홍길동"
aAH(80)
N
결제고객 이름
카드
계좌
"01012345678"
N(15)
N
결제고객 휴대전화번호를 전송하시면 고객의 승인문자 민원을 방지하기 위한 알림톡이 발송됩니다. *결제수단별 휴대전화번호 기능은 더 알아보기 링크에서 확인해주세요.
카드
계좌
"test@payple.kr"
E(100)
N
해당 이메일 주소로 결제 안내메일이 발송됩니다. - 결제창에서 이메일 주소를 미리 창에 입력하는 기능을 수행합니다. (자세한 내용은 더 알아보기 링크에서 확인해주세요.)
카드
계좌
"Y"
A(1)
N
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N) - ISTAX : Y, TAXTOTAL: null이면 페이플에서 10% 부가세를 자동으로 적용합니다.
카드
계좌
"10"
N(9)
N
⦁ 복합과세(과세+면세) 주문건에 필요한 금액이며 이 파라미터에 지정한 값이 부가세로 설정되어서 결제됩니다. - 예시) PCD_PAY_TOTAL = 1000, PCD_PAY_TAXTOTAL = 350 로 보낼경우, 해당 주문건의 복합과세가 보낸 그대로인 350원으로 지정됩니다. ※ 복합과세에는 공급가액이 아닌 실제 신고가 될 부가세 금액을 입력해야합니다. ⦁ 과세 또는 비과세의 경우 사용하지 않습니다. ⦁ 등록만 수행시(PCD_PAY_WORK = AUTH)일 경우에는 미입력
계좌
"Y"
A(1)
N
현금영수증 발행창을 노출하는 옵션Parameter입니다. - 사용: Y
카드
계좌
getResult
N
PCD_RST_URL대신 결제결과를 받을 수 있는 callback 함수를 설정할 수 있습니다. - 상세한 설명은 여기 에서 확인 할 수 있습니다.
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드

3-4. 결제 진행

고객 결제창
페이플에서 결제창을 고객의 브라우저에 호출시킵니다.
고객은 결제창에서 결제정보를 입력하여 결제를 완료합니다.

3-5. 결제 결과

페이플 서버
페이플에서 고객의 결제창을 종료시킵니다.
PCD_RST_URL로 고객의 브라우저를 리다이렉트(Redirect) 처리합니다.
callbackFunction으로 결제결과를 수신할 경우, 콜백함수로 결제결과가 반환되며 PCD_RST_URL로 고객의 브라우저를 리다이렉트(Redirect) 처리합니다.
PCD_RST_URLcallbackFunction에 대한 설명은 이곳에서 확인해보세요!

Response Parameters

파트너로 결과 리턴(Response)은 다음과 같이 진행됩니다.
Show All
Search
결제수단
Parameter
더 알아보기
Parameter value
Reference
Type
카드
계좌
"success"
요청 결과 success, error, close
String
카드
계좌
"0000"
응답코드
String
카드
계좌
"카드승인완료"
요청 결과 메시지
String
카드
계좌
"card"
결제수단(카드: card, 계좌:transfer)
String
카드
"01"
카드결제 세부 결제방식 선택
String
카드
계좌
"PAY"
결제요청방식
String
카드
계좌
"K0VnW…"
결제 후 리턴 받은 토큰키
String
카드
계좌
CERT - 결제생성 후 승인을 위한 키
String
카드
계좌
"https://democpay.payple.kr"
페이플 도메인 주소
String
카드
계좌
(CERT방식) 최종 결제요청 승인키
String
카드
계좌
(CERT방식) 최종 결제요청 URL
String
카드
계좌
"OVA3U…"
빌링키 ※ 앱카드 결제(PCD_CARD_VER = ‘02’)인 경우, 빌링키는 반환되지 않습니다. - 빌링키는 페이플 간편결제로 결제 및 등록시에만 반환되는 값입니다.
String
카드
계좌
"1234"
파트너사에서 사용하는 회원번호
String
카드
계좌
"홍길동"
고객 이름
String
카드
계좌
"01012345678"
고객 휴대전화번호
String
카드
계좌
"test@payple.kr"
고객 이메일
String
카드
계좌
"ORDER_17027809"
주문번호
String
카드
계좌
"테스트 상품명"
상품명
String
카드
계좌
"1000"
결제금액
String
카드
계좌
String
카드
계좌
"1000"
결제금액
String
카드
계좌
"1000"
결제금액
String
카드
계좌
"0"
- 복합과세(과세+면세) 주문건에 필요한 금액이며, 파트너사에서 지정하여 전송한 값이 리턴됩니다. ※복합과세는 공급가액이 아닌 실제 시고가 된 부가세 금액이 리턴됩니다.
String
카드
계좌
"Y"
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N)
String
카드
"삼성카드"
카드사명
String
카드
"1234-****-****-5678"
카드번호
String
카드
"00"
카드 할부 개월 수
String
카드
"202312191342223302115099"
거래 키
String
카드
"85324231"
승인번호
String
카드
"https://www.danalpay.."
매출전표 출력 링크
String
카드
계좌
"20231219134223"
결제시간
String
카드
계좌
"N"
String
카드
계좌
"/order_result"
결제(요청)결과 반환URL
String
계좌
"personal"
현금영수증 발행대상 (개인:personal, 사업자:company)
String
계좌
"020"
은행코드
String
계좌
"우리은행"
은행명
String
계좌
"123-********-456"
계좌번호(일부 마스킹 처리)
String
계좌
"G3482429BV2..."
현금영수증 국세청 발행번호 - PCD_TAXSAVE_FLAG 사용시 응답
String
callbackFunction 을 사용한다면 PCD_RST_URL 을 대체하여 결과를 반환합니다.
Webhook URL 을 등록하였다면 페이플에서 해당 URL로 결과를 추가로 반환합니다.
- 페이플에서는 결과 수신실패 누락을 방지하기 위해 Webhook URL 등록을 권장합니다. - 테스트 서버에서는 별도의 계정을 발급받지 않는 한 Webhook URL 등록 및 테스트가 불가합니다. - 테스트 서버에서 Webhook URL을 테스트하기 위해서 help@payple.kr 로 연락주시면 파트너 전용 테스트 계정을 발급하여 드립니다. - Webhook URL 등록 없이 테스트하시려면 PCD_RST_URL 로 수신받은 Response 데이터로 결과를 처리합니다.

3-6. 결과 처리

파트너 서버
파트너에서 페이플에서 받은 Response 데이터로 결과를 처리합니다.
PCD_PAY_RST = success, PCD_PAY_CODE = "0000"이 포함될 경우 요청성공으로 판단합니다.
PCD_PAY_RST = error 일 경우 요청실패로 판단합니다.
PCD_PAY_RST = close 일 경우 요청실패로 판단합니다.
고객이 결제창을 결제 중 종료할 경우 리턴됩니다.

3-6-1. 요청이 성공했을 경우(success)

데이터 위변조 여부를 판별하기 위해 리턴받은 PCD_PAY_TOTAL 값과 요청했던 값을 대조하여 이상이 없음을 확인합니다.
리턴받은 거래 고유식별번호인 PCD_PAY_OID를 확인하여 요청했던 거래 정보와 매칭시킵니다.
거래를 요청했던 고객에게 약정된 서비스를 제공합니다.

3-6-2. 요청이 실패했을 경우(error / close)

PCD_PAY_CODEPCD_PAY_MSG 로 원인을 파악하여 대응합니다.
응답코드 리스트 를 확인해보세요.

3-7 결제요청 재컨펌 (PCD_PAY_WORK: CERT)

파트너 서버
최종 결제요청을 위해 REST API를 통해 결제를 요청할 수 있습니다.
PAY(즉시결제) 방식과 달리 CERT(결제요청 재컨펌) 방식에서는 최종 승인 요청을 별도로 보내야합니다.
결제창을 호출하여 결제를 하는 경우, 결제요청 방식 파라미터인 PCD_PAY_WORK를 CERT(파트너 확인 후 결제)와 PAY(브라우저에서 즉시결제) 중 하나로 지정하여야 합니다.
결제요청 방식에 대한 자세한 설명은 파라미터 정의: PCD_PAY_WORK에서 확인해보세요!
결제요청 재컨펌(CERT) 방식은 아래와 같은 프로세스로 결제가 진행됩니다.
1 ~ 4 : PAY와 마찬가지로 결제창을 브라우저에 호출하여 결제요청을 보내고 결과를 받습니다.
이때, 응답결과를 받아도 아직 결제는 완료되지 않습니다. 다음 단계까지 모두 완료해야, 즉 결제 최종승인요청을 보내야 결제가 완료됩니다.
5 ~ 8 : 인증결과 및 결제준비완료 리턴을 받은 후, 페이플 서버로 결제 최종승인 요청을 보내고
결과를 받습니다. 이때, 결제결과가 'success'면 결제 완료로 판단합니다.
결제요청 재컨펌(CERT)에 해당하는 부분은 5 ~ 8 입니다.
결제요청 재컨펌(CERT) 결제 프로세스

Request Parameters

Show All
Search
결제수단
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
카드
계좌
"test"
aN(255)
Y
파트너사 cst_id
카드
계좌
"abcd1234567890"
aN(255)
Y
파트너사 custKey
카드
계좌
"a688c..."
aNS(255)
Y
CERT 결제요청 후 리턴받은 인증 토큰
카드
계좌
"Vnx..."
aNS
Y
CERT 결제요청 후 리턴받은 최종 승인요청용 키
카드
계좌
"OVA3U…"
aNS(255)
Y
빌링키 (등록 후 발급받은 키값 입력)
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * Request HTTP URL * ※결제요청 후 리턴받은 PCD_PAY_COFURL로 설정해주세요. * TEST : https://democpay.payple.kr/php/PayCardConfirmAct.php?ACT_=PAYM * REAL : https://cpay.payple.kr/php/PayCardConfirmAct.php?ACT_=PAYM */ Request URL: "https://democpay.payple.kr/php/PayCardConfirmAct.php?ACT_=PAYM" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Referer: http://localhost:8080
JSON
복사
Body(Payload) 값
{ "PCD_CST_ID":"test", "PCD_CUST_KEY": "abcd1234567890", "PCD_AUTH_KEY": "결제요청 후 리턴받은 PCD_AUTH_KEY", "PCD_PAY_REQKEY": "결제요청 후 리턴받은 PCD_PAY_REQKEY", "PCD_PAYER_ID": "결제요청 후 리턴받은 PCD_PAYER_ID" }
JSON
복사

Response Parameters

Show All
Search
결제수단
Parameter
더 알아보기
Parameter value
Reference
Type
카드
계좌
"success"
요청 결과 (success, error)
String
카드
계좌
"0000"
응답코드
String
카드
계좌
"카드결제완료"
요청 결과 메시지
String
카드
계좌
"card"
결제수단 (카드: card, 계좌:transfer)
String
카드
계좌
"Vnx..."
(CERT방식) 최종 결제요청 승인키
String
카드
계좌
"ORDER_17027809"
주문번호
String
카드
계좌
"OVA3…"
빌링키 ※ 앱카드 결제(PCD_CARD_VER = ‘02’)인 경우, 빌링키는 반환되지 않습니다. - 빌링키는 페이플 간편결제로 결제 및 등록시에만 반환되는 값입니다.
String
카드
계좌
"1234"
파트너사에서 사용하는 회원번호
String
카드
계좌
"홍길동"
고객 이름
String
카드
계좌
"01012345678"
고객 휴대전화번호
String
카드
계좌
"test@payple.kr"
고객 이메일
String
카드
계좌
"테스트 상품명"
상품명
String
카드
계좌
"1000"
결제금액
String
카드
계좌
"0"
- 복합과세(과세+면세) 주문건에 필요한 금액이며, 파트너사에서 지정하여 전송한 값이 리턴됩니다. ※복합과세는 공급가액이 아닌 실제 시고가 된 부가세 금액이 리턴됩니다.
String
카드
계좌
"Y"
과세설정 (Default: Y 이며, 과세:Y, 복합과세:Y, 비과세: N)
String
카드
계좌
"20231219134223"
결제시간
String
카드
"삼성카드"
카드사명
String
카드
"1234-****-****-5678"
카드번호
String
카드
"202312191342223302115099"
거래 키
String
카드
"85324231"
승인번호
String
카드
"https://www.danalpay.."
매출전표 출력 링크
String
카드
계좌
"Y"
String
계좌
"020"
은행코드
String
계좌
"우리은행"
은행명
String
계좌
"123-********-456"
계좌번호(일부 마스킹 처리)
String
계좌
"G3482429BV2..."
현금영수증 국세청 발행번호 - PCD_TAXSAVE_FLAG 사용시 응답
String
계좌
"Y"
현금영수증 발행여부 (발행: Y, 미발행: N)
String
계좌
"Y"
현금영수증 발행결과 (성공: Y, 실패: N)
String
카드결제(CERT) Response Sample
Response sample
{ "PCD_PAY_RST": "success" "PCD_PAY_CODE": "PCCF0000" "PCD_PAY_MSG": "카드결제완료" "PCD_PAY_REQKEY": "d2NtOFExTVF..." "PCD_PAY_OID": "ORDER_17027809" "PCD_PAY_TYPE": "card" "PCD_PAYER_ID": "OVA3..." "PCD_PAYER_NO": "1234" "PCD_PAYER_NAME": "홍길동" "PCD_PAYER_HP": "01012345678" "PCD_PAYER_EMAIL": "test@payple.kr" "PCD_PAY_GOODS": "테스트 상품명" "PCD_PAY_AMOUNT": "1000" "PCD_PAY_AMOUNT_REAL": "100" "PCD_PAY_TOTAL": "100" "PCD_PAY_TAXTOTAL": "0" "PCD_PAY_ISTAX": "Y" "PCD_PAY_CARDNAME": "삼성카드" "PCD_PAY_CARDNUM": "1234-****-****-5678" "PCD_PAY_CARDTRADENUM": "202312191342223302115099" "PCD_PAY_CARDAUTHNO": "85324231" "PCD_PAY_CARDRECEIPT": "https://www.danalpay.com/..." "PCD_PAY_TIME": "20231219134223" "PCD_SIMPLE_FLAG": "N" }
JSON
복사

4. 취소

고객이 결제 후 변심하여 취소를 원하고 있습니다.
파트너는 페이플에 취소를 요청하여 처리합니다.

4-1. 취소 프로세스

4-2. 파트너 인증

파트너 서버

Request Parameters

기본 보기
Search
Parameter
더 알아보기
Parameter value
Type (Length)
필수
Reference
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"Y"
A(1)
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_PAYCANCEL_FLAG": "Y" }
JSON
복사
PHP 샘플코드
JAVA 샘플코드
NODE 샘플코드

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-3. 결제 취소 요청

파트너 서버
파트너는 파트너 인증 완료 후 취소 요청을 수행합니다.
이때 파트너 인증 후 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
파트너 인증 후 리턴 받은 인증 Token
"a41c..."
aN
Y
환불서비스 Key (파트너 관리자 > 상점정보 > 기본정보에서 확인하실 수 있습니다.)
"Y"
A(1)
Y
‘Y’ - 고정값
"ORDER_17027809"
aN(255)
Y
원거래 주문번호
"20231219"
N(8)
Y
취소 대상 거래건이 결제된 원거래일자
"1000"
N(10)
Y
결제취소 요청금액 (기존 결제금액보다 적은 금액 입력 시 부분취소로 진행)
"10"
N(9)
N
복합과세(과세+면세) 거래건을 취소할때는 PCD_REFUND_TAXTOTAL 에 취소할 과세금액을 별도로 지정해서 취소요청을 진행합니다.
COUNT9
요청 파라미터의 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_REFUND_KEY" : "a41ce010e...", "PCD_PAYCANCEL_FLAG": "Y", "PCD_PAY_OID": "ORDER_17027809", "PCD_PAY_DATE": "20231219", "PCD_REFUND_TOTAL": "1000" }
JSON
복사

Response Parameters

기본 보기
Search
Parameter
더 알아보기
결제수단
Parameter value
Reference
Type
카드
계좌
"success"
요청 결과(success, error)
String
카드
계좌
"PAYC0000"
결과코드
String
카드
계좌
"환불성공"
결과 메시지
String
카드
계좌
"ORDER_17027809"
주문번호
String
카드
계좌
"card"
결제수단 - 카드: card - 계좌이체: transfer
String
카드
계좌
"OVA3…"
카드 및 계좌 등록 후 리턴받은 빌링키
String
카드
계좌
"테스트 상품명"
상품명
String
카드
계좌
"1000"
환불금액
String
카드
계좌
"10"
과세 및 복합과세(과세+면세) 주문건에 필요한 금액이며 파트너사에서 전송한 값을 부가세로 설정합니다. 비과세의 경우 사용하지 않습니다.
String
카드
"20231..."
카드 승인취소 거래 키
String
카드
"https://..."
매출전표 출력 링크
String
카드
계좌
"20231219134223”
취소시간
String
COUNT12
카드 취소 응답 예시
Response sample
{ "PCD_PAY_RST": "success", "PCD_PAY_CODE": "PAYC0000", "PCD_PAY_MSG": "승인취소성공", "PCD_PAY_OID": "ORDER_17027809", "PCD_PAY_TYPE": "card", "PCD_PAYER_ID": "OVA3...", "PCD_PAY_GOODS": "테스트 상품명", "PCD_REFUND_TOTAL": "1000", "PCD_REFUND_TAXTOTAL": "10", "PCD_PAY_TIME": "20231219134223", "PCD_PAY_CARDTRADENUM": "20231...", "PCD_PAY_CARDRECEIPT": "https://..." }
JSON
복사
계좌이체 취소 응답 예시
Response sample
{ "PCD_PAY_RST": "success", "PCD_PAY_CODE": "PAYC0000", "PCD_PAY_MSG": "환불성공", "PCD_PAY_OID": "ORDER_17027809", "PCD_PAY_TYPE": "transfer", "PCD_PAYER_ID": "NS9qNTgzU2xRNH...", "PCD_PAY_GOODS": "테스트 상품명", "PCD_REFUND_TOTAL": "1000", "PCD_REFUND_TAXTOTAL": "10", "PCD_PAY_TIME": "20231219134223", "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 의 응답코드를 확인하고 잘못된 부분을 수정합니다. 응답코드 리스트는 이 곳 에서 확인하실 수 있습니다.

5. 마무리

일회성 간편결제결제부터 취소까지의 연동작업을 완료하였습니다! 축하드립니다!

5-1. 이제 다른 결제방식 연동방법도 확인해보세요.

카드 계좌 정기결제
고객에게 최초 1회 카드/계좌 정보 등록만 받고, 파트너사의 다양한 결제주기에 맞춰 자동으로 결제를 받을 수 있습니다.
카드 앱카드 결제
카드사에서 제공하는 앱카드로 결제하는 방식입니다. 할부 서비스가 가능합니다.
카드 계좌 URL링크결제
개발연동이 필요없이 파트너 관리자에서 링크를 생성해 결제를 받을 수 있는 서비스입니다.
카드 계좌 비밀번호 간편결제
6자리 비밀번호를 설정하고 재결제시 비밀번호를 인증받아 결제를 처리하는 서비스입니다.

5-2. 기타 API 활용방법도 확인해보세요.

카드 계좌 결제결과 조회
거래건의 결제결과를 확인하는 API입니다.
카드 계좌 등록 조회
재결제를 위해 등록했던 카드/계좌의 빌링키(PCD_PAYER_ID)의 상태를 조회하는 API입니다.
카드 계좌 등록 해지
재결제를 위해 등록했던 카드/계좌의 빌링키(PCD_PAYER_ID)를 해지하는 API입니다.
계좌 현금영수증 발행
계좌이체로 결제가 발생한 거래의 현금영수증을 개별적으로 발행하는 API입니다.
계좌 현금영수증 취소발행
계좌이체로 결제가 발생한 거래의 현금영수증을 개별적으로 취소발행하는 API입니다.