Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

청구서

청구서를 발송하고 관리하는 API를 안내합니다.

청구서 발송

post

결제 금액을 결제 고객에게 청구하기 위하여 청구서를 생성하고 결제 고객에게 알림톡으로 청구서를 전송합니다.

Body
apikeystring · max: 32Required

파트너 연동을 위한 고유키

Example: partner-api-key
merchantstring · max: 30Required

파트너 매장 코드

Example: partner-merchant-1
memberstring · max: 30Required

파트너 사용자 코드

Example: partner-user-1
Responses
200

성공

application/json
codestringOptional

응답 코드

Example: 0000
msgstringOptional

응답 메세지

Example: 성공하였습니다.
apikeystring · max: 32Optional

파트너 연동을 위한 고유키

Example: partner-api-key
memberstring · max: 30Optional

파트너 매장 코드

Example: partner-merchant-1
merchantstring · max: 30Optional

파트너 사용자 코드

Example: partner-user-1
bill_idstring · max: 20Optional

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
hashstringOptional

통신 암호 키
{phone} 값이 설정된 경우 {bill_id} + "," + {phone} + "," + {price} 값으로 Hash 생성
{phone} 값이 설정되어 있지 않은 경우 {bill_id} + "," + {price} 값으로 Hash 생성

Example: a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6
post/if/bill/send
POST /if/bill/send HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "apikey": "partner-api-key",
  "merchant": "partner-merchant-1",
  "member": "partner-user-1",
  "bill": {
    "bill_id": "사업자번호-100000001",
    "bill_issuer": "결제선생학원 커스텀지점",
    "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6",
    "product_nm": "청구 사유",
    "message": "안내메세지",
    "member_nm": "고객명",
    "phone": "01000001234",
    "price": "10000",
    "expire_dt": "2026-01-01",
    "callbackURL": "https://partner.url.com/callback"
  }
}
200

성공

{
  "code": "0000",
  "msg": "성공하였습니다.",
  "apikey": "partner-api-key",
  "member": "partner-merchant-1",
  "merchant": "partner-user-1",
  "bill_id": "사업자번호-100000001",
  "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6"
}

청구서 재발송

post

기발송된 청구서를 재발송합니다. 청구 내용은 동일하며 알림톡이 새로 발송되므로 쌤포인트는 차감됩니다.

Body
apikeystring · max: 32Required

파트너 연동을 위한 고유키

Example: partner-api-key
merchantstring · max: 30Required

파트너 매장 코드

Example: partner-merchant-1
memberstring · max: 30Required

파트너 사용자 코드

Example: partner-user-1
bill_idstringRequired

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
Responses
200

성공

application/json
codestringOptional

응답 코드

Example: 0000
msgstringOptional

응답 메세지

Example: 성공하였습니다.
post/if/bill/resend
POST /if/bill/resend HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "apikey": "partner-api-key",
  "merchant": "partner-merchant-1",
  "member": "partner-user-1",
  "bill_id": "사업자번호-100000001"
}
200

성공

{
  "code": "0000",
  "msg": "성공하였습니다."
}

결제 상태 조회

post

발송된 청구서에 대한 결제 상태를 조회합니다.

Body
apikeystring · max: 32Required

파트너 연동을 위한 고유키

Example: partner-api-key
merchantstring · max: 30Required

파트너 매장 코드

Example: partner-merchant-1
memberstring · max: 30Required

파트너 사용자 코드

Example: partner-user-1
bill_idstringRequired

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
Responses
200

성공

application/json
apikeystring · max: 32Optional

파트너 연동을 위한 고유키

Example: partner-api-key
bill_idstring · max: 20Optional

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
appr_cat_idstringOptional

단말기번호

Example: A123456789
appr_pay_typestringOptional

결제수단코드

Example: CARD_VAN
appr_card_typestringOptional

결제 카드 종류 (신용, 체크, ...)

Example: CARD
appr_dtstringOptional

승인일시

Example: 20250105134753
appr_origin_dtstringOptional

원거래 승인일시

Example: 20250105134753
appr_pricestringOptional

승인금액

Example: 10000
appr_issuerstringOptional

결제은행 / 카드명

Example: ISSUER
appr_issuer_cdstringOptional

발행카드코드/은행코드

Example: 04
appr_issuer_numstringOptional

결제카드 / 계좌번호

Example: 123456**********
appr_acquirer_cdstringOptional

매입사코드

Example: 04
appr_acquirer_nmstringOptional

매입사명

Example: ACQUIRER
appr_numstringOptional

응답코드

Example: 8756372
appr_origin_numstringOptional

원거래승인번호

Example: 12345678
appr_res_cdstringOptional

응답코드

Example: 0000
appr_monthlystringOptional

결제시 할부개월수

Example: 00
appr_statestringOptional

결제 상태
F:결제완료, W:미결제, C:취소, D:파기

Example: F
appr_cash_numstringOptional

현금영수증 발급 승인번호

Example: 0000
appr_cash_traderstringOptional

현금영수증 발급 구분
개인:0, 사업자:1

Example: 0
appr_cash_issuance_numberstringOptional

현금영수증 발급 요청 번호
-현금영수증 발급 시 사용

-자진발급시 "0100001234"

Example: 0100001234
post/if/bill/read
POST /if/bill/read HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "apikey": "partner-api-key",
  "merchant": "partner-merchant-1",
  "member": "partner-user-1",
  "bill_id": "사업자번호-100000001"
}
200

성공

