V0.1

시작하기

SecretKey 발급 및 확인

시크릿 키는 http request 요청 시 필요한 값입니다.
(* 시크릿 키를 웹 프론트에서 사용하게 되면 노출 위험이 있으니, 백엔드에서 연동하시길 권장드립니다.)
시크릿 키는 아래 링크에서 확인할 수 있습니다.
https://app.steppay.kr/system/key

시크릿 키를 발급받으신 후 Header에 아래와 같이 시크릿 키를 넘겨줍니다.

1Content-Type: application/json
2secret-token: {Secret-Token}

상품 관리하기

상품 관리 API를 이용하여, 판매할 상품의 정보를 등록할 수 있고, 재고관리를 할 수 있습니다.
상품은 전체 상품을 리스트로 조회할 수도 있으며, 특정 상품만을 조회하여 디테일 페이지에 정보를 나타낼 수 있습니다.
상품 생성시 여러 옵션들을 함께 설정할 수 있습니다.

목차 보기

전체 상품 조회

가맹점 내의 등록되어 있는 모든 상품들을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/products

전체 상품 조회 응답 예시

전체 상품 조회 응답 파라메터

파라메터타입설명부가 설명
codestring상품마다 해당되는 고유 상품 코드를 표시합니다.

combinedProductsarray번들 상품일 경우 번들에 포함된 각 상품들의 정보들을 표시합니다.
object array
하단 combinedProducts 코드 참고
createdAtdate상품이 생성된 날짜를 표시합니다.

demoPeriodnumber무료 체험 기간을 표시합니다.

demoPeriodUnitenum무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring상품의 설명을 표시합니다.

enabledDemoboolean무료 체험 기간이 있는지 여부를 표시합니다.

featuredImageUrlstring상품의 대표 이미지를 표시합니다.
(자세한 설명은 이미지 업로드 API를 참고해주세요.)

idnumber상품의 아이디를 표시합니다.

modifiedAtdate상품의 수정 날짜를 표시합니다.

namestring상품의 이름을 표시합니다.

optionsobject상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject상품의 가격 정보를 표시합니다.
object array
하단 prices 코드 참고
quantitynumber상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 설정됩니다.
statusenum상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

전체 상품 조회 응답 파라메터 상세

combinedProducts

# 특정 상품 조회 응답 파라메터를 참고해주세요!
combinedProducts 파라메터를 제외한 나머지 파라메터가 포함됩니다.

options

옵션의 정보를 표시합니다.

1[
2    {
3      "id": 0,
4      "name": "string",
5      "subOptions": [
6        {
7          "id": 0,
8          "name": "string",
9          "quantity": 0
10        }
11      ]
12    }
13]
파라메터타입설명부가 설명
idnumber옵션의 아이디입니다.

namestring옵션의 이름입니다.

subOptionsobject옵션의 밑에 하위옵션을 표시할 수 있습니다.
ex) 색상 - 빨강, 검정, 노랑
subOptions.idnumber서브 옵션의 아이디입니다.

subOptions.namestring서브 옵션의 이름입니다.

subOptions.quantitynumber서브 옵션의 갯수를 표시할 수 있습니다.

prices

# 가격 플랜 관리를 참고해주세요!

특정 상품 조회

가맹점 내의 등록되어 있는 상품 중 특정 상품을 조회할 수 있습니다.

GET
1https://api.steppay.kr/api/products/${id}

특정 상품 조회 응답 예시

특정 상품 조회 응답 파라메터

파라메터타입설명부가 설명
codestring상품마다 해당되는 고유 상품 코드를 표시합니다.

combinedProductsarray번들 상품일 경우 번들에 포함된 각 상품들의 정보들을 표시합니다.
object array
하단 combinedProducts 코드 참고
createdAtdate상품 생성 날짜를 표시합니다.

demoPeriodnumber무료 체험 기간을 표시합니다.

demoPeriodUnitenum무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring상품의 설명을 표시합니다.

enabledDemoboolean무료 체험 기간이 있는지 여부를 표시합니다.

featuredImageUrlstring상품의 대표 이미지를 표시합니다.
(자세한 설명은 이미지 업로드 API를 참고해주세요.)

idnumber상품의 아이디를 표시합니다.

modifiedAtdate상품의 수정 날짜를 표시합니다.

namestring상품의 이름을 표시합니다.

optionsobject상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject상품의 가격 정보를 표시합니다.
object array
하단 prices 코드 참고
quantitynumber상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 표시됩니다.
statusenum상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

특정 상품 조회 응답 파라메터 상세

combinedProducts

# 특정 상품 조회 응답 파라메터를 참고해주세요!
combinedProducts 파라메터를 제외한 나머지 파라메터가 포함됩니다.

options

# 전체 상품 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜 관리를 참고해주세요!

상품 생성

다양한 옵션을 선택하여 상품을 생성할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/products

상품 생성 요청 예시

상품 생성 요청 파라메터

파라메터타입필수 여부설명부가 설명
combinedProductsarray선택결합 상품인 경우 해당 상품들의 아이디를 배열로 넘겨줍니다.
상품 타입이 BUNDLE일 경우 해당 파라메터를 추가합니다.
demoPeriodnumber선택무료 체험 기간을 입력합니다.
enabledDemo 값이 true일 경우에 설정합니다.
demoPeriodUnitenum선택무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring선택상품의 설명입니다.

enabledDemoboolean필수무료 체험에 해당하는 상품 생성 여부를 결정합니다.

featuredImageUrlstring선택상품 이미지를 URL 형식으로 표시합니다.

namestring필수상품의 이름입니다.

optionsobject선택상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject선택상품의 가격 플랜입니다.
object array
하단 참고
quantitynumber선택상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 설정됩니다.
statusenum필수상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum필수상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

상품 생성 요청 파라메터 상세

options

옵션의 정보를 표시합니다.

1[
2    {
3      "name": "string",
4      "subOptions": [
5        {
6          "name": "string",
7          "quantity": 0
8        }
9      ]
10    }
11],
파라메터타입필수 여부설명부가 설명
namestring선택옵션의 이름입니다.

subOptionsobject선택옵션의 밑에 하위옵션을 설정할 수 있습니다..
ex) 색상 - 빨강, 검정, 노랑
subOptions.namestring필수서브 옵션의 이름입니다.

subOptions.quantitynumber필수서브 옵션의 갯수를 설정할 수 있습니다.

상품 생성 응답 예시

상품 생성 응답 파라메터

파라메터타입설명부가 설명
codestring상품마다 해당되는 고유 상품 코드를 표시합니다.

combinedProductsarray번들 상품일 경우 번들에 포함된 각 상품들의 정보들을 표시합니다.
object array
하단 combinedProducts 코드 참고
createdAtdate상품 생성 날짜를 표시합니다.

demoPeriodnumber무료 체험 기간을 표시합니다.

demoPeriodUnitenum무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring상품의 설명을 표시합니다.

enabledDemoboolean무료 체험 기간이 있는지 여부를 표시합니다.

featuredImageUrlstring상품의 대표 이미지를 표시합니다.
(자세한 설명은 이미지 업로드 API를 참고해주세요.)

idnumber상품의 아이디를 표시합니다.

modifiedAtdate상품의 수정 날짜를 표시합니다.

namestring상품의 이름을 표시합니다.

optionsobject상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject상품의 가격 정보를 표시합니다.
object array
하단 prices 코드 참고
quantitynumber상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 표시됩니다.
statusenum상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

상품 생성 응답 파라메터 상세

combinedProducts

# 특정 상품 조회 응답 파라메터를 참고해주세요!
combinedProducts 파라메터를 제외한 나머지 파라메터가 포함됩니다.

options

# 전체 상품 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜을 참고해주세요!

상품 수정

등록되어있는 상품을 수정하여 다시 등록할 수 있습니다.

URL

PUT
1https://api.steppay.kr/api/products/${id}

상품 수정 요청 예시

상품 생성 파라메터와 유사하나 수정하려는 대상의 id값이 추가됩니다.

상품 수정 요청 파라메터

파라메터타입필수 여부설명부가 설명
combinedProductsarray선택결합 상품인 경우 해당 상품들의 아이디를 배열로 넘겨줍니다.
상품 타입이 BUNDLE일 경우 해당 파라메터를 추가합니다.
demoPeriodnumber선택무료 체험 기간을 입력합니다.
enabledDemo 값이 true일 경우에 설정합니다.
demoPeriodUnitenum선택무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring선택상품의 설명입니다.

enabledDemoboolean필수무료 체험에 해당하는 상품 생성 여부를 결정합니다.

featuredImageUrlstring선택상품 이미지를 URL 형식으로 표시합니다.

namestring필수상품의 이름입니다.

optionsobject선택상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject선택상품의 가격 플랜입니다.
object array
하단 참고
quantitynumber선택상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 설정됩니다.
statusenum필수상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum필수상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

상품 수정 요청 파라메터 상세

options

# 전체 상품 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜을 참고해주세요!

상품 수정 응답 예시

상품 수정 응답 파라메터

파라메터타입설명부가 설명
codestring상품마다 해당되는 고유 상품 코드를 표시합니다.

combinedProductsarray번들 상품일 경우 번들에 포함된 각 상품들의 정보들을 표시합니다.
object array
하단 combinedProducts 코드 참고
createdAtdate상품 생성 날짜를 표시합니다.

demoPeriodnumber무료 체험 기간을 표시합니다.

demoPeriodUnitenum무료 체험 기간의 단위를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

descriptionstring상품의 설명을 표시합니다.

enabledDemoboolean무료 체험 기간이 있는지 여부를 표시합니다.

featuredImageUrlstring상품의 대표 이미지를 표시합니다.
(자세한 설명은 이미지 업로드 API를 참고해주세요.)

idnumber상품의 아이디를 표시합니다.

modifiedAtdate상품의 수정 날짜를 표시합니다.

namestring상품의 이름을 표시합니다.

optionsobject상품의 옵션을 표시합니다.
하단 options 코드 참고
pricesobject상품의 가격 정보를 표시합니다.
object array
하단 prices 코드 참고
quantitynumber상품의 수량을 표시합니다.
-1로 표시할 경우 무한대로 표시됩니다.
statusenum상품의 상태를 표시합니다.
SALE: 판매 중
OUT_OF_STOCK: 품절
UNSOLD: 미게시

typeenum상품의 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE: 소프트웨어
BUNDLE: 번들 상품

상품 생성 응답 파라메터 상세

combinedProducts

# 특정 상품 조회 응답 파라메터를 참고해주세요!
combinedProducts 파라메터를 제외한 나머지 파라메터가 포함됩니다.

options

# 전체 상품 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜을 참고해주세요!

상품 삭제

등록되어있는 상품을 삭제할 수 있습니다.

URL

DELETE
1https://api.steppay.kr/api/products/${id}

상품 삭제 응답 예시

상품 삭제 응답 파라메터

파라메터타입설명부가 설명
messagestring삭제 성공 또는 실패 메세지를 표시합니다.

successboolean삭제가 성공했는지 실패했는지 표시합니다.

상품 판매 상태 변경

설명 추가 준비중입니다.

가격 플랜 관리하기

가격 플랜 API를 이용하여 상품 판매 전략을 관리할 수 있습니다.
한 상품에 대하여 여러 개의 가격 플랜을 만들 수도 있으며 상품이 구독일 경우와 단품일 경우를 구분하여 가격 플랜을 세팅할 수 있습니다.
가격 플랜 생성 시 여러 옵션들을 함께 설정할 수 있습니다.

목차 보기

가격 플랜 조회

상품에 속해있는 플랜들의 모든 가격들을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/products/${productId}/prices

가격 플랜 조회 응답 예시

가격 플랜 조회 응답 파라메터

파라메터타입설명부가 설명
additionalBillingsobject기본 제공량 또는 자동 추가 과금이 있을 경우 표시합니다.
하단 additionalBillings 코드 참고
billingDatenumber후불일 경우 결제일을 표시합니다.

claimMethodTypeenum청구 방식을 지정합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean첫 구매시 할인 여부를 표시합니다.

expirationDatedate유효기간을 표시합니다.

expirationDateUnitenum유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 표시됩니다.
maximumPurchaseQuantitynumber계정당 최대 구매 가능 갯수를 표시합니다.

membershipExpirationDatenumber멤버십 만료 기간을 표시합니다.

membershipExpirationDateTypeenum멤버십 만료 기간의 유형을 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 표시됩니다.
하단 options 코드 참고
planDescriptionstring플랜에 대한 설명을 표시합니다.

planNamestring플랜의 이름을 표시합니다.

pricenumber상품의 가격을 표시합니다.

recurringobject결제주기랑 청구 방식을 표시합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionarray도입비, 설치비에 대한 옵션을 표시합니다.
하단 setupOption 코드 참고
typeenum플랜 타입을 표시합니다.
ONE_TIME: 단건
RECURRING: 정기결제

unitenum플랜 타입을 표시합니다.
단건일 경우: ONE_TIME
정기결제일 경우 : RECURRING

volumesobject대량 구매 시 할인 정책 옵션을 표시합니다.
하단 volumes 코드 참고
whenToClaimTypeenum청구 시점을 표시합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

가격 플랜 조회 응답 파라메터 상세

additionalBillings

기본 제공량 또는 자동 추가 과금이 있을 경우 설정합니다.

1[
2  {
3    "additionalBilling": 0,
4    "basicServing": 0,
5    "id": 0,
6    "maximumServing": 0,
7    "name": "string",
8    "unit": "string"
9  }
10]
파라메터타입설명부가 설명
additionalBillingnumber기본 제공량을 초과시 과금되는 가격을 표시합니다.

basicServingnumber기본 제공량을 표시합니다.

maximumServingnumber최대 제공량을 표시합니다.

namestring옵션명을 표시합니다.

unitstring제공 단위를 표시합니다.

recurring

구독일 때의 옵션을 표시합니다. 구독일 경우 필수 인자로 사용합니다.

1{
2  "aggregateUsageType": "SUM",
3  "id": 0,
4  "interval": "DAY",
5  "intervalCount": 0,
6  "usageType": "LICENSED"
7}
파라메터타입설명부가 설명
aggregateUsageTypeenum구독일 때의 옵션을 표시합니다.
SUM: 사용량을 합산하여 계산합니다.
LAST_DURING_PERIOD: 특정 기간 내에 가장 최근 사용량으로 계산합니다.
LAST_EVER: 전체 기간내에 가장 최근 사용량으로 계산합니다.
MAX: 특정 기간 중 가장 많은 사용량으로 계산합니다.
usageType이 METERED 때 유효한 값입니다.
사용량으로 청구 요금을 책정하는 방식을 설정합니다.
idnumber아이디입니다.

intervalenum결제 주기를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년
구독일 경우 필수 인자입니다.
whenToClaimType이 DATE이고
billingDate값이 명시되어있을 때
해당 옵션은 무시됩니다.
intervalCountnumber결제 주기의 기간을 표시합니다.
구독일 경우 필수 인자입니다.
whenToClaimType이 DATE이고
billingDate값이 명시되어있을 때
해당 옵션은 무시됩니다.
usageTypeenum청구 방식을 표시합니다.
LICENSED: 고정 요금으로 청구됩니다.
METERED: 사용량에 따라 청구됩니다.
구독일 경우 필수 인자입니다.

setupOption

고객이 선택할 수 있는 과금이 되는 옵션 상품을 설정합니다.

1{
2  "id": 0,
3  "name": "string",
4  "price": 0,
5  "type": "INITIALLY"
6}
파라메터타입설명부가 설명
idnumber옵션의 아이디를 표시합니다.

namestring옵션의 이름을 표시합니다.

pricenumber옵션의 가격을 표시합니다.

typeenum청구 방식을 표시합니다.
INITIALLY: 최초 1회
PERIODIC: 결제 주기

volumes

대량 구매 시 할인 정책 옵션을 설정합니다.

1[
2  {
3    "id": 0,
4    "max": 0,
5    "min": 0,
6    "price": 0
7  }
8]
파라메터타입설명부가 설명
idnumber아이디를 표시합니다.

maxnumber대량 구매 시 최대 제공량을 표시합니다.

minnumber대량 구매 시 기본 제공량을 표시합니다.

pricenumber대량 구매 시 개당 가격을 표시합니다.

특정 가격 플랜 조회

상품에 속해있는 특정 플랜의 가격을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/products/${productId}/prices/${price_id}

특정 가격 플랜 조회 응답 예시

특정 가격 플랜 조회 응답 파라메터

파라메터타입설명부가 설명
additionalBillingsobject기본 제공량 또는 자동 추가 과금이 있을 경우 표시합니다.
하단 additionalBillings 코드 참고
billingDatenumber후불일 경우 결제일을 표시합니다.

claimMethodTypeenum청구 방식을 지정합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean첫 구매시 할인 여부를 표시합니다.

expirationDatedate유효기간을 표시합니다.

expirationDateUnitenum유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 표시됩니다.
maximumPurchaseQuantitynumber계정당 최대 구매 가능 갯수를 표시합니다.

membershipExpirationDatenumber멤버십 만료 기간을 표시합니다.

membershipExpirationDateTypeenum멤버십 만료 기간의 유형을 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 표시됩니다.
하단 options 코드 참고
planDescriptionstring플랜에 대한 설명을 표시합니다.

planNamestring플랜의 이름을 표시합니다.

pricenumber상품의 가격을 표시합니다.

recurringobject결제주기랑 청구 방식을 표시합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionarray도입비, 설치비에 대한 옵션을 표시합니다.
하단 setupOption 코드 참고
typeenum플랜 타입을 표시합니다.
ONE_TIME: 단건
RECURRING: 정기결제

unitenum플랜 타입을 표시합니다.
단건일 경우: ONE_TIME
정기결제일 경우 : RECURRING

volumesobject대량 구매 시 할인 정책 옵션을 표시합니다.
하단 volumes 코드 참고
whenToClaimTypeenum청구 시점을 표시합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

특정 가격 플랜 조회 응답 파라메터 상세

additionalBillings

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

recurring

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

setupOption

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

volumes

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

가격 플랜 생성

특정 상품에 가격 플랜을 추가할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/products/${productId}/prices

가격 플랜 생성 요청 예시

가격 플랜 생성 요청 파라메터

파라메터타입필수 여부설명부가 설명
additionalBillingsobject선택기본 제공량 또는 자동 추가 과금이 있을 경우 설정합니다.
하단 additionalBillings 코드 참고
billingDatenumber선택후불일 경우 결제일을 지정합니다.

claimMethodTypeenum선택청구 방식을 지정합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean필수첫 구매시 할인 여부를 설정합니다.

expirationDatedate선택유효기간을 표시합니다.

expirationDateUnitenum선택유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber선택첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 설정합니다.
maximumPurchaseQuantitynumber선택계졍당 최대 구매 가능 갯수를 설정합니다.

membershipExpirationDatenumber선택멤버십 만료 기간을 설정합니다.

membershipExpirationDateTypeenum선택멤버십 만료 기간의 유형을 설정합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject선택고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 설정합니다.
하단 options 코드 참고
planDescriptionstring선택플랜에 대한 설명을 설정합니다.

planNamestring선택플랜의 이름을 설정합니다.

pricenumber필수상품의 가격을 설정합니다.

recurringobject선택결제주기랑 청구 방식을 설정합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionarray선택도입비, 설치비에 대한 옵션을 설정합니다.
하단 setupOption 코드 참고
typeenum필수플랜 타입을 설정합니다.
ONE_TIME: 단건
RECURRING: 정기결제

unitenum필수플랜 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE : 소프트웨어
BUNDLE: 번들

volumesobject선택대량 구매 시 할인 정책 옵션을 설정합니다.
하단 volumes 코드 참고
whenToClaimTypeenum선택청구 시점을 설정합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

가격 플랜 생성 요청 파라메터 상세

additionalBillings

기본 제공량 또는 자동 추가 과금이 있을 경우 설정합니다.

1[
2    {
3      "additionalBilling": 0,
4      "basicServing": 0,
5      "maximumServing": 0,
6      "name": "string",
7      "unit": "string"
8    }
9]
파라메터타입필수 여부설명부가 설명
additionalBillingnumber선택기본 제공량을 초과시 과금되는 가격 입니다

basicServingnumber선택기본 제공량 입니다

maximumServingnumber선택최대 제공량 입니다

namestring선택옵션명 입니다.

unitstring선택제공 단위 입니다

recurring

구독일 때의 옵션을 표시합니다. 구독일 경우 필수 인자로 사용합니다.

1{
2    "aggregateUsageType": "SUM",
3    "interval": "DAY",
4    "intervalCount": 0,
5    "usageType": "LICENSED"
6}
파라메터타입필수 여부설명부가 설명
aggregateUsageTypeenum선택구독일 때의 옵션을 표시합니다.
SUM: 사용량을 합산하여 계산합니다.
LAST_DURING_PERIOD: 특정 기간 내에 가장 최근 사용량으로 계산합니다.
LAST_EVER: 전체 기간내에 가장 최근 사용량으로 계산합니다.
MAX: 특정 기간 중 가장 많은 사용량으로 계산합니다.
usageType이 METERED 때 유효한 값입니다.
사용량으로 청구 요금을 책정하는 방식을 설정합니다.
intervalenum선택결제 주기를 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년
구독일 경우 필수 인자입니다.
whenToClaimType이 DATE이고
billingDate값이 명시되어있을 때
해당 옵션은 무시됩니다.
intervalCountnumber선택결제 주기의 기간을 표시합니다.
구독일 경우 필수 인자입니다.
whenToClaimType이 DATE이고
billingDate값이 명시되어있을 때
해당 옵션은 무시됩니다.
usageTypeenum선택청구 방식을 표시합니다.
LICENSED: 고정 요금으로 청구됩니다.
METERED: 사용량에 따라 청구됩니다.
구독일 경우 필수 인자입니다.

