Search

결제 취소

본 문서에서는 페이플 결제 취소 가이드를 안내합니다.

1. 정의

결제 취소란 결제된 거래건을 취소하는 기능입니다.
결제 취소는 결제 승인 기준 24시간 내에 취소 요청 보내면 즉시 취소가 되지만, 그 이후에 요청하는 건은 결제 취소 요청을 보낸 익일에 실제 결제 취소가 수행됩니다.
결제 취소 상태는 해외결제 파트너 관리자 결제내역에서 ‘상태’ 값으로 확인할 수 있습니다.

2. 프로세스 개요

3. 파트너 인증 토큰발급

Partner Server Side
파트너는 취소 요청을 보내기 전 파트너 인증 프로세스를 진행해야 합니다.
파트너 인증을 위한 토큰 발급은 취소 요청 전 필수로 진행해야 합니다.
발급받은 access_token은 취소 요청 시 필요하며, 토큰의 유효기간(10분)이 지나면 토큰을 다시 발급받으셔야 합니다.
파트너 인증 토큰발급 요청시에는 등록한 IP(White IP)와의 통신만 허용합니다. 이외 IP로 파트너 인증 토큰발급 요청을 할 경우 거부되니 주의해주세요.

Partner Authorization Request Parameters

code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
Table
Search
Parameter
더 알아보기
Parameter Value
Type (Length)
필수
Reference
service_key
Open
"abcd1234567890"
aN(255)
Y
파트너 인증키
code
Open
"as12345678"
aN(10)
Y
파트너용 토큰 확인 코드
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://demo-api.payple.kr/gpay/oauth/1.0/token * REAL : https://api.payple.kr/gpay/oauth/1.0/token */ Request HTTP URL: "https://demo-api.payple.kr/gpay/oauth/1.0/token" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache
JSON
Body(Payload) 값
{ "service_id":"demo", "service_key":"abcd1234567890", "code":"as12345678" }
JSON

Partner Authorization Response Parameters

토큰발급 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
Table
Search
Parameter
더 알아보기
Parameter Value
Reference
Type
result
Open
"T0000"
응답 코드
String
message
Open
"Process Success"
응답 메시지
String
code
Open
"as12345678"
파트너용 토큰 확인 코드
String
access_token
Open
"eyJhbGciOiJzaGEyNT…"
발행된 Access Token *결제요청시 보내야하는 인증토큰
String
token_type
Open
"Bearer" (고정값)
Access Token 유형
String
expires_in
Open
"600"
Access Token 만료 기간(초)
String
Response sample
{ "result": "T0000", "message": "Process Success", "code": "as12345678", "access_token": "eyJhbGciOiJzaGEyNT...", "token_type": "Bearer", "payCls": "demo", // 테스트 결제(결제창)인 경우에만 필요 "expires_in": "600" }
JSON
result= "T0000", message= "Process Success"인 경우 요청 성공으로 판단합니다.
이외 응답코드(result)는 이곳에서 확인해보세요!
발급받은 access_token은 취소 요청시 Authorization 값으로 필요합니다.

4. 결제 취소 요청

Partner Server Side
파트너 인증이 완료되면 취소 요청을 합니다.

Cancel Request Parameters

파트너 인증 토큰 발급시 받은 access_token값을 HTTP Authorization Header에 넣어서 요청해주세요. - 인증 토큰의 유효기간은 10분입니다. - 한 번의 파트너 인증 토큰 발급으로 유효기간(10분) 이내에 결제를 완료해야 합니다.
페이플에서는 사용자 인증을 OAuth 2.0으로 진행합니다.
Table
Search
Parameter
더 알아보기
Parameter Value
Type (Length)
필수
Reference
service_id
Open
"demo"
aN(8)
Y
파트너 ID
comments
Open
"테스트상품명"
aAHN(255)
Y
상품명
service_oid
Open
"test120220608512351"
aN(128)
Y
주문번호
pay_id
Open
"6548264741426583803027"
Y
취소할 결제건의 api_id * 결제 결과로 받은 응답값인 결제결과 고유키인 api_id를 보내야합니다.
totalAmount
Open
"0.10"
N
Y
결제 취소 요청금액 - 취소할 결제건의 실 결제금액보다 작거나 같은 금액을 보내야합니다.
currency
Open
"USD"
A(3)
Y
통화 - 취소할 결제건의 통화로 보내야합니다.
resultUrl
Open
"http://test.shop.com"
N
요청 파라미터에 넣어서 보낼 시, 그대로 응답 파라미터로 반환됩니다. - 해당 파라미터(resultUrl)는 별도의 기능은 하지 않으나, 파트너사에서 취소 성공시 리다이렉트 하는 등 활용할 수 있는 파라미터 입니다.
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://demo-api.payple.kr/gpay/cancel * REAL : https://api.payple.kr/gpay/cancel */ Request HTTP URL: "https://demo-api.payple.kr/gpay/cancel" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Authorization: Bearer, Access Token
JSON
$arrObHeader = array ( "Authorization: Bearer $paypleToken[access_token]", "Accept: application/json" );
PHP
PHP - Header 값 설정 예시
Body(Payload) 값
{ "service_id":"demo", "comments": "테스트상품명", "service_oid": "test120220608512351", "pay_id": "6548264741426583803027", "totalAmount": "0.10", "currency": "USD", "resultUrl" : "http://test.shop.com" }
JSON

Cancel Response Parameters

Table
Search
Parameter
더 알아보기
Parameter Value
Reference
Type
type
Open
"CANCEL"
요청 종류 - 결제: PAYMENT - 취소: CANCEL
String
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
resultUrl
Open
"http://test.shop.com"
취소 요청시 보낸 값 그대로 반환
String
api_date
Open
"2022-06-10 16:09:22"
결제취소 요청 일자
String
totalAmount
Open
"0.10"
결제취소 요청 금액
String
currency
Open
"USD"
결제취소 통화
String
submitTimeUtc
Open
"2022-06-10 07:09:22"
Response sample
{ "type": "CANCEL", "result": "A0000", "message": "처리 성공", "resultUrl": "http://test.shop.com", "api_date": "2022-06-10 16:09:22", "info": { "service_oid": "OID_22072217525616584799763773750", "totalAmount": "0.10", "currency": "USD", "submitTimeUtc": "2022-06-10 07:09:22" } }
JSON
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
이외 응답코드(result)는 이곳에서 확인해보세요!
Payple Inc. All rights reserved.