1. 정의
•
지급이체 요청취소란 지급이체 요청(request)한 건을 일부 혹은 전체 취소하는 기능입니다.
지급이체 요청취소는 지급이체 요청(request)건에 대한 취소이며,
이미 지급이체를 완료한, 즉 지급이체 실행(execute)한 건에 대한 취소가 아닙니다.
•
지급이체 요청(request)과 요청취소는 실행 구분값인 execute_type으로 구분하여 요청합니다.
2. 프로세스 개요
3. 토큰발급
파트너 서버
•
파트너 인증을 위한 토큰발급을 진행해야합니다.
발급받은 access_token은 이후 다른 요청에서 필요하며, 토큰의 만료기간(60초)이 지나면 다시 토큰을 발급받으셔야 합니다.
⦁ 파트너에서는 access_token 유효기간에 맞춰서 유효한 토큰값 유지를 위한 로직을 구현하셔야 합니다.
페이플 허브에서는 사용자 인증을 OAuth 2.0으로 진행합니다.
Request Message
code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
기본 보기
Search
Request sample
•
Header 정보
/*
* Request HTTP URL
* TEST : https://demohub.payple.kr/oauth/token
* REAL : https://hub.payple.kr/oauth/token
*/
Request 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
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로 지급이체 요청취소를 수행하면 요청이 거부됩니다.
기본 보기
Search
Request example
•
Header 정보
/*
* Request HTTP URL
* TEST : https://demohub.payple.kr/transfer/execute
* REAL : https://hub.payple.kr/transfer/execute
*/
Request 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
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로 지급이체 요청취소를 수행하면 요청이 거부됩니다.
기본 보기
Search
Request example
•
Header 정보
/*
* Request HTTP URL
* TEST : https://demohub.payple.kr/transfer/execute
* REAL : https://hub.payple.kr/transfer/execute
*/
Request 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
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= "처리 성공"인 경우 요청 성공으로 판단합니다.