setupOption

고객이 선택할 수 있는 과금이 되는 옵션 상품을 설정합니다.

1{
2    "name": "string",
3    "price": 0,
4    "type": "INITIALLY"
5}
파라메터타입필수 여부설명부가 설명
namestring필수옵션의 이름을 표시합니다.

pricenumber필수옵션의 가격을 표시합니다.

typeenum필수청구 방식을 표시합니다.
INITIALLY: 최초 1회
PERIODIC: 결제 주기

volumes

대량 구매 시 할인 정책 옵션을 설정합니다.

1[
2    {
3      "max": 0,
4      "min": 0,
5      "price": 0
6    }
7]
파라메터타입필수 여부설명부가 설명
maxnumber선택대량 구매 시 최대 제공량을 표시합니다.

minnumber필수대량 구매 시 기본 제공량을 표시합니다.

pricenumber필수대량 구매 시 개당 가격을 표시합니다.

가격 플랜 생성 응답 예시

가격 플랜 생성 응답 파라메터

파라메터타입설명부가 설명
additionalBillingsobject기본 제공량 또는 자동 추가 과금이 있을 경우 표시됩니다.
하단 additionalBillings 코드 참고
billingDatenumber후불일 경우 결제일을 표시합니다.

claimMethodTypeenum청구 방식을 표시합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean첫 구매시 할인 여부를 표시합니다.

expirationDatedate유효기간을 표시합니다.

expirationDateUnitenum유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 표시됩니다.
maximumPurchaseQuantitynumber계졍당 최대 구매 가능 갯수를 표시합니다.

membershipExpirationDatenumber멤버십 만료 기간을 표시합니다.

membershipExpirationDateTypeenum멤버십 만료 기간의 유형을 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 표시합니다.
하단 options 코드 참고
planDescriptionstring플랜에 대한 설명을 표시합니다.

planNamestring플랜의 이름을 표시합니다.

pricenumber상품의 가격을 표시합니다.

recurringobject결제주기랑 청구 방식을 표시합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionobject도입비, 설치비에 대한 옵션을 표시합니다.
하단 setupOption 코드 참고
typeenum플랜 타입을 표시합니다.
단건일 경우: ONE_TIME
정기결제일 경우 : RECURRING

unitenum플랜 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE : 소프트웨어
BUNDLE: 번들

volumesobject대량 구매 시 할인 정책 옵션을 표시합니다.
하단 volumes 코드 참고
whenToClaimTypeenum청구 시점을 표시합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

가격 플랜 생성 응답 파라메터 상세

additionalBillings

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

recurring

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

setupOption

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

volumes

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

가격 플랜 수정

특정 상품의 가격 플랜을 수정할 수 있습니다.

URL

PUT
1https://api.steppay.kr/api/products/${productId}/prices/${price_id}

가격 플랜 수정 요청 예시

가격 플랜 생성 파라메터와 유사하나 수정하려는 대상의 id값이 추가됩니다.

가격 플랜 수정 요청 파라메터

파라메터타입필수 여부설명부가 설명
additionalBillingsobject선택기본 제공량 또는 자동 추가 과금이 있을 경우 설정합니다.
하단 additionalBillings 코드 참고
billingDatenumber선택후불일 경우 결제일을 지정합니다.

claimMethodTypeenum선택청구 방식을 지정합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean필수첫 구매시 할인 여부를 설정합니다.

expirationDatedate선택유효기간을 표시합니다.

expirationDateUnitenum선택유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber선택첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 설정합니다.
maximumPurchaseQuantitynumber선택계졍당 최대 구매 가능 갯수를 설정합니다.

membershipExpirationDatenumber선택멤버십 만료 기간을 설정합니다.

membershipExpirationDateTypeenum선택멤버십 만료 기간의 유형을 설정합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject선택고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 설정합니다.
하단 options 코드 참고
planDescriptionstring선택플랜에 대한 설명을 설정합니다.

planNamestring선택플랜의 이름을 설정합니다.

pricenumber필수상품의 가격을 설정합니다.

recurringobject선택결제주기랑 청구 방식을 설정합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionarray선택도입비, 설치비에 대한 옵션을 설정합니다.
하단 setupOption 코드 참고
typeenum필수플랜 타입을 설정합니다.
ONE_TIME: 단건
RECURRING: 정기결제

unitenum필수플랜 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE : 소프트웨어
BUNDLE: 번들

volumesobject선택대량 구매 시 할인 정책 옵션을 설정합니다.
하단 volumes 코드 참고
whenToClaimTypeenum선택청구 시점을 설정합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

가격 플랜 수정 요청 파라메터 상세

additionalBillings

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

recurring

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

setupOption

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

volumes

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

가격 플랜 수정 응답 예시

가격 플랜 수정 응답 파라메터

파라메터타입설명부가 설명
additionalBillingsobject기본 제공량 또는 자동 추가 과금이 있을 경우 표시됩니다.
하단 additionalBillings 코드 참고
billingDatenumber후불일 경우 결제일을 표시합니다.

claimMethodTypeenum청구 방식을 표시합니다.
PRE: 선불
POST: 후불

enabledFirstSalePriceboolean첫 구매시 할인 여부를 표시합니다.

expirationDatedate유효기간을 표시합니다.

expirationDateUnitenum유효기간의 단위를 표시합니다
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

firstSalePricenumber첫 구매시 할인되는 가격을 설정합니다.
enabledFirstSalePrice 값이 true 일 경우에 표시됩니다.
maximumPurchaseQuantitynumber계졍당 최대 구매 가능 갯수를 표시합니다.

membershipExpirationDatenumber멤버십 만료 기간을 표시합니다.

membershipExpirationDateTypeenum멤버십 만료 기간의 유형을 표시합니다.
DAY: 일
WEEK: 주
MONTH: 달
YEAR: 년

optionsobject고객이 선택할 수 있는 과금이 되는 옵션 상품이 있을 경우 표시합니다.
하단 options 코드 참고
planDescriptionstring플랜에 대한 설명을 표시합니다.

planNamestring플랜의 이름을 표시합니다.

pricenumber상품의 가격을 표시합니다.

recurringobject결제주기랑 청구 방식을 표시합니다.
구독일 경우 필수 인자값입니다.
하단 recurring 코드 참고
setupOptionobject도입비, 설치비에 대한 옵션을 표시합니다.
하단 setupOption 코드 참고
typeenum플랜 타입을 표시합니다.
단건일 경우: ONE_TIME
정기결제일 경우 : RECURRING

unitenum플랜 유형을 표시합니다.
BOX: 실물 상품
SOFTWARE : 소프트웨어
BUNDLE: 번들

volumesobject대량 구매 시 할인 정책 옵션을 표시합니다.
하단 volumes 코드 참고
whenToClaimTypeenum청구 시점을 표시합니다.
FIRST_PAYMENT: 첫 결제일 기준 반복
DATE: 특정 결제 시점

가격 플랜 수정 응답 파라메터 상세

additionalBillings

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

recurring

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

setupOption

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

volumes

# 가격 플랜 조회 응답 파라메터 상세를 참고해주세요!

가격 플랜 삭제

등록되어있는 가격 플랜을 삭제할 수 있습니다.

URL

DELETE
1https://api.steppay.kr/api/products/${productId}/prices/${price_id}

가격 플랜 삭제 응답 예시

가격 플랜 삭제 응답 파라메터

