주문 정보 등록 API
커버 API
주문 정보 등록 API
주문 정보를 스텝커버에 등록할 때 사용합니다.
POST
주문 정보 등록 API
Authorizations
Body
application/json
주문 생성 데이터
고객 ID
주문 금액
환불된 금액
주문 항목
partnerOrderId가 이미 존재할 때 replaceIfExists가 true 이면 값을 수정하고, false 이면 exception 이 발생합니다.
결제 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 가맹점에서 사용하는 주문의 unique ID
결제일
스텝페이 결제 ID
취소 날짜
연관된 구독 ID
결제 정보(카드사, 카드번호 등)
주문 등록과 함께 시나리오가 실행되게 하려면 true 입력
PG사에서 받은 에러 코드(paymentFailed가 true일 때)
PG사에서 받은 에러 메세지(paymentFailed가 true일 때)
Response
주문 정보가 정상적으로 등록됨
주문 ID - 다른 API 호출에 사용되므로 해당 주문 정보와 함께 저장해놓고 사용하세요.
고객 정보
주문 금액
환불 금액
주문 항목
주문 상태
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 가맹점에서 사용하는 주문의 unique ID
주문 취소 시점
주문 결제 시점
스텝페이 주문 idKey
다음 결제 시도 시점 - 시나리오에 의해서 계산된 시점입니다. 해당 시점에 다시 결제를 시도해주세요(실패 주문을 생성했을 때 포함됩니다).