{
  "apikey": "partner-api-key",
  "bill_id": "사업자번호-100000001",
  "appr_cat_id": "A123456789",
  "appr_pay_type": "CARD_VAN",
  "appr_card_type": "CARD",
  "appr_dt": "20250105134753",
  "appr_origin_dt": "20250105134753",
  "appr_price": "10000",
  "appr_issuer": "ISSUER",
  "appr_issuer_cd": "04",
  "appr_issuer_num": "123456**********",
  "appr_acquirer_cd": "04",
  "appr_acquirer_nm": "ACQUIRER",
  "appr_num": "8756372",
  "appr_origin_num": "12345678",
  "appr_res_cd": "0000",
  "appr_monthly": "00",
  "appr_state": "F",
  "appr_cash_num": "0000",
  "appr_cash_trader": "0",
  "appr_cash_issuance_number": "0100001234"
}

청구서 파기

post

결제를 진행할 수 없도록 발송된 청구서를 파기합니다. 결제가 승인되기 전에만 파기가 가능하며, 결제가 승인된 후에는 파기할 수 없습니다.

Body
apikeystring · max: 32Required

파트너 연동을 위한 고유키

Example: partner-api-key
merchantstring · max: 30Required

파트너 매장 코드

Example: partner-merchant-1
memberstring · max: 30Required

파트너 사용자 코드

Example: partner-user-1
bill_idstringRequired

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
hashstringRequired

통신 암호 키
{phone} 값이 설정된 경우 {bill_id} + "," + {phone} + "," + {price} 값으로 Hash 생성
{phone} 값이 설정되어 있지 않은 경우 {bill_id} + "," + {price} 값으로 Hash 생성

Example: a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6
pricestringRequired

결제 금액

Example: 10000
Responses
200

성공

application/json
codestringOptional

응답 코드

Example: 0000
msgstringOptional

응답 메세지

Example: 성공하였습니다.
apikeystring · max: 32Optional

파트너 연동을 위한 고유키

Example: partner-api-key
memberstring · max: 30Optional

파트너 매장 코드

Example: partner-merchant-1
merchantstring · max: 30Optional

파트너 사용자 코드

Example: partner-user-1
bill_idstring · max: 20Optional

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
hashstringOptional

통신 암호 키
{phone} 값이 설정된 경우 {bill_id} + "," + {phone} + "," + {price} 값으로 Hash 생성
{phone} 값이 설정되어 있지 않은 경우 {bill_id} + "," + {price} 값으로 Hash 생성

Example: a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6
post/if/bill/destroy
POST /if/bill/destroy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "apikey": "partner-api-key",
  "merchant": "partner-merchant-1",
  "member": "partner-user-1",
  "bill_id": "사업자번호-100000001",
  "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6",
  "price": "10000"
}
200

성공

{
  "code": "0000",
  "msg": "성공하였습니다.",
  "apikey": "partner-api-key",
  "member": "partner-merchant-1",
  "merchant": "partner-user-1",
  "bill_id": "사업자번호-100000001",
  "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6"
}

결제 취소

post

결제가 완료된 청구서의 결제 상태를 승인 -> 승인취소 처리 합니다.

Body
apikeystring · max: 32Required

파트너 연동을 위한 고유키

Example: partner-api-key
merchantstring · max: 30Required

파트너 매장 코드

Example: partner-merchant-1
memberstring · max: 30Required

파트너 사용자 코드

Example: partner-user-1
bill_idstringRequired

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
hashstringRequired

통신 암호 키
{phone} 값이 설정된 경우 {bill_id} + "," + {phone} + "," + {price} 값으로 Hash 생성
{phone} 값이 설정되어 있지 않은 경우 {bill_id} + "," + {price} 값으로 Hash 생성

Example: a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6
pricestringRequired

결제 금액

Example: 10000
Responses
200

성공

application/json
codestringOptional

응답 코드

Example: 0000
msgstringOptional

응답 메세지

Example: 성공하였습니다.
apikeystring · max: 32Optional

파트너 연동을 위한 고유키

Example: partner-api-key
memberstring · max: 30Optional

파트너 매장 코드

Example: partner-merchant-1
merchantstring · max: 30Optional

파트너 사용자 코드

Example: partner-user-1
bill_idstring · max: 20Optional

청구서 ID
문자/숫자 20자리 (중복불가)
-개발: 사업자번호 + 10자리 자유롭게 사용
-운영: 20자리 자유롭게 사용

Example: 사업자번호-100000001
hashstringOptional

통신 암호 키
{phone} 값이 설정된 경우 {bill_id} + "," + {phone} + "," + {price} 값으로 Hash 생성
{phone} 값이 설정되어 있지 않은 경우 {bill_id} + "," + {price} 값으로 Hash 생성

Example: a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6
appr_numstringOptional

취소 승인 번호

Example: 22222222
appr_origin_numstringOptional

원거래 승인 번호

Example: 11111111
appr_cancel_dtstringOptional

취소 일시

Example: 20250105140322
post/if/bill/cancel
POST /if/bill/cancel HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "apikey": "partner-api-key",
  "merchant": "partner-merchant-1",
  "member": "partner-user-1",
  "bill_id": "사업자번호-100000001",
  "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6",
  "price": "10000"
}
200

성공

{
  "code": "0000",
  "msg": "성공하였습니다.",
  "apikey": "partner-api-key",
  "member": "partner-merchant-1",
  "merchant": "partner-user-1",
  "bill_id": "사업자번호-100000001",
  "hash": "a0213f3f9e45e8540e91a1339e0c5deee2dd27c4cb6b039436538c316bb45fa6",
  "appr_num": "22222222",
  "appr_origin_num": "11111111",
  "appr_cancel_dt": "20250105140322"
}
이전에러 코드 v2다음현금영수증

마지막 업데이트

도움이 되었나요?