Skip to main content
PATCH
/
api
/
v1
/
cover
/
order
/
cancel
/
{orderId}
주문 취소 API
curl --request PATCH \
  --url https://api.steppay.kr/api/v1/cover/order/cancel/{orderId} \
  --header 'Secret-Token: <api-key>'
import requests

url = "https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}"

headers = {"Secret-Token": "<api-key>"}

response = requests.patch(url, headers=headers)

print(response.text)
const options = {method: 'PATCH', headers: {'Secret-Token': '<api-key>'}};

fetch('https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Secret-Token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}"

req, _ := http.NewRequest("PATCH", url, nil)

req.Header.Add("Secret-Token", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}")
.header("Secret-Token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.steppay.kr/api/v1/cover/order/cancel/{orderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Secret-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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,
        "recurringIntervalCount": 123
      }
    }
  ],
  "partnerOrderId": "<string>",
  "canceledDate": "2023-11-07T05:31:56Z",
  "paymentDate": "2023-11-07T05:31:56Z",
  "idKey": "<string>",
  "retryDate": "2023-11-07T05:31:56Z"
}
{
"errorCode": "<string>",
"traceId": "<string>",
"errorMessage": "<string>",
"details": {}
}
{
"errorCode": "<string>",
"traceId": "<string>",
"errorMessage": "<string>",
"details": {}
}

Authorizations

Secret-Token
string
header
required

Path Parameters

orderId
integer<int64>
required

주문 ID

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>

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