Skip to main content
POST
/
api
/
v1
/
cover
/
order
주문 정보 등록 API
curl --request POST \
  --url https://api.steppay.kr/api/v1/cover/order \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "customerId": 123,
  "amount": 123,
  "amountReturned": 123,
  "items": [
    {
      "quantity": 123,
      "priceId": 123
    }
  ],
  "replaceIfExists": true,
  "paymentGateway": "NAVER",
  "partnerOrderId": "<string>",
  "paymentDate": "2023-11-07T05:31:56Z",
  "idKey": "<string>",
  "canceledDate": "2023-11-07T05:31:56Z",
  "subscriptionId": 123,
  "paymentInfo": "<string>",
  "paymentFailed": true,
  "errorCode": "<string>",
  "errorMessage": "<string>"
}
'
{
  "id": 123,
  "customer": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "partnerCustomerId": "<string>"
  },
  "amount": 123,
  "amountReturned": 123,
  "items": [
    {
      "quantity": 123,
      "price": {
        "id": 123,
        "name": "<string>",
        "partnerPriceId": "<string>",
        "product": {
          "id": 123,
          "name": "<string>",
          "partnerProductId": "<string>",
          "featuredImageUrl": "<string>"
        },
        "price": 123,
        "isRecurring": true,
        "recurringInterval": "DAY",
        "recurringIntervalCount": 123
      }
    }
  ],
  "status": "CREATED",
  "partnerOrderId": "<string>",
  "canceledDate": "2023-11-07T05:31:56Z",
  "paymentDate": "2023-11-07T05:31:56Z",
  "idKey": "<string>",
  "retryDate": "2023-11-07T05:31:56Z"
}

Authorizations

Secret-Token
string
header
required

Body

application/json

주문 생성 데이터

customerId
integer<int64>
required

고객 ID

amount
number
required

주문 금액

amountReturned
number
required

환불된 금액

items
주문 항목 생성 · object[]
required

주문 항목

replaceIfExists
boolean
required

partnerOrderId가 이미 존재할 때 replaceIfExists가 true 이면 값을 수정하고, false 이면 exception 이 발생합니다.

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
partnerOrderId
string
required

가맹점에서 사용하는 주문의 unique ID

paymentDate
string<date-time>

결제일

idKey
string

스텝페이 결제 ID

canceledDate
string<date-time>

취소 날짜

subscriptionId
integer<int64>

연관된 구독 ID

paymentInfo
string

결제 정보(카드사, 카드번호 등)

paymentFailed
boolean

주문 등록과 함께 시나리오가 실행되게 하려면 true 입력

errorCode
string

PG사에서 받은 에러 코드(paymentFailed가 true일 때)

errorMessage
string

PG사에서 받은 에러 메세지(paymentFailed가 true일 때)

Response

주문 정보가 정상적으로 등록됨

id
integer<int64>
required

주문 ID - 다른 API 호출에 사용되므로 해당 주문 정보와 함께 저장해놓고 사용하세요.

customer
object
required

고객 정보

amount
number
required

주문 금액

amountReturned
number
required

환불 금액

items
주문 항목 정보 · object[]
required

주문 항목

status
enum<string>
required

주문 상태

Available options:
CREATED,
PAID,
CANCEL_REQ,
CANCELED,
CHANGE_REQ,
CHANGE_PROCESS,
CHANGED,
RETURN_REQ,
RETURN_PROCESS,
RETURNED,
PREPARING,
SHIPPING,
FULFILLED,
FULL_REFUND,
PARTIAL_REFUND,
PAYMENT_FAILURE
partnerOrderId
string
required

가맹점에서 사용하는 주문의 unique ID

canceledDate
string<date-time>

주문 취소 시점

paymentDate
string<date-time>

주문 결제 시점

idKey
string

스텝페이 주문 idKey

retryDate
string<date-time>

다음 결제 시도 시점 - 시나리오에 의해서 계산된 시점입니다. 해당 시점에 다시 결제를 시도해주세요(실패 주문을 생성했을 때 포함됩니다).