POPBill Developers
API Reference
NTS Crawling
API Reference NTS Crawling Webhook Event

Webhook Event

Webhook Header

Field Mandatory Description Example
Pb-Webhook-Type Y Webhook type HT.CASHBILL
Pb-Webhook-MID Y Identification value for Event 016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum Y POPBiLL business registration number 6798700433
Content-Type Y Body type for Webhook message application/json
Authorization N Based 64-encoded BASIC authentication information Basic VEVTVDoxMjM=
└ additional item if using HTTP authentication
X-Api-Key N API Key authentication information TESTAPIKEY
└ additional item if using HTTP authentication

Depending on the partner’s operational environment, POPBiLL additionally provides custom field other than the default Header field. If you need to request one, please contact the partner center.

Data Crawl

This Event will be initiated when POPBiLL automatically sends the crawled data to the registered CallBack URL at every 1 hour(at the exact hour).
Each event time can be checked [Data Crawling].

Event Type Description
HTCashbill POPBiLL collects updated data and automatically delivers it to the registered callback URL every day at 9 AM KST.

Sales/Purchase Cash Receipt Crawling Job

It is executed at the time when POPBiLL collects updated data and automatically delivers it to the registered callback URL every day at 9 AM KST.

Event body
No. Field Type Length Mandatory Description
ntsconfirmNum string 9 Y NTS confirmation number
tradeDate string 8 Y Date of trade
format : yyyyMMdd
tradeDT string 14 Y Date and time of trade
format : yyyyMMddHHmmss
tradeType string 4 Y Type of cash receipt
승인거래general cash receipt
취소거래cash receipt for revocation
tradeUsage string 5 Y Purpose of issuance
소득공제용income deduction usage
지출증빙용proof of purchase usage
totalAmount string 9 Y Total amount
supplyCost string 9 Y Supply value
tax string 9 Y Tax amount
serviceFee string 9 Y Service fee
invoiceType string 2 Y Types of cash receipt
매입purchase
매출sales
franchiseCorpNum string 10 N [Seller] business registration number
franchiseCorpName string 200 N [Seller] company name
Returns this if 'invoiceType' is 매입(purchase)
franchiseCorpType string 1 N [Seller] taxpayer type of business
1general taxpayer
2simplified taxpayer
5corporate taxpayer
Returns this if 'invoiceType' is 매입(purchase)
identityNum string 4 N [Buyer] identification number
returns only the last 4 digits of the original identification number
identityNumType string 1 Y [Buyer] type of identification number
1 resident registration number
2 business registration number
3 cell phone number
4 card number
customerName string 70 N [Buyer] name of the customer
cardOwnerName string 70 N [Buyer] name of the card owner
deductionType string 1 N Deduction type
12 deductible
34 non-deductible
Example of Event
{
  "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
}