POPBill Developers
API Reference

1. 계좌 관리

1.1. RegistBankAccount - 계좌 등록

  • 계좌조회 서비스를 이용할 계좌를 팝빌에 등록합니다.
def registBankAccount(corpNum, bankAccountInfo, userID = "")
  • 계좌를 등록할 때 결제기간만큼 포인트가 차감됩니다. 단, 파트너 포인트를 이용하는 경우에는 1개월 요금이 과금됩니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
bankAccountInfo EasyFinBankAccountForm N - 등록할 계좌 객체정보
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException

1.2. UpdateBankAccount - 계좌정보 수정

  • 팝빌에 등록된 계좌정보를 수정합니다.
def updateBankAccount(corpNum, bankAccountInfo, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
bankAccountInfo EasyFinBankAccountForm - Y 수정할 계좌 객체정보
UserID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException

1.3. GetBankAccountInfo - 계좌정보 확인

  • 팝빌에 등록된 계좌 정보를 확인합니다.
def getBankAccountInfo(corpNum, bankCode, accountNumber, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
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 계좌번호
userID String 50 N 팝빌회원 아이디
Return

EasyFinBankAccount

Throws

PopbillException

1.4. ListBankAccount - 계좌정보 목록 조회

  • 팝빌에 등록된 계좌정보 목록을 반환합니다.
def listBankAccount(corpNum, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
userID String 50 N 팝빌회원 아이디
Return

EasyFinBankAccount[ ]

Throws

PopbillException

1.5. GetBankAccountMgtURL - 계좌 관리 팝업 URL

  • 계좌 등록, 수정 및 삭제할 수 있는 계좌 관리 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getBankAccountMgtURL(corpNum, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
userID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

1.6. closeBankAccount - 정액제 해지요청

  • 팝빌에 등록된 계좌의 정액제 해지를 요청합니다.
def closeBankAccount(corpNum, bankCode, accountNumber, closeType, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
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 계좌번호
closeType String 2 Y 정액제 해지 구분 (택 1)
일반해지 요청일이 포함된 정액제 이용기간 만료 후 해지
중도해지 요청 즉시 정지되고 팝빌 담당자가 승인시 해지
"중도"인 경우, 정액제 잔여기간은 일할로 계산되어 포인트 환불(무료 이용기간에 해지하면 전액 환불)
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException

1.7. RevokeCloseBankAccount - 정액제 해지요청 취소

  • 신청한 정액제 해지요청을 취소합니다.
def revokeCloseBankAccount(corpNum, bankCode, accountNumber, userID = "")
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
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 계좌번호
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException

1.8. DeleteBankAccount - 계좌 삭제

  • 등록된 계좌를 삭제합니다.
def deleteBankAccount(corpNum, bankCode, accountNumber, userID = "")
  • 정액제가 아닌 종량제 이용 시에만 등록된 계좌를 삭제할 수 있습니다.
  • 정액제 이용시 [CloseBankAccount – 정액제 해지요청] 함수를 사용하여 정액제를 해제할 수 있습니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
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 계좌번호
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException