2. 계좌 거래내역 수집 요청
2.1. RequestJob - 수집 요청
계좌 거래내역 수집을 팝빌에 요청합니다.
- 최대 1개월 단위로 수집 요청이 가능하며, 조회일로부터 최대 3개월 이전 내역까지 조회가 가능합니다.
- API를 호출하고 반환 받은 작업아이디(JobID)는 수집을 요청한 시점으로부터 1시간 동안만 유효합니다.
Function RequestJob(CorpNum As String, BankCode As String, AccountNumber As String, SDate As String, EDate As String, Optional UserID As String = "") As String
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
BankCode | String | 4 | Y | 은행 기관코드 | |
AccountNumber | String | 30 | Y | 계좌번호 | |
SDate | String | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
EDate | String | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 작업아이디(JobID)
Throws
2.2. GetJobState - 수집 상태 확인
[RequestJob - 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID)를 이용하여 수집 상태를 확인합니다.
- 수집 상태(jobState) = 3(완료)이면서, 수집 결과코드(errorCode) = 1(수집성공)인 경우 [Search - 수집 내역 확인] 이 가능합니다.
Function GetJobState(CorpNum As String, jobID As String, Optional UserID As String = "") As PBEasyFinBankJobState
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
JobID | String | 18 | Y |
작업아이디
[RequestJob - 수집 요청] API의 반환값
|
|
UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.3. ListActiveJob - 수집 상태 목록 확인
[RequestJob - 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.
Function ListActiveJob(CorpNum As String, Optional UserID As String = "") As Collection
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | String | 50 | N | 팝빌회원 아이디 |