파라메터타입설명부가 설명
messagestring삭제 성공 또는 실패 메세지를 표시합니다.

successboolean삭제가 성공했는지 실패했는지 표시합니다.

사용량 과금

정책을 설정 후 해당 정책에 맞게 사용량을 측정하여 청구할 수 있습니다.
사용량 기반 과금 정책을 이용하여 구독 형태의 SaaS를 쉽게 서비스할 수 있습니다.

목차 보기

사용량 조회

사용량을 설정한 정책에 맞게 측정하여 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/usage_records

사용량 조회 응답 예시

사용량 조회 응답 파라메터

파라메터타입설명부가 설명
customerIdnumber고객 아이디를 표시합니다.

optionIdnumber옵션의 아이디를 표시합니다.

quantitynumber사용량을 표시합니다.

timestampdate사용량을 변경한 날짜를 표시합니다.
특정 시점에서의 사용량 기록을 위해 사용합니다.
기본값은 현재 시점 입니다.

사용량 기록

사용량을 측정한 값을 기록할 수 있습니다. 사용량을 기록하여 추후에 사용량에 기반한 가격으로 청구할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/usage_records

사용량 기록 요청 예시

사용량 기록 응답 파라메터

파라메터타입필수 여부설명부가 설명
customerIdnumber필수고객의 아이디입니다.

optionIdnumber필수옵션의 아이디입니다.

quantitynumber필수사용량을 설정합니다.

timestampdate선택사용량을 변경한 날짜를 설정합니다.
특정 시점에서의 사용량 기록을 위해 사용합니다.
기본값은 현재 시점 입니다.

사용량 기록 응답 예시

사용량 기록 요청 파라메터

파라메터타입설명부가 설명
customerIdnumber고객 아이디를 표시합니다.

optionIdnumber옵션의 아이디를 표시합니다.

quantitynumber사용량을 표시합니다.

timestampdate사용량을 변경한 날짜를 표시합니다.
특정 시점에서의 사용량 기록을 위해 사용합니다.
기본값은 현재 시점 입니다.

청구서 관리하기

청구서 API를 이용하여 고객들에게 이미 생성되어 있는 상품에 대한 청구서를 발송할 수 있습니다.
전체 청구서 내역을 조회할 수 있으며, 특정 청구서만을 조회하여 디테일 페이지에 나타낼 수 있습니다.
여러 채널을 이용하여 청구서를 발송하여 특정 고객에게 청구서를 발송할 수 있습니다.

목차 보기

전체 청구서 조회

생성된 전체 청구서들을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/invoices

전체 청구서 조회 응답 예시

전체 청구서 조회 응답 파라메터

파라메터타입설명부가 설명
createdAtdate생성 날짜를 표시합니다.

customerNamestring청구서를 보낸 고객의 이름을 표시합니다.

idnumber청구서의 아이디를 표시합니다.

orderIdnumber청구서를 보낸 주문 아이디를 표시합니다.

orderTypeenum주문의 타입을 표시합니다.
ONE_TIME: 단건
RECURRING: 정기 결제

paymentDatedate결제 날짜를 표시합니다.

pricenumber결제 가격을 표시합니다.

productNamestring청구할 상품 이름을 표시합니다.

purchaseDeadlinestring청구서 결제 기한을 표시합니다.

statusenum청구서의 상태를 표시합니다.
TEMPORARY: 임시 저장
RESERVATION: 예약
SEND: 발송
PAID: 납입 완료
OVER_DUE: 미납입

overdueCountnumber미납입된 청구서의 수를 표시합니다.

paidCountnumber납입 완료된 청구서의 수를 표시합니다.

reservationCountnumber예약된 청구서의 수를 표시합니다.

sendCountnumber발송된 청구서의 수를 표시합니다.

특정 청구서 조회

생성된 특정 청구서를 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/invoices/${id}

특정 청구서 조회 응답 예시

특정 청구서 조회 응답 파라메터

파라메터타입설명부가 설명
customerobject청구서를 받은 고객 정보를 표시합니다.
하단 customer 코드 참고
discountnumber할인율을 표시합니다.

idnumber청구서의 아이디를 표시합니다.

orderobject청구서를 보낸 주문의 정보를 표시합니다.
하단 order 코드 참고
publishMethodenum발송 수단을 표시합니다.
KAKAO: 알림톡
SMS: 메시지
EMAIL: 이메일

publishTypeenum청구서 발송일을 표시합니다.
NOW: 즉시 발송
RESERVATION: 예약 발송

purchaseDeadlinestring청구서 결제 기한을 표시합니다.

statusenum청구서의 상태를 표시합니다.
TEMPORARY: 임시 저장
RESERVATION: 예약
SEND: 발송
PAID: 납입 완료
OVER_DUE: 미납입

특정 청구서 조회 응답 파라메터 상세

customer

# 고객 관리하기를 참고해주세요!

order

# 주문 관리하기를 참고해주세요!

청구서 생성(발송)

특정 사용자에게 특정 시점에 특정 발송수단을 이용해 결제를 유도할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/invoices

청구서 생성(발송) 요청 예시

청구서 생성(발송) 요청 파라메터

파라메터타입필수 여부설명부가 설명
customerIdnumber필수사용자 id를 표시합니다.

discountnumber필수할인 금액을 표시합니다.

productsobject필수결제할 상품 또는 가격 플랜을 설정합니다.
하단 products 코드 참고
publishMethodsenum필수청구서 발송 수단을 설정합니다.
KAKAO: 카카오톡
SMS: 문자 메세지
EMAIL: 이메일

publishTypeenum필수청구서 발송일을 설정합니다.
NOW: 즉시 발송
RESERVATION: 예약 발송

purchaseDeadlinestring필수결제 마감 기한을 설정합니다.

reservationAtdate선택publishType이 RESERVATION일 때 발송 시점을 설정합니다.

청구서 생성(발송) 요청 파라메터 상세

products

결제할 상품 또는 가격 플랜을 설정합니다.

1[{
2    priceId: number,
3    productId: number,
4    quantity: number
5}]
파라메터타입설명부가 설명
priceIdnumber가격의 아이디를 표시합니다.

productIdnumber상품의 아이디를 표시합니다.

quantitynumber상품의 수량을 표시합니다.

청구서 생성(발송) 응답 예시

청구서 생성(발송) 응답 파라메터

파라메터타입설명부가 설명
customerobject청구서를 받은 고객 정보를 표시합니다.
하단 customer 코드 참고
discountnumber할인율을 표시합니다.

idnumber청구서의 아이디를 표시합니다.

orderobject청구서를 보낸 주문의 정보를 표시합니다.
하단 order 코드 참고
publishMethodenum발송 수단을 표시합니다.
KAKAO: 알림톡
SMS: 메시지
EMAIL: 이메일

publishTypeenum청구서 발송일을 표시합니다.
NOW: 즉시 발송
RESERVATION: 예약 발송

purchaseDeadlinestring청구서 결제 기한을 표시합니다.

statusenum청구서의 상태를 표시합니다.
TEMPORARY: 임시 저장
RESERVATION: 예약
SEND: 발송
PAID: 납입 완료
OVER_DUE: 미납입

청구서 생성(발송) 응답 파라메터 상세

customer

# 고객 관리하기를 참고해주세요!

order

# 주문 관리하기를 참고해주세요!

청구서 수정

설명 추가 준비중입니다.

청구서 삭제

설명 추가 준비중입니다.

주문 관리하기

