POPBill Developers
가이드

Webhook 수집 이벤트

Webhook Header

필드명 설명 필수 예시
Pb-Webhook-Type Webhook 유형 Y HT.CASHBILL
Pb-Webhook-MID 이벤트 식별값 Y 016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum 팝빌 사업자번호 Y 6798700433
Content-Type Webhook 메시지 Body 타입 Y application/json
Authorization Base64 인코딩한 BASIC 인증정보 N Basic VEVTVDoxMjM=
└ HTTP 인증 사용하는 경우 추가 항목
X-Api-Key API Key 인증정보 N TESTAPIKEY
└ HTTP 인증 사용하는 경우 추가 항목

팝빌은 기본으로 제공되는 Header 필드 외 프로그램 공급사 운영환경에 맞춘 커스텀 필드 지원이 가능합니다.
커스텀 필드 추가가 필요한 경우 기술지원센터(1600-9854)로 문의주시기 바랍니다.

Webhook Body

필드명 타입 길이 필수 비고
ntsconfirmNum String 9 Y 국세청 승인번호
tradeDate String 8 Y 거래일자 (형식 : yyyyMMdd)
tradeDT String 14 Y 거래일시 (형식 : yyyyMMddHHmmss)
tradeType String 4 Y 문서형태 : "승인거래" / "취소거래" 중 반환
tradeUsage String 5 Y 거래구분 : "소득공제용" / "지출증빙용" 중 반환
totalAmount String 9 Y 거래금액
supplyCost String 9 Y 공급가액
tax String 9 Y 부가세
serviceFee String 9 Y 봉사료
invoiceType String 2 Y 매입/매출 : "매입" / "매출" 중 반환
franchiseCorpNum String 10 N 발행자 사업자번호
franchiseCorpName String 200 N 발행자 상호
└ 매입 현금영수증일 경우 반환
franchiseCorpType String 1 N 발행자 사업자유형 : "1" / "2" / "3" 중 반환
└ "1" : 일반과세자
└ "2" : 간이과세자
└ "3" : 법인과세자
※매입 현금영수증일 경우 반환
identityNum String 4 N 식별번호
└ 마지막 4자리만 반환
identityNumType String 1 Y 식별번호유형 : "1" / "2" / "3" / "4" 중 반환
└ "1" : 주민등록번호
└ "2" : 사업자번호
└ "3" : 휴대전화번호
└ "4" : 신용카드번호
customerName String 70 N 구매자(고객) 성명
cardOwnerName String 70 N 카드소유자 성명
deductionType String 1 N 공제유형 : "1" / "2" / "3" / "4" 중 반환
└ "1" : 공제
└ "2" : 공제
└ "3" : 불공제
└ "4" : 불공제

이벤트 예시

  • 현금영수증 매입/매출 내역수집

    팝빌이 업데이트된 데이터를 수집하여 등록된 콜백 URL에 1시간(정시) 간격으로 자동 전달하는 시점에 실행됩니다.

    {
        "ntsconfirmNum": "K00178490",
        "tradeDate": "20221019",
        "tradeDT": "20221019000000",
        "tradeType": "승인거래",
        "tradeUsage": "소득공제용",
        "totalAmount": "5000",
        "supplyCost": "4545",
        "tax": "455",
        "serviceFee": "0",
        "invoiceType": "매출",
        "franchiseCorpNum": "6798700433",
        "franchiseCorpType": 0,
        "identityNumType": 3,
        "identityNum": "5117",
        "customerName": "정요한",
        "deductionType": 0
    }