Skip to main content
POST
/
api
/
v1
/
invoices
청구서 생성
curl --request POST \
  --url https://api.steppay.kr/api/v1/invoices \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "customerId": 1,
  "items": [
    {
      "productCode": "<string>",
      "priceCode": "<string>",
      "minimumQuantity": 123,
      "maximumQuantity": 123,
      "productName": "<string>",
      "price": 123
    }
  ],
  "publishType": "NOW",
  "publishMethods": [
    "KAKAO"
  ],
  "invoicePayMethods": [
    "CARD"
  ],
  "discount": 0,
  "paymentGateway": "NAVER",
  "purchaseDeadline": "2023-11-07T05:31:56Z",
  "reservationAt": "2023-11-07T05:31:56Z",
  "instantAmount": 1,
  "memoToCustomer": "<string>",
  "region": "AD",
  "currency": "<string>"
}
'
{
  "id": 123
}

Authorizations

Secret-Token
string
header
required

Query Parameters

temporary
boolean
default:true

임시 저장 여부. 임시 저장은 청구서가 발송되지 않습니다.

Body

application/json

청구서 생성 데이터

customerId
integer<int64>
required

청구서를 받을 고객 번호

Required range: x >= 0
items
청구서 상품 및 가격플랜 정보 · object[]
required

청구 상품 및 가격플랜 목록

publishType
enum<string>
default:NOW
required

청구서 발행 타입

Available options:
NOW,
RESERVATION
publishMethods
enum<string>[]
required

사용할 발송 수단 목록

사용할 발송 수단 목록

Available options:
KAKAO,
SMS,
EMAIL
invoicePayMethods
enum<string>[]
required

지정 결제 수단

지정 결제 수단

Available options:
CARD,
VBANK,
BANK,
BANK_TRANSFER,
CELLPHONE,
SIMPLE_PAY,
CMS,
CARD_BILL,
CELLPHONE_BILL,
CMS_BILL,
PAYPAL
discount
number
default:0
required

할인 금액

Required range: x > 0
paymentGateway
enum<string>
required

결제 화면에서 결제 할 수 있는 PG사를 고정합니다.

Available options:
NAVER,
DANAL,
KAKAO,
KG,
KCP,
NICE,
JT,
GOOGLE,
BANKPAY,
BLUEWALNUT,
KSNET,
TOSS,
EXIMBAY,
SETTLE,
DAOUDATA,
WELCOME,
NICE_V2,
STRIPE,
PAYPLE,
PAYPLE_GLOBAL,
KICC,
EMPTY,
STEPPAY,
UNKNOWN
purchaseDeadline
string<date-time>

결제 링크 유효 기간을 나타냅니다. ISO 8601 형식

reservationAt
string<date-time>

발송 시간을 나타냅니다. ISO 8601 형식

instantAmount
number

청구서 즉시 결제

Required range: x > 0
memoToCustomer
string

청구서 메모

region
enum<string>

청구서 판매 Region

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
US_ALABAMA,
US_ALASKA,
US_ARIZONA,
US_ARKANSAS,
US_CALIFORNIA,
US_COLORADO,
US_CONNECTICUT,
US_DELAWARE,
US_FLORIDA,
US_GEORGIA,
US_HAWAII,
US_IDAHO,
US_ILLINOIS,
US_INDIANA,
US_IOWA,
US_KANSAS,
US_KENTUCKY,
US_LOUISIANA,
US_MAINE,
US_MARYLAND,
US_MASSACHUSETTS,
US_MICHIGAN,
US_MINNESOTA,
US_MISSISSIPPI,
US_MISSOURI,
US_MONTANA,
US_NEBRASKA,
US_NEVADA,
US_NEW_HAMPSHIRE,
US_NEW_JERSEY,
US_NEW_MEXICO,
US_NEW_YORK,
US_NORTH_CAROLINA,
US_NORTH_DAKOTA,
US_OHIO,
US_OKLAHOMA,
US_OREGON,
US_PENNSYLVANIA,
US_RHODE_ISLAND,
US_SOUTH_CAROLINA,
US_SOUTH_DAKOTA,
US_TENNESSEE,
US_TEXAS,
US_UTAH,
US_VERMONT,
US_VIRGINIA,
US_WASHINGTON,
US_WEST_VIRGINIA,
US_WISCONSIN,
US_WYOMING,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
currency
string

청구서 승인 통화

Response

정상적으로 생성됨

id
integer<int64>
required

청구서 번호