portone_server_sdk.webhook

portone_server_sdk.webhook#

Module Attributes

WebhookVerificationFailureReason

웹훅 검증 실패 사유입니다.

Functions

verify(secret, payload, headers)

웹훅 페이로드를 검증합니다.

Classes

`WebhookBillingKeyDataDeleted`	빌링키가 삭제되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookBillingKeyDataFailed`	빌링키 발급이 실패했을 때 이벤트의 실제 세부 내용입니다.
`WebhookBillingKeyDataIssued`	빌링키가 발급되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookBillingKeyDataReady`	빌링키 발급창이 열렸을 때 이벤트의 실제 세부 내용입니다.
`WebhookBillingKeyDataUpdated`	빌링키가 업데이트되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookBillingKeyDeleted`	빌링키가 삭제되었을 때
`WebhookBillingKeyFailed`	빌링키 발급이 실패했을 때
`WebhookBillingKeyIssued`	빌링키가 발급되었을 때
`WebhookBillingKeyReady`	빌링키 발급창이 열렸을 때
`WebhookBillingKeyUpdated`	빌링키가 업데이트되었을 때
`WebhookTransactionCancelledCancelPending`	(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때
`WebhookTransactionCancelledCancelled`	결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionCancelledDataCancelled`	결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionCancelledDataPartialCancelled`	결제가 부분 취소되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionCancelledPartialCancelled`	결제가 부분 취소되었을 때
`WebhookTransactionCancelledDataCancelPending`	(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDataFailed`	결제(예약 결제 포함)가 실패했을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDataPaid`	결제(예약 결제 포함)가 승인되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDataPayPending`	결제 승인 대기 상태가 되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDataReady`	결제창이 열렸을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDataVirtualAccountIssued`	가상계좌가 발급되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionFailed`	결제(예약 결제 포함)가 실패했을 때
`WebhookTransactionPaid`	결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단)
`WebhookTransactionPayPending`	결제 승인 대기 상태가 되었을 때 (해외 결제시 발생 가능)
`WebhookTransactionReady`	결제창이 열렸을 때
`WebhookTransactionVirtualAccountIssued`	가상계좌가 발급되었을 때
`WebhookTransactionConfirm`	컨펌 프로세스에서 승인 요청을 받았을 때
`WebhookTransactionDataConfirm`	(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDisputeCreated`	분쟁이 발생되었을 때
`WebhookTransactionDataDisputeCreated`	분쟁이 발생되었을 때 이벤트의 실제 세부 내용입니다.
`WebhookTransactionDisputeResolved`	분쟁이 해소되었을 때
`WebhookTransactionDataDisputeResolved`	분쟁이 해소되었을 때 이벤트의 실제 세부 내용입니다.

Exceptions

`WebhookVerificationError`	웹훅 검증이 실패했을 경우
`InvalidInputError`	SDK에 전달한 사용자 입력이 잘못되었을 경우

portone_server_sdk.webhook.WebhookVerificationFailureReason#

웹훅 검증 실패 사유입니다.

WebhookVerificationError.get_message 에 전달하여 에러 메시지를 얻을 수 있습니다.

alias of Literal[‘MISSING_REQUIRED_HEADERS’, ‘NO_MATCHING_SIGNATURE’, ‘INVALID_SIGNATURE’, ‘TIMESTAMP_TOO_OLD’, ‘TIMESTAMP_TOO_NEW’]

exception portone_server_sdk.webhook.WebhookVerificationError#

Bases: PortOneError

웹훅 검증이 실패했을 경우

message: str | None#

reason: Literal['MISSING_REQUIRED_HEADERS', 'NO_MATCHING_SIGNATURE', 'INVALID_SIGNATURE', 'TIMESTAMP_TOO_OLD', 'TIMESTAMP_TOO_NEW']#

classmethod get_message(reason: Literal['MISSING_REQUIRED_HEADERS', 'NO_MATCHING_SIGNATURE', 'INVALID_SIGNATURE', 'TIMESTAMP_TOO_OLD', 'TIMESTAMP_TOO_NEW']) → str#

웹훅 검증 실패 사유로부터 에러 메시지를 생성합니다.

Parameters:: reason (WebhookVerificationFailureReason) – 에러 메시지를 생성할 실패 사유.
Returns:: 에러 메시지.
Return type:: str

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception portone_server_sdk.webhook.InvalidInputError#

Bases: PortOneError

SDK에 전달한 사용자 입력이 잘못되었을 경우

message: str | None#

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

웹훅 페이로드를 검증합니다.

Parameters:

secret (str | bytes | bytearray) – 웹훅 시크릿
payload (str) – 웹훅 페이로드
headers (Mapping[str, str]) – 웹훅 요청 시 포함된 헤더

Raises:

InvalidInputError – 입력받은 시크릿이 유효하지 않을 때 발생합니다.
WebhookVerificationError – 웹훅 검증에 실패했을 때 발생합니다.

Returns:

검증된 웹훅 페이로드. 웹훅 형식이 올바르지 않을 경우 None 입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDataDeleted#

Bases: object

빌링키가 삭제되었을 때 이벤트의 실제 세부 내용입니다.

billing_key: str#: 포트원에서 채번한 빌링키입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDataFailed#

Bases: object

빌링키 발급이 실패했을 때 이벤트의 실제 세부 내용입니다.

billing_key: str#: 포트원에서 채번한 빌링키입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDataIssued#

Bases: object

빌링키가 발급되었을 때 이벤트의 실제 세부 내용입니다.

billing_key: str#: 포트원에서 채번한 빌링키입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDataReady#

Bases: object

빌링키 발급창이 열렸을 때 이벤트의 실제 세부 내용입니다.

billing_key: str#: 포트원에서 채번한 빌링키입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDataUpdated#

Bases: object

빌링키가 업데이트되었을 때 이벤트의 실제 세부 내용입니다.

billing_key: str#: 포트원에서 채번한 빌링키입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

class portone_server_sdk.webhook.WebhookBillingKeyDeleted#

Bases: object

빌링키가 삭제되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookBillingKeyDataDeleted#: 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookBillingKeyFailed#

Bases: object

빌링키 발급이 실패했을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookBillingKeyDataFailed#: 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookBillingKeyIssued#

Bases: object

빌링키가 발급되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookBillingKeyDataIssued#: 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookBillingKeyReady#

Bases: object

빌링키 발급창이 열렸을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookBillingKeyDataReady#: 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookBillingKeyUpdated#

Bases: object

빌링키가 업데이트되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookBillingKeyDataUpdated#: 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledCancelPending#

Bases: object

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionCancelledDataCancelPending#: (결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledCancelled#

Bases: object

결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionCancelledDataCancelled#: 결제창이 열렸을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledDataCancelled#

Bases: object

결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

cancellation_id: str#: 포트원에서 채번한 결제건의 취소 고유 번호입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledDataPartialCancelled#

Bases: object

결제가 부분 취소되었을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

cancellation_id: str#: 포트원에서 채번한 결제건의 취소 고유 번호입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledPartialCancelled#

Bases: object

결제가 부분 취소되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionCancelledDataPartialCancelled#: 결제가 부분 취소되었을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionCancelledDataCancelPending#

Bases: object

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

cancellation_id: str#: 포트원에서 채번한 결제건의 취소 고유 번호입니다.

class portone_server_sdk.webhook.WebhookTransactionDataFailed#

Bases: object

결제(예약 결제 포함)가 실패했을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionDataPaid#

Bases: object

결제(예약 결제 포함)가 승인되었을 때 이벤트의 실제 세부 내용입니다. (모든 결제 수단)

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionDataPayPending#

Bases: object

결제 승인 대기 상태가 되었을 때 이벤트의 실제 세부 내용입니다. (해외 결제시 발생 가능)

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionDataReady#

Bases: object

결제창이 열렸을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionDataVirtualAccountIssued#

Bases: object

가상계좌가 발급되었을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionFailed#

Bases: object

결제(예약 결제 포함)가 실패했을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataFailed#: 결제(예약 결제 포함)가 실패했을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionPaid#

Bases: object

결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단)

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataPaid#: 결제(예약 결제 포함)가 승인되었을 때 이벤트의 실제 세부 내용입니다. (모든 결제 수단)

class portone_server_sdk.webhook.WebhookTransactionPayPending#

Bases: object

결제 승인 대기 상태가 되었을 때 (해외 결제시 발생 가능)

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataPayPending#: 결제 승인 대기 상태가 되었을 때 이벤트의 실제 세부 내용입니다. (해외 결제시 발생 가능)

class portone_server_sdk.webhook.WebhookTransactionReady#

Bases: object

결제창이 열렸을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataReady#: 결제창이 열렸을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionVirtualAccountIssued#

Bases: object

가상계좌가 발급되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataVirtualAccountIssued#: 가상계좌가 발급되었을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionConfirm#

Bases: object

컨펌 프로세스에서 승인 요청을 받았을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataConfirm#: 컨펌 프로세스에서 승인 요청을 받았을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionDataConfirm#

Bases: object

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

total_amount: int#: 결제건의 결제 요청 금액입니다.

class portone_server_sdk.webhook.WebhookTransactionDisputeCreated#

Bases: object

분쟁이 발생되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataDisputeCreated#: 분쟁이 발생되었을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionDataDisputeCreated#

Bases: object

분쟁이 발생되었을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

class portone_server_sdk.webhook.WebhookTransactionDisputeResolved#

Bases: object

분쟁이 해소되었을 때

timestamp: str#: 해당 웹훅을 트리거한 이벤트의 발생 시각(RFC 3339 형식)입니다. 고객사 서버가 웹훅을 수신하는 데 실패하여 재시도가 일어나도 이 값은 동일하게 유지됩니다. (RFC 3339 date-time)

data: WebhookTransactionDataDisputeResolved#: 분쟁이 해소되었을 때 이벤트의 실제 세부 내용입니다.

class portone_server_sdk.webhook.WebhookTransactionDataDisputeResolved#

Bases: object

분쟁이 해소되었을 때 이벤트의 실제 세부 내용입니다.

payment_id: str#: 고객사에서 채번한 결제 건의 고유 주문 번호입니다.

store_id: str#: 웹훅을 트리거한 상점의 아이디입니다.

transaction_id: str#: 포트원에서 채번한 고유 거래 번호입니다. 한 결제 건에 여러 시도가 있을 경우 transactionId 가 달라질 수 있습니다.

portone_server_sdk.webhook

Contents

portone_server_sdk.webhook#