Skip to main content
PATCH
/
api
/
v1
/
cover
/
order
/
success
/
{orderId}
주문 성공 API
curl --request PATCH \
  --url https://api.steppay.kr/api/v1/cover/order/success/{orderId} \
  --header 'Secret-Token: <api-key>'
{
  "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

Path Parameters

orderId
integer<int64>
required

주문 ID

Query Parameters

notify
boolean

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>

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