주문 API에서 주문 관리와 재고관리를 할 수 있습니다.
주문 내에서 배송, CS, 정기구독 관리를 할 수 있으며 배송, CS API는 주문 API와 1대1 대응합니다.
여러 주문 상태들을 관리할 수 있으며, 리스트로 전체 주문 내역을 조회하거나 특정 주문 내역을 조회할 수 있습니다.

목차 보기

전체 주문 조회

생성된 전체 주문들을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders

전체 주문 조회 응답 예시

전체 주문 조회 응답 파라메터

파라메터타입설명부가 설명
createdAtdate주문 생성 날짜를 표시합니다.

customerNamestring주문을 생성한 고객 이름을 표시합니다.

idnumber주문 아이디를 표시합니다.

modifiedAtdate주문이 수정된 날짜를 표시합니다.

paymentDatedate주문이 결제된 날짜를 표시합니다.

paymentDeadlinedate결제 마감 기한을 표시합니다.
청구서를 발송할 경우 사용됩니다.

pricestring주문의 가격을 표시합니다.

productNamestring주문된 상품의 이름을 표시합니다.

statusenum주문의 상태를 표시합니다.
CREATED: 생성됨
PAID: 결제완료
CANCEL_REQ: 취소 요청
CANCELED: 취소 완료
CHANGE_REQ: 교환 요청
CHANGE_PROCESS: 교환 처리중
CHANGED: 교환 완료
RETURN_REQ: 반품 요청
RETURN_PROCESS: 반품 처리중
RETURNED: 반품 완료
PREPARING: 배송 준비중
SHIPPING: 배송 중
FULFILLED: 배송 완료
FULL_REFUND: 전액 환불
PARTIAL_REFUND: 부분 환불
PAYMENT_FAILURE: 결제 실패

statusRequestDatedate주문의 상태가 요청된 날짜를 표시합니다.

typeenum주문의 타입을 표시합니다.
ONE_TIME: 단건 또는 정기결제 시작 주문
RECURRING: 정기결제

특정 주문 조회

생성된 주문들 중 특정 주문을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders/${id}

특정 주문 조회 응답 예시

특정 주문 조회 응답 파라메터

파라메터타입설명부가 설명
amountnumber주문의 금액을 표시합니다.

amountReturnednumber주문의 환불 금액을 표시합니다.
주문이 환불되었을 경우에 표시됩니다.

cancelledDatedate주문의 취소 날짜를 표시합니다.
주문이 취소되었을 경우에 표시됩니다.

createdAtdate주문이 생성된 날짜를 표시합니다.

customerobject주문한 고객의 정보를 표시합니다.
하단 customer 코드 참고
emailstring고객의 이메일을 표시합니다.

idnumber주문 아이디를 표시합니다.

itemsobject주문에 대한 정보를 설정합니다.
object array
하단 items 코드 참고
modifiedAtdate주문이 수정된 날짜를 표시합니다.

paymentDatedate주문이 결제된 날짜를 표시합니다.

paymentDeadlinedate결제 마감 기한을 표시합니다.
청구서를 발송할 경우 사용됩니다.

shippingobject고객의 배송 정보를 표시합니다.
하단 shipping 코드 참고
statusenum주문의 상태를 표시합니다.
CREATED: 생성됨
PAID: 결제완료
CANCEL_REQ: 취소 요청
CANCELED: 취소 완료
CHANGE_REQ: 교환 요청
CHANGE_PROCESS: 교환 처리중
CHANGED: 교환 완료
RETURN_REQ: 반품 요청
RETURN_PROCESS: 반품 처리중
RETURNED: 반품 완료
PREPARING: 배송 준비중
SHIPPING: 배송 중
FULFILLED: 배송 완료
FULL_REFUND: 전액 환불
PARTIAL_REFUND: 부분 환불
PAYMENT_FAILURE: 결제 실패

statusRequestDatedate주문의 상태가 요청된 날짜를 표시합니다.

typeenum주문의 타입을 표시합니다.
ONE_TIME: 단건 또는 정기결제 시작 주문
RECURRING: 정기결제

특정 주문 조회 응답 파라메터 상세

customer

# 고객 관리를 참고해주세요!

items

주문된 상품의 정보를 표시합니다.

1[
2    {
3      "amount": 0,
4      "currency": "string",
5      "description": "string",
6      "featuredImageUrl": "string",
7      "id": 0,
8      "price": {},
9      "product": {},
10      "productOptions": "string",
11      "quantity": 0
12    }
13]
파라메터타입설명부가 설명
amountnumber상품의 가격을 표시합니다.

currencystring통화를 표시합니다.

descriptionstring상품의 설명을 표시합니다.

featuredImageUrlstring상품의 대표 이미지를 표시합니다.
(자세한 설명은 파일 업로드 API를 참고해주세요.)


idnumber상품의 아이디를 표시합니다.

pricearray주문의 가격 플랜을 표시합니다.
하단 참고
productarray주문의 상품을 표시합니다.
하단 참고
productOptionsstring상품의 옵션을 표시합니다.

quantitynumber상품의 수량을 표시합니다.

price

# 가격 플랜 관리를 참고해주세요!

product

# 상품 관리를 참고해주세요!

shipping

# 고객 추가 요청 파라메터를 참고해주세요!

주문 생성

결제 가능한 주문을 생성할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/orders

주문 생성 요청 예시

주문 생성 요청 파라메터

파라메터타입필수 여부설명부가 설명
customerIdnumber선택사용자 id를 표시합니다.

emailstring선택사용자 이메일을 표시합니다.

itemsobject필수주문에 대한 정보를 설정합니다.
object array
하단 items 코드 참고
shippingobject선택고객의 배송지 정보를 표시합니다.
하단 shipping 코드 참고

items

주문된 상품의 정보를 설정합니다.

1[
2    {
3      "amount": 0,
4      "currency": "string",
5      "description": "string",
6      "priceId": 0,
7      "productId": 0,
8      "productOption": "string",
9      "quantity": 0
10    }
11]
파라메터타입필수 여부설명부가 설명
amountnumber선택상품의 가격을 설정합니다.

currencystring선택통화를 설정합니다.

descriptionstring선택상품의 설명을 설정합니다.

priceIdnumber선택가격 플랜의 아이디입니다.

productIdnumber선택상품의 아이디입니다.

productOptionsstring선택상품의 옵션을 표시합니다.

quantitynumber선택상품의 수량을 표시합니다.

shipping

# 고객 추가 요청 파라메터 상세를 참고해주세요!

ONE_TIME: 단건 또는 정기결제 시작 주문

주문 생성 응답 예시

주문 생성 응답 파라메터

파라메터타입설명부가 설명
amountnumber주문의 금액을 표시합니다.

amountReturnednumber주문의 환불 금액을 표시합니다.
주문이 환불되었을 경우에 표시됩니다.

cancelledDatedate주문의 취소 날짜를 표시합니다.
주문이 취소되었을 경우에 표시됩니다.

createdAtdate주문이 생성된 날짜를 표시합니다.

customerobject주문한 고객의 정보를 표시합니다.
하단 customer 코드 참고
emailstring고객의 이메일을 표시합니다.

idnumber주문 아이디를 표시합니다.

itemsobject주문에 대한 정보를 설정합니다.
object array
하단 items 코드 참고
modifiedAtdate주문이 수정된 날짜를 표시합니다.

paymentDatedate주문이 결제된 날짜를 표시합니다.

