Search
🔎

그룹별 지급이체결과 조회 API

이 글의 목차

1. 정의

그룹별 지급이체결과 조회란 같은 그룹키(group_key)로 묶인 지급이체 실행 완료건들을 일괄 조회하는 기능입니다.
그룹별 지급이체결과는 그룹키(group_key)로 지급이체 실행(execute) 요청 후 해당 그룹키의 지급이체된 결과 내역이 조회됩니다.

2. 프로세스 개요

3. 토큰발급

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

Request Message

code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
기본 보기
Search
파라미터 정보
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
"abcd1234567890"
Y
aN(255)
파트너 인증키
"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 */ 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
Parameter
더 알아보기
Response Value
Reference
Type
"T0000"
응답 코드
String
"처리 성공"
응답 메시지
String
"as12345678"
파트너용 토큰 확인 코드
String
"eyJhlNDlj..."
발행된 Access Token
String
"Bearer" (고정값)
Access Token 유형
String
"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 Message

그룹별 지급이체결과 조회 요청 파라미터 중 유의해야하는 부분에 대해 확인해보세요.
group_key공백으로 보내거나, 해당 그룹키(group_key)에 지급이체가 완료된 건이 없다면 그룹별 지급이체결과 조회요청이 거부됩니다.
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
"test"
Y
aN(8)
파트너 ID
"abcd1234567890"
Y
aN(255)
파트너 인증키
"Q0RSSkYzWUI3..."
Y
aN(64)
실행 그룹 키
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/transfer/result/group_key * REAL : https://hub.payple.kr/transfer/result/group_key */ Reauest HTTP URL: "https://demohub.payple.kr/transfer/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

그룹별 지급이체결과 조회요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
그룹별 지급이체결과로는 조회 요청시 보낸 그룹키(group_key)에 속해있는 지급이체가 완료된 모든 건이 리턴됩니다. JSON Key 값 'list' 에 지급이체 건별로 담겨서 리턴됩니다. (아래 Response example에서 확인해보세요.)
기본 보기
Search
Parameter
더 알아보기
Response Value
Reference
Type
"A0000"
응답 코드
String
"처리 성공"
응답 메시지
String
"3000"
해당 그룹키의 총 지급이체 완료금액
String
"3"
해당 그룹키의 총 지급이체 완료건수
String
"test"
파트너 ID
String
"test12385610"
파트너사 하위고객 ID
String
"Q0RSSkYzWUI3..."
실행 그룹 키
String
"6fen3g2m-j9hb-..."
(실명 인증된) 계좌 빌링키
String
"9wm5a36z-5hj..."
지급이체 거래고유번호
String
"20211022152040289"
지급이체일시(밀리세컨드)
String
"M202112389U152040289"
은행 거래고유번호
String
"20211022"
지급이체일자
String
"000"
지급이체기관 응답코드
String
"020"
지급이체기관 표준코드
String
"1234567"
지급이체기관 점별코드
String
"우리은행"
지급이체기관명
String
"1234567890123456"
계좌번호
String
"1234567890123***"
계좌번호(마스킹처리)
String
"홍길동"
계좌예금주명
String
"정산테스트"
입금계좌인자내역
String
"1000"
지급이체금액
String
COUNT21
Response example
{ "result": "A0000", "message": "처리 성공", "total": "3000", "count": "3", "list": [ { "cst_id": "test", "sub_id": "test12385fs10", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "ofxlrep6-0jvu-...", "api_tran_dtm": "20211029113535653", "bank_tran_id": "M202112389U113535652", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산테스트", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "lpb8dswe-qv2t-...", "api_tran_dtm": "20211029113535666", "bank_tran_id": "M202112389U113535664", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산테스트", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "9dpsom2p-h97n-...", "api_tran_dtm": "20211029113535676", "bank_tran_id": "M202112389U113535675", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산테스트", "tran_amt": "1000" } ] }
JSON
복사