A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
message | String | - | API 처리에 대한 응답 메시지 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
message | String | - | API 처리 실패에 대한 오류메시지 |
EasyFinBankAccount
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
accountNumber | String | 30 | 계좌번호 | |
bankCode | String | 4 |
은행 기관코드
|
|
accountName | String | 100 | 계좌 별칭 | |
accountType | String | 2 |
계좌 유형
법인
개인
|
|
state | int? | 1 |
계좌 상태
0준비중
1사용
2정지
|
|
regDT | String | 14 |
팝빌에 계좌를 등록한 일시
형식 : yyyyMMddHHmmss
|
|
contractDT | String | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
useEndDate | String | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
baseDate | int? | 2 |
자동연장 결제일
5
15
25
|
|
contractState | int? | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
closeRequestYN | bool? | N |
정액제 서비스 해지신청 여부
true신청
false미신청
|
|
useRestrictYN | bool? | N |
정액제 서비스 사용제한 여부
true사용제한
false사용
|
|
closeOnExpired | bool? | N |
정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
|
|
unPaidYN | bool? | N |
미수금 보유 여부
true보유
false미보유
|
|
memo | String | 200 |
메모
계좌 등록시 입력한 메모 값
|
EasyFinBankAccountForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
BankCode | String | 4 | Y |
은행 기관코드
|
|
AccountNumber | String | 30 | Y | 계좌번호 | |
AccountPWD | String | 4 | Y | 계좌 비밀번호 | |
AccountType | String | 2 | Y |
계좌 유형
법인
개인
|
|
IdentityNumber | String | 20 | Y |
예금주 식별정보 ('-' 제외)
- {AccountType}="법인" 경우 사업자번호 - {AccountType}="개인" 경우 생년월일 (형식 : yyMMdd) |
|
AccountName | String | 100 | N | 계좌 별칭 | |
BankID | String | 200 | 조건부 | 인터넷뱅킹 아이디 | |
FastID | String | 50 | 조건부 | 조회전용 계정 아이디 | |
FastPWD | String | 50 | 조건부 | 조회전용 계정 비밀번호 | |
UsePeriod | String | 2 | N |
정액제 이용할 개월수
파트너 포인트 사용시 입력값에 관계 없이 기본값 적용
|
|
Memo | String | 200 | N | 메모 |
EasyFinBankJobState
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
jobID | String | 18 |
작업아이디
[RequestJob - 수집 요청]의 반환 값
|
|
jobState | int? | 1 |
수집 작업의 진행 상태
0접수
1대기
2진행
3완료
|
|
startDate | String | 8 |
시작일자
[RequestJob - 수집 요청]에 입력한 SDate (형식 : yyyyMMdd)
|
|
endDate | String | 8 |
종료일자
[RequestJob - 수집 요청]에 입력한 EDate (형식 : yyyyMMdd)
|
|
errorCode | long? | N |
수집 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
errorReason | String | - |
오류메시지
수집실패시 반환되는 사유
|
|
jobStartDT | String | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
jobEndDT | String | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
regDT | String | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
EasyFinBankSearchResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
message | String | - | API 처리에 대한 응답 메시지 | |
total | long | - | 총 검색결과 건수 | |
perPage | long | - | 페이지 당 목록 건수 | |
pageNum | long | - | 페이지 번호 | |
pageCount | long | - | 페이지 개수 | |
lastScrapDT | String | 14 |
최종 조회일시
형식 : yyyyMMddHHmmss
|
|
balance | String | 20 | 현재 잔액 | |
list | List<EasyFinBankSearchDetail> |
거래내역 조회 목록
최대 : 1,000건
|
EasyFinBankSearchDetail
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
tid | String | 32 |
거래내역 아이디
거래 내역에 대한 팝빌이 할당한 고유 식별값
|
|
trdate | String | 8 |
거래일자
형식 : yyyyMMdd
|
|
trserial | long? | N |
거래일련번호
거래일자별 거래 내역 순번
|
|
trdt | String | 14 |
거래일시
형식 : yyyyMMddHHmmss
|
|
accIn | String | 20 | 입금액 | |
accOut | String | 20 | 출금액 | |
balance | String | 20 | 잔액 | |
remark1 | String | 500 |
비고 1
- {BankCode}="0003"(기업은행) 경우 받는분 계좌번호 - {BankCode}="0004"(국민은행) 경우 내통장 표시내용 |
|
remark2 | String | 500 |
비고 2
은행별 제공 정보 다름(거래구분, 거래종류, 거래내용, 적요 등)
|
|
remark3 | String | 500 |
비고 3
은행별 제공 정보 다름(거래내용, 적요, 내역, 비고 등)
|
|
remark4 | String | 500 |
비고 4
은행별 제공 정보 다름(거래점, 취급점, 처리점 등)
|
|
regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
memo | String | 100 |
메모
[SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값
|
EasyFinBankSummary
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
count | long? | N | 수집 결과 건수 | |
cntAccIn | long? | N | 입금거래 건수 | |
cntAccOut | long? | N | 출금거래 건수 | |
totalAccIn | long? | N | 입금액 합계 | |
totalAccOut | long? | N | 출금액 합계 |
EasyFinBankFlatRate
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
referenceID | String | 18 |
계좌아이디
팝빌이 계좌를 식별하는 값
|
|
contractDT | String | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
useEndDate | String | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
baseDate | int? | 2 |
자동연장 결제일
5
15
25
|
|
state | int? | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
closeRequestYN | bool? | N |
정액제 서비스 해지신청 여부
true신청
false미신청
|
|
useRestrictYN | bool? | N |
정액제 서비스 사용제한 여부
true사용제한
false사용
|
|
closeOnExpired | bool? | N |
정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
|
|
unPaidYN | bool? | N |
미수금 보유 여부
true보유
false미보유
|
UseHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
total | long | - | 총 검색결과 건수 | |
perPage | long | - | 페이지당 목록 건수 | |
pageNum | long | - | 페이지 번호 | |
pageCount | long | - | 페이지 개수 | |
list | List<UseHistory> | 사용내역 |
UseHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
itemCode | String | 3 |
서비스 코드
|
|
txType | String | 2 |
포인트 증감 유형
포인트 증가
포인트 감소
|
|
txPoint | String | 18 | 증감 포인트 | |
balance | String | 18 | 잔여포인트 | |
txDT | String | 14 |
포인트 증감 일시
형식 : yyyyMMddHHmmss
|
|
userID | String | 50 | 담당자 아이디 | |
userName | String | 100 | 담당자명 |
PaymentHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
total | long | - | 총 검색결과 건수 | |
perPage | long | - | 페이지당 목록 건수 | |
pageNum | long | - | 페이지 번호 | |
pageCount | long | - | 페이지 개수 | |
list | List<PaymentHistory> | 결제내역 |
PaymentHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
productType | String | 3 |
결제 내용
포인트
정액제
미수금
|
|
productName | String | 30 | 결제 상품명 | |
settleType | String | 7 |
결제유형
무통장
신용카드
실시간계좌이체
|
|
settlerName | String | 100 | 담당자명 | |
settlerEmail | String | 100 | 담당자메일 | |
settleCost | String | 18 | 결제금액 | |
settlePoint | String | 18 | 충전포인트 | |
settleState | int | 1 |
결제상태
|
|
regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
stateDT | String | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
PaymentForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
settlerName | String | 100 | N | 담당자명 | |
settlerEmail | String | 100 | N | 담당자 이메일 | |
notifyHP | String | 20 | N |
담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
|
|
paymentName | String | 70 | Y | 입금자명 | |
settleCost | String | 18 | Y | 결제금액 |
PaymentResponse
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - | 응답코드 | |
message | String | - | 응답메시지 | |
settleCode | String | 18 | 정산코드 |
RefundHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
total | long | - | 총 검색결과 건수 | |
perPage | long | - | 페이지당 목록 건수 | |
pageNum | long | - | 페이지 번호 | |
pageCount | long | - | 페이지 개수 | |
list | List<RefundHistory> | 환불내역 |
RefundHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
reqDT | String | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
requestPoint | String | 18 | 환불 신청포인트 | |
accountBank | String | 10 | 환불계좌 은행명 | |
accountNum | String | 50 | 환불계좌번호 | |
accountName | String | 70 | 환불계좌 예금주명 | |
state | int | 1 |
상태
|
|
reason | String | 200 | 환불사유 |
RefundForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
contactName | String | 100 | Y | 담당자명 | |
tel | String | 20 | Y | 담당자 연락처 | |
requestPoint | String | 18 | Y | 환불 신청 포인트 | |
accountBank | String | 10 | Y | 은행명 | |
accountNum | String | 50 | Y | 계좌번호 | |
accountName | String | 70 | Y | 예금주명 | |
reason | String | 200 | N | 환불사유 |
RefundResponse
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
message | String | - | API 처리에 대한 응답메시지 | |
refundCode | String | 18 | 환불코드 |
ChargeInfo
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
unitCost | String | 12 | 요금 | |
chargeMethod | String | 3 |
과금유형
연동
파트너
|
|
rateSystem | String | 3 |
요금제도
정액제
종량제
|
JoinForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
ID | String | 50 | Y |
아이디
6자 이상 50자 이하
|
|
Password | String | 20 | Y |
비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함 |
|
LinkID | String | 20 | Y |
파트너 링크아이디
팝빌에서 발급한 링크아이디
|
|
CorpNum | String | 10 | Y | 사업자번호 ('-' 제외) | |
CEOName | String | 100 | Y | 대표자 성명 | |
CorpName | String | 200 | Y | 상호 | |
Addr | String | 300 | Y | 사업장 주소 | |
BizType | String | 100 | Y | 업태 | |
BizClass | String | 100 | Y | 종목 | |
ContactName | String | 100 | Y | 담당자 성명 | |
ContactEmail | String | 100 | Y | 담당자 이메일 | |
ContactTEL | String | 20 | Y | 담당자 연락처 |
CorpInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
ceoname | String | 100 | Y | 대표자 성명 | |
corpName | String | 200 | Y | 상호 | |
addr | String | 300 | Y | 주소 | |
bizType | String | 100 | Y | 업태 | |
bizClass | String | 100 | Y | 종목 |
Contact - 입력부
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
id | String | 50 | Y |
아이디
6자 이상 50자 이하
|
|
password | String | 20 | 조건부 | 비밀번호 | |
personName | String | 100 | Y | 담당자 성명 | |
tel | String | 20 | Y | 담당자 휴대폰 | |
String | 100 | Y | 담당자 이메일 | ||
searchRole | int? | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
id | String | 50 | 아이디 | |
personName | String | 100 | 담당자 성명 | |
tel | String | 20 | 담당자 휴대폰 | |
String | 100 | 담당자 이메일 | ||
regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
searchRole | int? | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
mgrYN | bool? | - |
관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
state | String | 1 |
계정상태
1사용중
|