paymentDeadlinedate결제 마감 기한을 표시합니다.
청구서를 발송할 경우 사용됩니다.

shippingobject고객의 배송 정보를 표시합니다.
하단 shipping 코드 참고
statusenum주문의 상태를 표시합니다.
CREATED: 생성됨
PAID: 결제완료
CANCEL_REQ: 취소 요청
CANCELED: 취소 완료
CHANGE_REQ: 교환 요청
CHANGE_PROCESS: 교환 처리중
CHANGED: 교환 완료
RETURN_REQ: 반품 요청
RETURN_PROCESS: 반품 처리중
RETURNED: 반품 완료
PREPARING: 배송 준비중
SHIPPING: 배송 중
FULFILLED: 배송 완료
FULL_REFUND: 전액 환불
PARTIAL_REFUND: 부분 환불
PAYMENT_FAILURE: 결제 실패

statusRequestDatedate주문의 상태가 요청된 날짜를 표시합니다.

typeenum주문의 타입을 표시합니다.
ONE_TIME: 단건 또는 정기결제 시작 주문
RECURRING: 정기결제

주문 생성 응답 파라메터 상세

customer

# 고객 관리하기를 참고해주세요!

items

# 특정 주문 조회 응답 파라메터 상세를 참고해주세요!

shipping

# 고객 추가 요청 파라메터 상세를 참고해주세요!

주문 취소

주문을 취소할 수 있습니다.

URL

PATCH
1https://api.steppay.kr/api/orders/${order_id}/cancel

주문 취소 요청 예시

주문 취소 요청 파라메터

파라메터타입필수 여부설명부가 설명
requestPricenumber선택주문 취소 할 금액을 입력합니다.

주문 취소 응답 예시

주문 취소 응답 파라메터

파라메터타입설명부가 설명
messagestring주문 취소 성공 또는 실패 메세지를 표시합니다.

successboolean주문 취소가 성공했는지 실패했는지 표시합니다.

주문 수정

설명 추가 준비중입니다.

주문 삭제

설명 추가 준비중입니다.

구독 관리하기

구독 API에서 구독 상품과 구독에 대한 관리를 할 수 있습니다.
리스트로 전체 구독 내역을 조회하거나 특정 구독 내역을 조회할 수 있습니다.

목차 보기

구독 내역 조회

등록되어있는 모든 구독에 대한 구독 목록을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/subscriptions

구독 내역 조회 응답 예시

구독 내역 조회 응답 파라메터

파라메터타입설명부가 설명
customerNamestring고객의 이름을 표시합니다.

endDatedate구독 만료 기간을 표시합니다.

idnumber구독의 아이디를 표시합니다.

itemobject구독인 상품의 정보를 표시합니다.
object array
하단 item 코드 참고
lastPaymentDatedate마지막 결제일을 표시합니다.

nextPaymentDatedate다음 결제일을 표시합니다.

priceobject구독의 가격 플랜을 표시합니다.
object array
하단 price 코드 참고
quantitynumber구독의 수량을 표시합니다.

startDatedate구독 시작일을 표시합니다.

statusenum구독 상태를 표시합니다.
INCOMPLETE: 결제 대기
INCOMPLETE_EXPIRED: 결제 기한 만료
ACTIVE: 구독 활성화
CANCELED: 구독 취소
PAUSE: 일시 정지
EXPIRED: 구독 만료

구독 내역 조회 응답 파라메터 상세

items

# 특정 주문 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜 관리를 참고해주세요!

특정 구독 내역 조회

등록되어있는 특정 구독에 대한 구독 상세를 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/subscriptions/${id}

특정 구독 내역 조회 응답 예시

특정 구독 내역 조회 응답 파라메터

파라메터타입설명부가 설명
customerNamestring고객의 이름을 표시합니다.

endDatedate구독 만료 기간을 표시합니다.

idnumber구독의 아이디를 표시합니다.

itemobject구독인 상품의 정보를 표시합니다.
object array
하단 item 코드 참고
lastPaymentDatedate마지막 결제일을 표시합니다.

nextPaymentDatedate다음 결제일을 표시합니다.

priceobject구독의 가격 플랜을 표시합니다.
object array
하단 price 코드 참고
quantitynumber구독의 수량을 표시합니다.

startDatedate구독 시작일을 표시합니다.

statusenum구독 상태를 표시합니다.
INCOMPLETE: 결제 대기
INCOMPLETE_EXPIRED: 결제 기한 만료
ACTIVE: 구독 활성화
CANCELED: 구독 취소
PAUSE: 일시 정지
EXPIRED: 구독 만료

특정 구독 내역 조회 응답 파라메터 상세

items

# 특정 주문 조회 응답 파라메터 상세를 참고해주세요!

prices

# 가격 플랜 관리를 참고해주세요!

구독 상태 변경

구독에 대한 현재 상태를 변경할 수 있습니다.

URL

PATCH
1https://api.steppay.kr/api/subscriptions

구독 상태 변경 요청 예시

구독 상태 변경 요청 예시 파라메터

파라메터타입필수 여부설명부가 설명
idnumber선택구독 아이디입니다.

statusenum선택구독 상태를 표시합니다.
INCOMPLETE: 결제 대기
INCOMPLETE_EXPIRED: 결제 기한 만료
ACTIVE: 구독 활성화
CANCELED: 구독 취소
PAUSE: 일시 정지
EXPIRED: 구독 만료

구독 상태 변경 응답 예시

구독 상태 변경 응답 예시 파라메터

파라메터타입설명부가 설명
messagestring구독 상태 변경 결과에 대한 메세지를 표시합니다.

successboolean구독 상태 변경이 성공했는지 실패했는지 표시합니다.

CS 관리하기

CS API에서 CS관리를 할 수 있습니다.
주문 API와 1대1 대응하며, 주문 API에서도 CS 내용을 확인 할 수 있습니다.
상품에 대한 취소, 교환, 반품, 환불 관리를 할 수 있으며 요약하여 요청된 상태와 완료된 상태를 구분하여 볼 수 있습니다.

목차 보기

CS 조회

CS 요청이 들어온 주문 건에 대하여 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders/type/cs

CS 조회 응답 예시

CS 조회 응답 파라메터

# 주문 관리에서 CS 관련 내용을 확인할 수 있습니다.

CS 요약

CS 요청이 들어온 주문건에 대하여 간략히 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders/type/cs/summary

CS 요약 응답 예시

CS 요약 응답 파라메터

파라메터타입설명부가 설명
cancelledCountnumber취소 건수를 표시합니다.

changedCountnumber교환 건수를 표시합니다.

refundedCountnumber환불 건수를 표시합니다.

returnedCountnumber반품 건수를 표시합니다.

배송 관리하기

배송 API에서 배송 관리를 할 수 있습니다.
CS API와 마찬가지로 주문 API와 1대1 대응하며, 주문 API에서도 배송 관련 내용을 확인 할 수 있습니다.
상품에 대한 배송 상태, 결제 상태를 관리할 수 있습니다.

목차 보기

배송 조회

배송 관련 주문 건에 대하여 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders/type/shipping

배송 조회 응답 예시

배송 조회 응답 파라메터

# 주문 관리에서 배송 관련 내용을 확인할 수 있습니다.

배송 요약

배송 관련 주문 건에 대하여 간략하게 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/orders/type/shipping/summary

배송 요약 응답 예시

배송 요약 응답 파라메터

