1. 정의
•
지급이체 결과조회란 파트너가 하위고객에게 지급이체한 건들을 조회하는 기능입니다.
2. 프로세스 개요
3. 토큰발급
파트너 서버
•
파트너 인증을 위한 토큰발급을 진행해야합니다.
발급받은 access_token은 이후 다른 요청에서 필요하며, 토큰의 만료기간(60초)이 지나면 다시 토큰을 발급받으셔야 합니다.
⦁ 파트너에서는 access_token 유효기간에 맞춰서 유효한 토큰값 유지를 위한 로직을 구현하셔야 합니다.
페이플 허브에서는 사용자 인증을 OAuth 2.0으로 진행합니다.
Request Message
code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
기본 보기
Search
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
에 대해 더 자세히 알아보세요!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. 지급이체 결과조회
파트너 서버
•
파트너는 토큰발급 후 지급이체 결과조회 요청을 수행합니다.
Request Message
기본 보기
Search
api_tran_id 또는 distinct_key를 이용해 조회할 수 있으며
파라미터를 모두 보낼 경우, api_tran_id를 우선으로 조회합니다.
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
에 대해 더 자세히 알아보세요!Request example
•
Header 정보
/*
* Request HTTP URL
* TEST : https://demohub.payple.kr/transfer/result
* REAL : https://hub.payple.kr/transfer/result
*/
Reauest HTTP URL: "https://demohub.payple.kr/transfer/result"
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",
"api_tran_id":"9wm5a36z-5hj...",
"distinct_key": "c9z116521683..."
}
JSON
Response Message
•
지급이체 결과조회 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
기본 보기
Search
지급이체기관(은행) 표준코드는 여기에서 확인해주세요.
에서 확인해주세요.Response example
{
"result":"A0000",
"message":"처리 성공",
"cst_id":"test",
"sub_id":"test12385610",
"group_key":"Q0RSSkYzWUI3...",
"billing_tran_id":"6fen3g2m-j9hb-...",
"api_tran_id":"9wm5a36z-5hj...",
"api_tran_dtm":"20211022152040289",
"bank_tran_id":"M202112389U152040289",
"bank_tran_date":"20211022",
"bank_rsp_code":"000",
"bank_code_std":"020",
"bank_code_sub":"1234567",
"bank_name":"우리은행",
"account_num":"1234567890123456",
"account_num_masked":"1234567890123***",
"account_holder_name":"홍길동",
"print_content":"정산테스트",
"tran_amt":"1000"
}
JSON
result= "A0000", message= "처리 성공"인 경우 요청성공으로 판단합니다.