subscribe

결제 예약취소 API

예약된 결제가 실행되기전에 해당 예약을 취소할 수 있는 API입니다.

post/subscribe/payments/unschedule

Request

Base URL
https://api.iamport.kr
Auth
none declared
TypeScript
https://skmtc.dev/iamport/apis/rest-api/docs/subscribe/payments/unschedule/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

customer_uidstring

빌링키와 매핑되며 고객사에서 채번하는 구매자의 결제 수단 식별 고유번호<br><b>(누락될 경우 merchant_uid들에 해당하는 결제예약정보를 일괄취소)</b>

Response

정상적으로 예약 취소가 완료되었습니다

codeinteger

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

messagestring

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

Changes

No recorded changes to this operation across all 1 revision of this API.