Search

지급이체 요청취소 API

1. 정의

지급이체 요청취소란 지급이체 요청(request)한 건을 일부 혹은 전체 취소하는 기능입니다.
지급이체 요청취소는 지급이체 요청(request)건에 대한 취소이며, 이미 지급이체를 완료한, 즉 지급이체 실행(execute)한 건에 대한 취소가 아닙니다.
지급이체 요청(request)과 요청취소는 실행 구분값인 execute_type으로 구분하여 요청합니다.

2. 프로세스 개요

3. 토큰발급

파트너 서버
파트너 인증을 위한 토큰발급을 진행해야합니다.
발급받은 access_token은 이후 다른 요청에서 필요하며, 토큰의 만료기간(60초)이 지나면 다시 토큰을 발급받으셔야 합니다. ⦁ 파트너에서는 access_token 유효기간에 맞춰서 유효한 토큰값 유지를 위한 로직을 구현하셔야 합니다.
페이플 허브에서는 사용자 인증을 OAuth 2.0으로 진행합니다.

Request Message

code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
code
Open
"as12345678"
Y
aN(10)
파트너용 토큰 확인 코드
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/oauth/token * REAL : https://hub.payple.kr/oauth/token */ Reauest HTTP URL: "https://demohub.payple.kr/oauth/token" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache
JSON
Body(Payload) 값
{ "cst_id":"test", "custKey":"abcd1234567890", "code":"as12345678" }
JSON

Response Message

토큰발급 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"T0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
code
Open
"as12345678"
파트너용 토큰 확인 코드
String
access_token
Open
"eyJhlNDlj..."
발행된 Access Token
String
token_type
Open
"Bearer" (고정값)
Access Token 유형
String
expires_in
Open
"60"
Access Token 만료 기간(초)
String
COUNT6
Response sample
{ "result":"T0000", "message":"처리 성공", "code":"as12345678", "access_token":"eyJhlNDlj...", "token_type":"Bearer", "expires_in":"60" }
JSON
result= "T0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
발급받은 access_token은 모든 요청에 Authorization 값으로 필요합니다.

4. 지급이체 요청취소

파트너 서버
파트너는 토큰발급 후 지급이체 요청취소를 수행합니다.

4.1 전체 취소

전체 취소는 그룹키(group_key)에 속한 모든 지급이체 요청(request)건을 취소하는 기능입니다.
전체 취소를 하면 요청보낸 그룹키(group_key)에 해당하는 모든 지급이체 요청건이 취소되니 이 점 유의하여 설정해주시기 바랍니다.

Request Message

지급이체 요청취소 파라미터 중 유의해야하는 부분에 대해 확인해보세요.
group_key지급이체 요청(request)시 Response 받은 값을 넣어주셔야 합니다. ⦁ 지급이체 실행(execute)을 모두 완료하여 지급이체 요청건이 남아있지 않은 group_key로 지급이체 요청취소를 수행하면 요청이 거부됩니다.
group_key 에 대한 더 자세한 설명은 여기에서 확인해보세요!
파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
cst_id
Open
"test"
Y
aN(8)
파트너 ID
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
group_key
Open
"Q0RSSkYzWUI3..."
Y
aN(64)
실행 그룹 키
billing_tran_id
Open
"ALL"
Y
A
전체취소시 ALL
execute_type
Open
"CANCEL"
Y
A
실행 구분 - 요청취소
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/transfer/execute * REAL : https://hub.payple.kr/transfer/execute */ Reauest HTTP URL: "https://demohub.payple.kr/transfer/execute" 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) 값
{ "cst_id":"test", "custKey":"abcd1234567890", "group_key":"Q0RSSkYzWUI3...", "billing_tran_id":"ALL", "execute_type":"CANCEL" }
JSON

Response Message

지급이체 요청취소(전체)가 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
cst_id
Open
"test"
파트너 ID
String
group_key
Open
"Q0RSSkYzWUI3..."
실행 그룹 키
String
billing_tran_id
Open
"ALL"
전체취소시 ALL
String
tot_tran_amt
Open
"5000"
총 지급이체금액
String
remain_amt
Open
"9995000"
지급이체 한도 잔여금액
String
execute_type
Open
"CANCEL"
실행 구분 - 요청취소
String
api_tran_dtm
Open
"20211022152040289"
지급이체 요청취소일시(밀리세컨드)
String
COUNT9
Response example
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "group_key":"Q0RSSkYzWUI3...", "billing_tran_id":"ALL", "tot_tran_amt":"5000", "remain_amt":"9995000", "execute_type":"CANCEL", "api_tran_dtm":"20211022152040289" }
JSON
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.

4.2 개별 취소

개별 취소는 그룹키(group_key)에 속한 지급이체 요청(request)건 중 지정한 빌링키(billing_tran_id)의 지급이체 요청건만 취소하는 기능입니다.
그룹키(group_key)에 속한 특정 빌링키(biling_tran_id)의

Request Message

group_key지급이체 요청(request)시 Response 받은 값을 넣어주셔야 합니다. ⦁ 지급이체 실행(execute)을 모두 완료하여 지급이체 요청건이 남아있지 않은 group_key로 지급이체 요청취소를 수행하면 요청이 거부됩니다.
group_key 에 대한 더 자세한 설명은 여기에서 확인해보세요!
파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
cst_id
Open
"test"
Y
aN(8)
파트너 ID
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
group_key
Open
"Q0RSSkYzWUI3..."
Y
aN(64)
실행 그룹 키
billing_tran_id
Open
"6fen3g2m-j9hb-..."
Y
aNS(40)
개별취소시 특정 계좌 빌링키 - 지급이체 요청을 취소한 빌링키
execute_type
Open
"CANCEL"
Y
A
실행 구분 - 요청취소
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/transfer/execute * REAL : https://hub.payple.kr/transfer/execute */ Reauest HTTP URL: "https://demohub.payple.kr/transfer/execute" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Authorization: Bearer, Access Token
JSON
$arrObHeader = array ( "Authorization: Bearer $arrResultToken[access_token]", "Accept: application/json" );
PHP
PHP - Header 값 설정 예시
Body(Payload) 값
{ "cst_id":"test", "custKey":"abcd1234567890", "group_key":"Q0RSSkYzWUI3...", "billing_tran_id":"6fen3g2m-j9hb-...", "execute_type":"CANCEL" }
JSON

Response Message

지급이체 요청취소가 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
cst_id
Open
"test"
파트너 ID
String
group_key
Open
"Q0RSSkYzWUI3..."
실행 그룹 키
String
billing_tran_id
Open
"6fen3g2m-j9hb-..."
(실명 인증된) 계좌 빌링키 - 지급이체 요청을 취소한 빌링키
String
tot_tran_amt
Open
"5000"
총 지급이체금액
String
remain_amt
Open
"9995000"
지급이체 한도 잔여금액
String
execute_type
Open
"CANCEL"
실행 구분 - 요청취소
String
api_tran_dtm
Open
"20211022152040289"
지급이체 요청취소일시(밀리세컨드)
String
COUNT9
Response example
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "group_key":"Q0RSSkYzWUI3...", "billing_tran_id":"6fen3g2m-j9hb-...", "tot_tran_amt":"5000", "remain_amt":"9995000", "execute_type":"CANCEL", "api_tran_dtm":"20211022152040289" }
JSON
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
TOP