POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
Webhook(웹훅)

팝빌에서 발생한 이벤트 정보를
고객사 서버로 즉시 전송합니다.

API Reference
계좌조회
.NET Core
API Reference 계좌조회 .NET Core 객체정보

A. 객체정보

Response

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
message string - API 처리에 대한 응답 메시지

PopbillException

순번변수명타입길이설명
code long - API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
Message string - API 처리 실패에 대한 오류메시지

EasyFinBankAccount

순번변수명타입길이설명
accountNumber string 30 계좌번호
bankCode string 4 은행 기관코드
  • 0011농협
  • 0004국민은행
  • 0020우리은행
  • 0088신한은행
  • 0003기업은행
  • 0081하나은행
  • 0023SC은행
  • 0002산업은행
  • 0027씨티은행
  • 0031대구은행
  • 0032부산은행
  • 0039경남은행
  • 0034광주은행
  • 0037전북은행
  • 0035제주은행
  • 0071우체국
  • 0045새마을금고
  • 0048신협
  • 0007수협
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 은행 기관코드
  • 0011농협
  • 0004국민은행
  • 0020우리은행
  • 0088신한은행
  • 0003기업은행
  • 0081하나은행
  • 0023SC은행
  • 0002산업은행
  • 0027씨티은행
  • 0031대구은행
  • 0032부산은행
  • 0039경남은행
  • 0034광주은행
  • 0037전북은행
  • 0035제주은행
  • 0071우체국
  • 0045새마을금고
  • 0048신협
  • 0007수협
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 조건부 인터넷뱅킹 아이디
{BankCode}="0004"(국민은행) 경우 필수
FastID string 50 조건부 조회전용 계정 아이디
{BankCode}="0031"(대구은행) or "0088"(신한은행) or "0048"(신협) 경우 필수
FastPWD string 50 조건부 조회전용 계정 비밀번호
{BankCode}="0031"(대구은행) or "0088"(신한은행) or "0048"(신협) 경우 필수
UsePeriod string 2 N 정액제 이용할 개월수
  • 11개월 : 기본값
  • 22개월
  • 33개월
  • 44개월
  • 55개월
  • 66개월
  • 77개월
  • 88개월
  • 99개월
  • 1010개월
  • 1111개월
  • 1212개월
파트너 포인트 사용시 입력값에 관계 없이 기본값 적용
Memo string 200 N 메모

UpdateEasyFinBankAccountForm

순번변수명타입길이필수설명
AccountPWD string 4 Y 계좌 비밀번호
AccountName string 100 N 계좌 별칭
BankID string 200 조건부 인터넷뱅킹 아이디
[UpdateBankAccount - 계좌정보 수정]의 {BankCode}="0004"(국민은행) 경우 필수
FastID string 50 조건부 조회전용 계정 아이디
[UpdateBankAccount - 계좌정보 수정]의 {BankCode}="0031"(대구은행) or "0088"(신한은행) or "0048"(신협) 경우 필수
FastPWD string 50 조건부 조회전용 계정 비밀번호
[UpdateBankAccount - 계좌정보 수정]의 {BankCode}="0031"(대구은행) or "0088"(신한은행) or "0048"(신협) 경우 필수
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 int? N API 처리에 대한 응답코드
1성공
message string - API 처리에 대한 응답 메시지
total int? N 총 검색결과 건수
perPage int? N 페이지 당 목록 건수
pageNum int? N 페이지 번호
pageCount int? N 페이지 개수
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 int 3 서비스 코드
  • 110세금계산서
  • 111홈택스수집(세금)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
  • 140현금영수증
  • 141홈택스수집(현금)
  • 150문자(SMS)
  • 151문자(LMS)
  • 152문자(MMS)
  • 153알림톡
  • 154친구톡(텍스트)
  • 155친구톡(이미지)
  • 160팩스(일반망)
  • 161팩스(지능망)
  • 170사업자등록상태조회
  • 171기업정보조회
  • 180계좌조회
  • 182계좌성명조회
  • 183계좌실명조회
txType int 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
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 결제상태
  • 1대기
  • 2승인
  • 3실패
  • 45취소
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 상태
  • 1 접수대기
  • 2 심사중
  • 3 입금대기
  • 4 환불완료
  • 5 취소
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 - 요금
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 조건부 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName string 100 Y 담당자 성명
tel string 20 Y 담당자 휴대폰
email string 100 Y 담당자 이메일
searchRole int 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

Contact - 출력부

순번변수명타입길이설명
id string 50 아이디
personName string 100 담당자 성명
tel string 20 담당자 휴대폰
email string 100 담당자 이메일
regDT string 14 등록일시
형식 : yyyyMMddHHmmss
searchRole int 1 담당자 권한
1개인권한
2읽기권한
3회사권한
mgrYN bool? - 관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state int 1 계정상태
1사용중