POPBill Developers
가이드

Webhook 단건 발행 이벤트

Webhook Header

필드명 설명 필수 예시
Pb-Webhook-Type Webhook 유형 Y CASHBILL.STATE
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 인증 사용하는 경우 추가 항목
Pb-Webhook-EventType Webhook 메시지 Event 타입N이벤트 유형
└ Issue / NTS

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

Webhook Body

필드명 타입 길이 필수 설명
corpNum String 10 Y 가맹점 사업자번호
franchiseCorpNum String 10 Y 가맹점 사업자번호
itemKey String 18 Y 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
tradeDate String 8 Y 거래일자(형식 : yyyyMMdd)
confirmNum String 9 Y 현금영수증 국세청 신고를 위해 팝빌이 생성한 고유번호
ntssendDT String 14 N 국세청 전송일시
형식 : yyyyMMddHHmmss
ntsresultDT String 14 N 국세청 처리결과 수신일시 (형식 : yyyyMMddHHmmss)
ntsresultCode String 4 N 결과코드
[참고] 국세청 결과코드
stateCode Number 3 Y 상태코드
[참고] 팝빌 상태코드
stateDT String 14 Y 상태 변경일시
형식 : yyyyMMddHHmmss
issueDT String 14 Y 발행일시
형식 : yyyyMMddHHmmss
mgtKey String 24 N 프로그램 공급사가 할당한 문서번호
eventDT String 14 Y 이벤트 실행일시 (형식 : yyyyMMddHHmmss)
eventType String 30 Y 이벤트 유형 : Issue / NTS 중 반환
interOPYN Boolean - Y 연동문서 여부 : true / false 중 반환
└ true : API로 발행한 연동문서
└ false : 팝빌 사이트에서 발행한 일반문서

이벤트 예시

  • 발행

    가맹점이 현금영수증을 작성하여 발행을 완료한 시점에 실행됩니다.

    {
      "corpNum": "1234567890",
      "franchiseCorpNum": "1234567890",
      "itemKey": "022122116193800001",
      "tradeDate": "20221221",
      "confirmNum": "TB0001147",
      "stateCode": 300,
      "stateDT": "20221221161938",
      "issueDT": "20221221161938",
      "mgtKey": "2021121-002",
      "eventDT": "20221221161938",
      "eventType": "Issue",
      "interOPYN": true
    }
  • 국세청 전송상태

    현금영수증의 국세청 전송완료(stateCode : 304), 전송실패(stateCode : 305) 시점에 실행됩니다.

    {
      "corpNum": "1234567890",
      "franchiseCorpNum": "1234567890",
      "itemKey": "022122116191200001",
      "tradeDate": "20221221",
      "confirmNum": "TB0001146",
      "ntssendDT": "20221222000000",
      "ntsresultDT": "20221222100033",
      "ntsresultCode": "0000",
      "stateCode": 304,
      "stateDT": "20221221161912",
      "issueDT": "20221221161912",
      "mgtKey": "20221221-001",
      "eventDT": "20221222100033",
      "eventType": "NTS",
      "interOPYN": true
    }