파라메터타입설명부가 설명
fulfilledCountnumber배송 완료 건수를 표시합니다.

paidCountnumber결제 완료 건수를 표시합니다.

preparedCountnumber배송 준비중 건수를 표시합니다.

shippingCountnumber배송중 건수를 표시합니다.

고객 관리하기

고객 API를 이용하여 새로운 고객을 추가할 수 있고, 고객 관리를 할 수 있습니다.
전체 고객을 리스트로 조회할 수도 있으며, 특정 고객만 조회하여 디테일 페이지에 정보를 나타낼 수 있습니다.
추가되어 있는 고객의 정보를 이용하여 청구서를 발송할 수 있으며, 고객의 소비 상태를 한 눈에 알 수 있습니다.

목차 보기

전체 고객 조회

가맹점 내의 전체 고객들의 리스트를 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/customers

전체 고객 조회 응답 예시

전체 고객 조회 응답 파라메터

파라메터타입설명부가 설명
createdAtdate고객 생성 날짜를 표시합니다.

emailstring고객 이메일을 표시합니다.

idnumber고객 아이디를 표시합니다.

namestring고객 이름을 표시합니다.

orderCountnumber고객이 주문한 횟수를 표시합니다.

phonestring고객 전화번호를 표시합니다.

statusenum고객의 상태를 표시합니다.
NORMAL: 활성화
DORMANT: 휴면

특정 고객 조회

가맹점 내의 고객들 중 특정 고객들을 조회할 수 있습니다.

URL

GET
1https://api.steppay.kr/api/customers/${id}

특정 고객 조회 응답 예시

특정 고객 조회 응답 파라메터

파라메터타입설명부가 설명
emailstring고객 이메일을 표시합니다.

idnumber고객 아이디를 표시합니다.

namestring고객 이름을 표시합니다.

orderCountnumber고객이 주문한 횟수를 표시합니다.

ordersarrayobject array
고객이 주문한 정보를 표시합니다.
하단 orders 코드 참고
phonestring고객 전화번호를 표시합니다.

shippingobject고객의 배송 정보를 표시합니다.
하단 shipping 코드 참고
statusenum고객의 상태를 표시합니다.
NORMAL: 활성화
DORMANT: 휴면

totalPurchasedPricenumber고객이 주문한 상품들의 총 합계 가격을 표시합니다.

특정 고객 조회 응답 파라메터 상세

orders

# 주문 관리하기를 참고해주세요!

shipping

# 고객 추가 요청 파라메터 상세를 참고해주세요!

고객 추가

가맹점에 새로운 고객을 추가할 수 있습니다.

URL

POST
1https://api.steppay.kr/api/customers

고객 추가 요청 예시

고객 추가 요청 파라메터

파라메터타입필수 여부설명부가 설명
emailstring필수고객의 이메일을 표시합니다.

namestring필수고객의 이름을 표시합니다.

phonestring필수고객의 전화번호를 표시합니다.

shippingobject선택고객의 배송정보를 표시합니다.
하단 shipping 코드 참고

고객 추가 요청 파라메터 상세

shipping

1{
2    "address1" : string,
3    "address2" : string,
4    "postcode" : string 
5}
파라메터타입설명부가 설명
address1string고객의 주소를 표시합니다.

address2string고객의 주소를 표시합니다.

postcodestring고객의 우편번호를 표시합니다.

고객 추가 응답 예시

고객 추가 응답 파라메터

파라메터타입설명부가 설명
emailstring고객 이메일을 표시합니다.

idnumber고객 아이디를 표시합니다.

namestring고객 이름을 표시합니다.

orderCountnumber고객이 주문한 횟수를 표시합니다.

ordersarrayobject array
고객이 주문한 정보를 표시합니다.
하단 orders 코드 참고
phonestring고객 전화번호를 표시합니다.

shippingobject고객의 배송 정보를 표시합니다.
하단 shipping 코드 참고
statusenum고객의 상태를 표시합니다.
NORMAL: 활성화
DORMANT: 휴면

totalPurchasedPricenumber고객이 주문한 상품들의 총 합계 가격을 표시합니다.

고객 추가 응답 파라메터 상세

orders

# 주문 관리하기를 참고해주세요!

shipping

# 고객 추가 요청 파라메터 상세를 참고해주세요!

파일 업로드

업로드된 파일은 스텝페이 스토리지에 저장됩니다.
프로필 이미지, 상품 이미지, 구매시 다운로드 제공의 기능을 이용시 해당 API가 필요합니다.
API 호출 시 업로드한 파일에 대한 링크를 받을 수 있습니다. 해당 링크로 다른 API에서 활용 가능합니다.

목차 보기

프로필 이미지 업로드

프로필에 사용할 이미지를 업로드할 수 있습니다.
해당 API 호출 시 파일에 대한 링크를 받을 수 있습니다.

URL

POST
1https://api.steppay.kr/api/storages/account

프로필 이미지 업로드 요청 파라메터

파라메터타입필수 여부설명부가 설명
filefile필수기본 파일 정보를 입력합니다.

프로필 이미지 업로드 응답 예시

프로필 이미지 업로드 응답 파라메터

파라메터타입설명부가 설명
fileListobject파일에 대한 정보를 표시합니다.
하단 fileList 코드 참고
typestring파일 타입을 표시합니다.

프로필 이미지 업로드 응답 파라메터 상세

fileList

1[
2    {
3      "id": 0,
4      "path": "string",
5      "url": "string"
6    }
7  ]
파라메터타입설명부가 설명
idnumber업로드된 파일의 아이디를 표시합니다.

pathstring업로드된 파일의 상대 경로를 표시합니다.

urlstring업로드된 파일의 url을 표시합니다.

컨텐츠 파일 업로드

구매시 파일 형태의 컨텐츠를 제공할 경우 파일을 업로드 할 수 있습니다.
해당 API 호출 시 파일에 대한 링크를 받을 수 있습니다.

URL

POST
1https://api.steppay.kr/api/storages/downloadable

컨텐츠 파일 업로드 요청 파라메터

파라메터타입필수 여부설명부가 설명
filearray필수object array
기본 파일 정보를 입력합니다.

priceIdnumber필수다운로드를 제공하는 가격 플랜의 아이디를 입력합니다.

컨텐츠 파일 업로드 응답 예시

컨텐츠 파일 업로드 응답 파라메터

파라메터타입설명부가 설명
fileListobject파일에 대한 정보를 표시합니다.
하단 fileList 코드 참고
typestring파일 타입을 표시합니다.

컨텐츠 파일 업로드 응답 파라메터 상세

fileList

# 프로필 이미지 업로드 응답 파라메터 상세를 참고해주세요!

상품 이미지 업로드

상품에 관한 이미지를 업로드할 수 있습니다.
해당 API 호출 시 파일에 대한 링크를 받을 수 있습니다.

URL

POST
1https://api.steppay.kr/api/storages/product-images

상품 이미지 업로드 요청 파라메터

파라메터타입필수 여부설명부가 설명
filearray필수object array
기본 파일 정보를 입력합니다.

상품 이미지 업로드 응답 예시

상품 이미지 업로드 응답 파라메터

파라메터타입설명부가 설명
fileListobject파일에 대한 정보를 표시합니다.
하단 fileList 코드 참고
typestring파일 타입을 표시합니다.

상품 이미지 업로드 응답 파라메터 상세

fileList

# 프로필 이미지 업로드 응답 파라메터 상세를 참고해주세요!