A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
message | String | - | API 처리에 대한 응답 메시지 |
Err
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
Number | Long | - |
API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드 |
|
Description | String | - | API 처리 실패에 대한 오류메시지 |
EasyFinBankAccount
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
accountNumber | String | 30 | 계좌번호 | |
bankCode | String | 4 | 기관코드
|
|
accountName | String | 100 | 계좌 별칭 | |
accountType | String | 2 |
계좌 유형
└ "법인" / "개인" 중 반환 |
|
state | Integer | 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 | Boolean | - |
정액제 서비스 해지신청 여부
└ True : (신청) / False : (미신청) 중 반환 |
|
useRestrictYN | Boolean | - |
정액제 서비스 사용제한 여부
└ True : (제한) / False : (미제한) 중 반환 |
|
closeOnExpired | Boolean | - |
정액제 서비스 만료시 해지 여부
└ True : (해지) / False : (미해지) 중 반환 |
|
unPaidYN | Boolean | - |
미수금 보유 여부
└ True : (보유) / False : (미보유) 중 반환 |
|
memo | String | 200 |
메모
└ 메모 |
EasyFinBankAccountForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
BankCode | String | 4 | Y | 기관코드
|
|
AccountNumber | String | 30 | Y | 계좌번호 | |
AccountPWD | String | 6 | Y | 계좌 비밀번호 | |
AccountType | String | 2 | Y |
계좌 유형
└ "법인" / "개인" 중 택 1 |
|
IdentityNumber | String | 20 | Y |
예금주 식별정보
{AccountType} 값이 "법인" 인 경우 └ 사업자번호 입력 (10자) {AccountType} 값이 "개인" 인 경우 └ 생년월일 입력 (6자 - 형식 : YYMMDD) ※ '-' 제외하고 입력 |
|
AccountName | String | 100 | N | 계좌 별칭 | |
BankID | String | 200 | 조건부 |
인터넷뱅킹 아이디
└ 계좌가 국민은행일 경우 필수 |
|
FastID | String | 50 | 조건부 |
조회전용 계정 아이디
└ 계좌가 대구은행, 신협, 신한은행일 경우 필수 |
|
FastPWD | String | 50 | 조건부 |
조회전용 계정 비밀번호
└ 계좌가 대구은행, 신협, 신한은행일 경우 필수 |
|
UsePeriod | Integer | 2 | N |
정액제 이용할 개월수, 1~12 입력 가능
※ 미입력시 기본값 1개월처리 ※ 파트너 포인트를 사용할 경우 입력값에 관계 없이 1개월 처리 |
|
Memo | String | 200 | N | 메모 |
EasyFinJobState
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
jobID | String | 18 |
작업아이디
└ [RequestJob - 수집 요청]의 반환 값 |
|
jobState | Integer | 1 |
수집 작업의 진행 상태 : 0 / 1 / 2 / 3 중 반환
└ 0 : 접수 └ 1 : 대기 └ 2 : 진행 └ 3 : 완료 |
|
startDate | String | 8 |
시작일자
└ [RequestJob - 수집 요청] 사용시 입력한 SDate 값 (형식 : yyyyMMdd) |
|
endDate | String | 8 |
종료일자
└ [RequestJob - 수집 요청] 사용시 입력한 EDate 값 (형식 : yyyyMMdd) |
|
errorCode | Integer | - |
수집 결과코드 : 1 또는 오류코드 반환
└ 1 : 수집성공 |
|
errorReason | String | - |
오류메시지
└ 수집실패시 반환되는 사유 |
|
jobStartDT | String | 14 | 작업 시작일시 (형식 : yyyyMMddHHmmss) | |
jobEndDT | String | 14 | 작업 종료일시 (형식 : yyyyMMddHHmmss) | |
regDT | String | 14 | 수집 요청일시 (형식 : yyyyMMddHHmmss) |
EasyFinBankSearchResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Integer | - |
요청에 대한 응답코드
└ API 처리에 대한 응답코드 |
|
message | String | - |
요청에 대한 응답메시지
└ API 처리에 대한 응답 메시지 |
|
total | Long | - | 총 검색결과 건수 | |
perPage | Long | - | 페이지 당 목록 개수 | |
pageNum | Long | - | 페이지 번호 | |
pageCount | Long | - | 페이지 개수 | |
lastScrapDT | String | 14 | 최종 조회일시 (형식 : yyyyMMddHHmmss) | |
list | List<EasyFinSearchDetail> |
거래내역 조회 목록
└ 최대 1000건 |
EasyFinSearchDetail
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
tid | String | 32 |
거래내역 아이디
└ 거래 내역에 대한 팝빌이 부여한 고유 식별값 |
|
trdate | String | 8 | 거래일자 (형식 : yyyyMMdd) | |
trserial | Integer | - |
거래일련번호
└ 거래일자별 거래 내역 순번 |
|
trdt | String | 14 | 거래일시 (형식 : yyyyMMddHHmmss) | |
accIn | String | 20 | 입금액 | |
accOut | String | 20 | 출금액 | |
balance | String | 20 | 잔액 | |
remark1 | String | 500 |
비고 1
└ 적요 |
|
remark2 | String | 500 |
비고 2
└ 거래점 |
|
remark3 | String | 500 |
비고 3
└ 거래구분 |
|
remark4 | String | 500 | 비고 4 | |
regDT | String | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
memo | String | 100 |
메모
└ [SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값 |
EasyFinBankSummary
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
count | Integer | - | 수집 결과 건수 | |
cntAccIn | Integer | - | 입금거래 건수 | |
cntAccOut | Integer | - | 출금거래 건수 | |
totalAccIn | Integer | - | 입금액 합계 | |
totalAccOut | Integer | - | 출금액 합계 |
EasyFinBankFlatRate
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
referenceID | String | 18 |
계좌아이디
└ 팝빌이 계좌를 식별하는 값 |
|
contractDT | String | 14 | 정액제 서비스 시작일시 (형식 : yyyyMMddHHmmss) | |
useEndDate | String | 8 | 정액제 서비스 종료일자 (형식 : yyyyMMdd) | |
baseDate | Integer | 2 |
자동연장 결제일
└ 5 / 15 / 25 중 반환 |
|
state | Integer | 1 |
정액제 서비스 상태
└ 1 : (사용) / 2 : (해지) 중 반환 |
|
closeRequestYN | Boolean | - |
정액제 서비스 해지신청 여부
└ True : (신청) / False : (미신청) 중 반환 |
|
useRestrictYN | Boolean | - |
정액제 서비스 사용제한 여부
└ True : (제한) / False : (미제한) 중 반환 |
|
closeOnExpired | Boolean | - |
정액제 서비스 만료시 해지 여부
└ True : (해지) / False : (미해지) 중 반환 |
|
unPaidYN | Boolean | - |
미수금 보유 여부
└ True : (보유) / False : (미보유) 중 반환 |
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 |
사업자번호
└ 하이픈 '-' 제외 10자리 숫자값 |
|
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 | 종목 |
ContactInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
id | String | 50 | Y |
아이디
└ 6자 이상 50자 이하 |
|
Password | String | 20 | 조건부 |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
personName | String | 100 | Y | 담당자 성명 | |
tel | String | 20 | Y | 담당자 연락처 | |
String | 100 | Y | 담당자 이메일 | ||
regDT | String | 14 | X | 등록일시 (형식 : yyyyMMddHHmmss) | |
searchRole | Integer | 1 | N |
담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한 └ 2 : 읽기권한 └ 3 : 회사권한 |
|
mgrYN | Boolean | - | X |
관리자 여부 : True / False 중 반환
└ True : 관리자 └ False : 담당자 └ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능 |
|
state | Integer | 1 | X |
계정상태 : 1 반환
└ 1 : 사용중 |
RefundHistory
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
reqDT | String | 14 | 신청일시 (형식 : yyyyMMddHHmmss) | |
requestPoint | String | 18 | 환불 신청포인트 | |
accountBank | String | 10 | 환불계좌 은행명 | |
accountNum | String | 50 | 환불계좌번호 | |
accountName | String | 70 | 환불계좌 예금주명 | |
state | Integer | 1 |
상태
└ 1 : 접수대기 └ 2 : 심사중 └ 3 : 입금대기 └ 4 : 환불완료 └ 5 : 취소 |
|
reason | String | 200 | 환불사유 |
RefundHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
total | Long | - | 총 검색결과 건수 | |
perPage | Long | - | 페이지당 검색개수 | |
pageNum | Long | - | 페이지 번호 | |
pageCount | Long | - | 페이지 개수 | |
list | List<RefundHistory> | 환불내역 |
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 | 환불사유 |
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 |
결제상태 : 1 / 2 / 3 / 4 / 5 중 반환
└ 1 : 대기 └ 2 : 승인 └ 3 : 실패 └ 4,5 : 취소 |
|
regDT | String | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
stateDT | String | 14 | 상태일시 (형식 : yyyyMMddHHmmss) |
PaymentHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
total | Long | - | 총 검색결과 건수 | |
perPage | Long | - | 페이지당 검색개수 | |
pageNum | Long | - | 페이지 번호 | |
pageCount | Long | - | 페이지 개수 | |
list | List<PaymentHistory> | 결제내역 |
UseHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
total | Long | - | 총 검색결과 건수 | |
perPage | Long | - | 페이지당 검색개수 | |
pageNum | Long | - | 페이지 번호 | |
pageCount | Long | - | 페이지 개수 | |
list | List<UseHistory> | 사용내역 |
RefundResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
message | String | - | API 처리에 대한 응답메시지 | |
refundCode | String | 18 | 환불코드 |
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 | 정산코드 |