결제 세션 API

결제 세션 생성 및 관리 API. 호스티드 체크아웃에 사용됩니다.

결제 세션을 생성합니다. 호스티드 체크아웃 페이지가 생성되어 URL이 반환됩니다.

결제 세션을 조회합니다. 인증 헤더 없이 웹 페이지에서도 접근 가능합니다.

결제 세션을 즉시 만료시킵니다. 이후 해당 세션으로는 결제 페이지에 접근할 수 없습니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
CheckoutPaymentMethod: "CARD_KR" | "N_PAY" | "KAKAO_PAY" | ...
결제 수단
ClosePaymentSessionError: ForbiddenError | InvalidRequestError | SessionNotFoundError | ...
ClosePaymentSessionResponse: { closedAt }
결제 세션 종료 성공 응답
Country: "AD" | "AE" | "AF" | ...
국가
CreatePaymentSessionBody: { storeId, paymentId, profileKey, ... }
결제 세션 생성 요청
CreatePaymentSessionError: ForbiddenError | InvalidRequestError | MaxTtlExceededError | ...
CreatePaymentSessionResponse: { sessionId, url, expiresAt }
결제 세션 생성 성공 응답
Currency: "KRW" | "USD" | "JPY" | ...
통화
ForbiddenError: { type, message }
요청이 거절된 경우
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

MaxTtlExceededError: { type, message }
요청된 TTL이 정책 상한을 초과한 경우
PaymentSession: { id, storeId, paymentId, ... }
결제 세션
PaymentSessionAgreement: { name, url }
결제 세션 약관
PaymentSessionColors: { primary, primaryHover, primaryLight }
체크아웃 페이지 색 설정
PaymentSessionProduct: { id, name, code, ... }
결제 세션 주문 항목
SessionExpiredError: { type, message }
결제 세션이 만료된 경우
SessionNotFoundError: { type, message }
결제 세션이 존재하지 않는 경우
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우