Search
🔎

지급이체 요청(request)정보 조회 API

1. 정의

지급이체 요청(request)정보 조회란 하나의 그룹(group_key)에 묶인 지급이체 요청(request)건들을 조회하는 기능입니다. (group_key로 지급이체 실행전 요청건을 한번 더 확인하기 위함입니다.)
지급이체 요청(request)정보 조회를 이용하여 group_key에 묶인 지급이체 요청(request)건만을 건별로 확인할 수 있습니다. 즉, 지급이체가 완료되었거나 요청 취소, 실패 등 '요청'상태가 아닌 건은 포함되지 않습니다.

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. 지급이체 요청(request)정보 조회

파트너 서버
파트너는 토큰발급 후 지급이체 요청(request)정보 조회 요청을 수행합니다.

Request Message

파라미터 정보
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)
실행 그룹 키
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/request/result/group_key * REAL : https://hub.payple.kr/request/result/group_key */ Reauest HTTP URL: "https://demohub.payple.kr/request/result/group_key" 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..." }
JSON

Response Message

지급이체 요청(request)정보 조회가 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
지급이체 요청(request) 상태인 건들에 대해서만 결과가 리턴됩니다. ⦁ 지급이체 실행완료, 요청 취소, 실패 등인 건들은 조회되지 않습니다. 즉, group_key내에 존재하는 요청건들에 대해서만 조회됩니다.)
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
total
Open
"4000"
해당 그룹키의 총 지급이체 요청금액
String
count
Open
"4"
해당 그룹키의 총 지급이체 요청건수
String
cst_id
Open
"test"
파트너 ID
String
sub_id
Open
"test12385610"
파트너사 하위고객 ID
String
group_key
Open
"Q0RSSkYzWUI3..."
실행 그룹 키
String
billing_tran_id
Open
"6fen3g2m-j9hb-..."
(실명 인증된) 계좌 빌링키
String
print_content
Open
"정산테스트"
입금계좌인자내역
String
tran_amt
Open
"1000"
지급이체금액
String
remain_amt
Open
"9995000"
지급이체 한도 잔여금액
String
request_date
Open
"2021-10-26 10:55:03"
지급이체요청(request)시간
String
COUNT12
Response example
{ "result": "A0000", "message": "처리 성공", "total": "4000", "count": "4", "list": [ { "cst_id": "test", "sub_id": "test12385610", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "2g4493dc-...", "print_content": "정산테스트2", "tran_amt": "1000", "remain_amt": "9988000", "request_date": "2021-10-26 10:55:03" }, { "cst_id": "test", "sub_id": "test12385610", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "2g4493dc-...", "print_content": "정산테스트2", "tran_amt": "1000", "remain_amt": "9987000", "request_date": "2021-10-26 10:55:03" }, { "cst_id": "test", "sub_id": "test12385610", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "2g4493dc-...", "print_content": "정산테스트2", "tran_amt": "1000", "remain_amt": "9986000", "request_date": "2021-10-26 10:55:04" }, { "cst_id": "test", "sub_id": "test12385610", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "2g4493dc-...", "print_content": "정산테스트2", "tran_amt": "1000", "remain_amt": "9985000", "request_date": "2021-10-26 10:55:05" } ] }
JSON
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
TOP