본문으로 건너뛰기

빌키삭제 API 연동하기

1. 빌키삭제 API Flow​

2. 설명 (Description)​

  • 빌키삭제 API는 발급된 BID(빌키)를 더 이상 사용하지 않도록 삭제 요청하는 API입니다.
  • 삭제된 빌키는 카드빌링 API 승인 요청에 사용할 수 없습니다.
  • 빌키 삭제 요청 및 응답 시 모든 값은 server-side에서 처리해야 하며 민감 정보가 외부에 노출되지 않도록 주의해야 합니다.

3. 요청 (Request)​

3.1. HTTP Request​

  • Method: POST
  • URL: https://webapi.nicepay.co.kr/webapi/billing/billkey_remove.jsp
  • Content-Type: application/x-www-form-urlencoded
  • Encoding: EUC-KR

3.2. 요청 파라미터​

필드명크기(byte)필수설명
BID30O삭제 요청할 빌키
MID10O가맹점 아이디
EdiDate14O전문생성일시 (YYYYMMDDHHMISS)
Moid64O가맹점 주문번호 (고유한 값으로 설정, 나이스페이 가공 없음)
SignData256O위변조 검증 데이터, 생성 규칙: hex(sha256(MID + EdiDate + Moid + BID + MerchantKey))
CharSet10인증 응답 인코딩 (euc-kr(default) / utf-8)
EdiType10응답전문 유형 (JSON(default) / KV) *KV:Key=value

4. 응답 (Response)​

4.1. 응답 파라미터​

PG사의 기능 추가 및 서비스 개선에 따라 응답 필드는 사전 고지 없이 추가될 수 있습니다.
가맹점에서는 아래 표에 기재되지 않은 응답 필드가 추가될 수 있음을 고려하여 연동해야 하며, 추가 필드로 인해 파싱 오류 또는 결과 처리 오류가 발생하지 않도록 구현해야 합니다.

필드명크기(byte)설명
ResultCode4결과코드 (F101: 성공, 이외 실패)
ResultMsg100결과 메세지
BID30삭제 요청한 빌키

5. 예시​

아래 예시는 테스트 시 이해를 돕기 위해 임의로 만든 데이터로 요청 및 응답 규격을 확인하기 위한 용도입니다.
예시 데이터를 실제 API 요청에 사용하지 않도록 주의해주세요.

5.1. 요청 예시​

POST /webapi/billing/billkey_remove.jsp HTTP/1.1
Host: webapi.nicepay.co.kr
Content-Type: application/x-www-form-urlencoded

BID=BIKYnictest04m2608131710079669&MID=nictest04m&Moid=nicetest1254&EdiDate=20260813111236&CharSet=euc-kr&SignData=66f3ac1947925907eaee0e8d441849d527187e83f38fab1c653a087c99c3fc0d

5.2. 응답 예시​

{
  "ResultCode": "F101",
  "ResultMsg": "빌링 정보가 정상적으로 삭제되었습니다.",
  "TID": "nictest04m01162608131812379426",
  "BID": "BIKYnictest04m2608131710079669",
  "AuthDate": "20260813"
}