계좌 거래내역 수집 요청

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

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	BankCode	String	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	AccountNumber	String	30	Y	계좌번호
4	SDate	String	8	Y	검색 시작일자 → 형식 : yyyyMMdd
5	EDate	String	8	Y	검색 종료일자 → 형식 : yyyyMMdd
6	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 작업아이디(JobID)

예외

Err

순번	변수명	타입	길이	설명
1	LastErrCode	Long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	LastErrMessage	String	-	API 처리 실패에 대한 오류메시지

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

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	jobID	String	18	Y	팝빌에서 할당한 작업아이디 → [RequestJob - 수집 요청] API의 반환값
3	UserID	String	50	N	팝빌회원 아이디

응답

PBEasyFinBankJobState

순번	변수명	타입	길이	설명
1	jobID	String	18	팝빌에서 할당한 작업아이디
2	jobState	Integer	1	수집 상태 0 접수 1 대기 2 진행 3 완료
3	startDate	String	8	시작일자 → [RequestJob - 수집 요청]에 입력한 SDate (형식 : yyyyMMdd)
4	endDate	String	8	종료일자 → [RequestJob - 수집 요청]에 입력한 EDate (형식 : yyyyMMdd)
5	errorCode	long	-	수집 결과코드 → 성공 : 1 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
6	errorReason	String	-	오류메시지 → 수집실패시 반환되는 사유
7	jobStartDT	String	14	작업 시작일시 → 형식 : yyyyMMddHHmmss
8	jobEndDT	String	14	작업 종료일시 → 형식 : yyyyMMddHHmmss
9	regDT	String	14	수집 요청일시 → 형식 : yyyyMMddHHmmss

예외

Err

순번	변수명	타입	길이	설명
1	LastErrCode	Long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	LastErrMessage	String	-	API 처리 실패에 대한 오류메시지

3. ListActiveJob - 수집 상태 목록 확인

[RequestJob - 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.

Function ListActiveJob(CorpNum As String, Optional UserID As String = "") As Collection

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

PBEasyFinBankJobState

순번	변수명	타입	길이	설명
1	jobID	String	18	팝빌에서 할당한 작업아이디
2	jobState	Integer	1	수집 상태 0 접수 1 대기 2 진행 3 완료
3	startDate	String	8	시작일자 → [RequestJob - 수집 요청]에 입력한 SDate (형식 : yyyyMMdd)
4	endDate	String	8	종료일자 → [RequestJob - 수집 요청]에 입력한 EDate (형식 : yyyyMMdd)
5	errorCode	long	-	수집 결과코드 → 성공 : 1 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
6	errorReason	String	-	오류메시지 → 수집실패시 반환되는 사유
7	jobStartDT	String	14	작업 시작일시 → 형식 : yyyyMMddHHmmss
8	jobEndDT	String	14	작업 종료일시 → 형식 : yyyyMMddHHmmss
9	regDT	String	14	수집 요청일시 → 형식 : yyyyMMddHHmmss

예외

Err

순번	변수명	타입	길이	설명
1	LastErrCode	Long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	LastErrMessage	String	-	API 처리 실패에 대한 오류메시지