API Reference 현금영수증 Node.js 포인트 관리
5.1. GetUnitCost - 발행 단가 확인
- 현금영수증 발행시 과금되는 포인트 단가를 확인합니다.
cashbillService.getUnitCost(CorpNum, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 현금영수증 발행단가
Throws
PopbillException
5.2. GetChargeInfo - 과금정보 확인
- 팝빌 현금영수증 API 서비스 과금정보를 확인합니다.
cashbillService.getChargeInfo(CorpNum, UserID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
ChargeInfo
Throws
PopbillException
5.3. GetBalance - 연동회원 잔여포인트 확인
cashbillService.getBalance(CorpNum, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 연동회원 잔여포인트
Throws
PopbillException
5.4. GetChargeURL - 연동회원 포인트 충전 팝업 URL
- 연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
cashbillService.getChargeURL(CorpNum, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL
Throws
PopbillException
5.5. PaymentRequest - 연동회원 무통장 입금신청
- 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
cashbillService.getBalance(CorpNum, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
PaymentForm |
PaymentForm |
- |
Y |
입금신청 객체정보 |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
PaymentResponse
Throws
PopbillException
5.6. GetSettleResult - 연동회원 무통장 입금신청 정보확인
- 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
cashbillService.getSettleResult(CorpNum, SettleCode, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
SettleCode |
string |
18 |
Y |
정산코드
└ 팝빌에서 임의 부여하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
|
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
PaymentHistory
Throws
PopbillException
5.7. GetPaymentHistory - 연동회원 포인트 결제내역 확인
cashbillService.GetPaymentHistory(CorpNum, SDate, EDate, Page, PerPage, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
SDate |
string |
8 |
Y |
조회 기간의 시작일자 (형식 : yyyyMMdd) |
|
EDate |
string |
8 |
Y |
조회 기간의 종료일자 (형식 : yyyyMMdd) |
|
Page |
number |
- |
N |
목록 페이지번호 (기본값 1) |
|
PerPage |
number |
- |
N |
페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
PaymentHistoryResult
Throws
PopbillException
5.8. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL
- 연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
cashbillService.getPaymentURL(CorpNum, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL
Throws
PopbillException
5.9. GetUseHistory - 연동회원 포인트 사용내역 확인
cashbillService.getUseHistory(CorpNum, SDate, EDate, Page, PerPage, Order, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
SDate |
string |
8 |
Y |
조회 기간의 시작일자 (형식 : yyyyMMdd) |
|
EDate |
string |
8 |
Y |
조회 기간의 종료일자 (형식 : yyyyMMdd) |
|
Page |
number |
- |
N |
목록 페이지번호 (기본값 1) |
|
PerPage |
number |
- |
N |
페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) |
|
Order |
string |
1 |
N |
거래일자를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ "D" : 내림차순
└ "A" : 오름차순
※ 미입력시 기본값 "D" 처리
|
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
UseHistoryResult
Throws
PopbillException
5.10. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL
- 연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
cashbillService.getUseHistoryURL(CorpNum, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL
Throws
PopbillException
5.11. Refund - 연동회원 포인트 환불신청
cashbillService.refund(CorpNum, RefundForm, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
RefundForm |
RefundForm |
- |
Y |
환불신청 객체정보 |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
RefundResponse
Throws
PopbillException
5.12. GetRefundHistory - 연동회원 포인트 환불내역 확인
cashbillService.getRefundHistory(CorpNum, Page, PerPage, UserID, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
Page |
number |
- |
N |
목록 페이지번호 (기본값 1) |
|
PerPage |
number |
- |
N |
페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
RefundHistoryResult
Throws
PopbillException
5.13. GetPartnerBalance - 파트너 잔여포인트 확인
cashbillService.getPartnerBalance(CorpNum, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 파트너 잔여포인트
Throws
PopbillException
5.14. GetPartnerURL - 파트너 포인트충전 팝업 URL
- 파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
cashbillService.getPartnerURL(CorpNum, TOGO, callback, err)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
TOGO |
string |
4 |
Y |
"CHRG" 입력 |
|
callback |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
err |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL
Throws
PopbillException
5.15. GetRefundInfo - 환불 신청 상태 조회
- 포인트 환불에 대한 상세정보 1건을 확인합니다.
cashbillService.getRefundInfo(CorpNum, RefundCode, UserID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
RefundCode |
String |
18 |
Y |
환불코드 |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
|
success |
function |
- |
N |
성공에 대한 콜백 함수 |
|
error |
function |
- |
N |
실패에 대한 콜백 함수 |
Return
RefundHistory
Throws
PopbillException
5.16. GetRefundableBalance - 환불 가능 포인트 조회
- 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
cashbillService.getRefundableBalance(CorpNum, UserID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
string - 환불 가능 포인트
Throws
PopbillException
