portone_server_sdk.webhook

portone_server_sdk.webhook#

Module Attributes

WebhookVerificationFailureReason

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

Functions

verify(secret, payload, headers)

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

Classes

`WebhookBillingKeyRequestDeletedData`
`WebhookBillingKeyRequestDeleted`	빌링키가 삭제되었을 때
`WebhookBillingKeyRequestFailedData`
`WebhookBillingKeyRequestFailed`	빌링키 발급이 실패했을 때
`WebhookBillingKeyRequestIssuedData`
`WebhookBillingKeyRequestIssued`	빌링키가 발급되었을 때
`WebhookBillingKeyRequestReadyData`
`WebhookBillingKeyRequestReady`	빌링키 발급창이 열렸을 때
`WebhookBillingKeyRequestUpdatedData`
`WebhookBillingKeyRequestUpdated`	빌링키가 업데이트되었을 때
`WebhookTransactionRequestCancelPendingData`
`WebhookTransactionRequestCancelPending`	(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때
`WebhookTransactionRequestCancelledData`
`WebhookTransactionRequestCancelled`	결제가 완전 취소되었을 때
`WebhookTransactionRequestFailedData`
`WebhookTransactionRequestFailed`	결제(예약 결제 포함)가 실패했을 때
`WebhookTransactionRequestPaidData`
`WebhookTransactionRequestPaid`	결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단)
`WebhookTransactionRequestPartialCancelledData`
`WebhookTransactionRequestPartialCancelled`	결제가 부분 취소되었을 때
`WebhookTransactionRequestPayPendingData`
`WebhookTransactionRequestPayPending`	결제 승인 대기 상태가 되었을 때 (해외 결제시 발생 가능)
`WebhookTransactionRequestReadyData`
`WebhookTransactionRequestReady`	결제창이 열렸을 때
`WebhookTransactionRequestVirtualAccountIssuedData`
`WebhookTransactionRequestVirtualAccountIssued`	가상계좌가 발급되었을 때

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#

웹훅 검증이 실패했을 경우

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#

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.WebhookBillingKeyRequestDeletedData#

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestDeleted#

빌링키가 삭제되었을 때

type: Literal['BillingKey.Deleted']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestFailedData#

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestFailed#

빌링키 발급이 실패했을 때

type: Literal['BillingKey.Failed']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestIssuedData#

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestIssued#

빌링키가 발급되었을 때

type: Literal['BillingKey.Issued']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestReadyData#

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestReady#

빌링키 발급창이 열렸을 때

type: Literal['BillingKey.Ready']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestUpdatedData#

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

class portone_server_sdk.webhook.WebhookBillingKeyRequestUpdated#

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

type: Literal['BillingKey.Updated']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestCancelPendingData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestCancelPending#

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

type: Literal['Transaction.CancelPending']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestCancelledData#

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

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

cancellation_id: str#: 포트원에서 채번한 결제건의 취소 고유 번호입니다. type 이 Transaction.PartialCancelled 혹은 Transaction.Cancelled 일 때 존재합니다.

class portone_server_sdk.webhook.WebhookTransactionRequestCancelled#

결제가 완전 취소되었을 때

type: Literal['Transaction.Cancelled']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestFailedData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestFailed#

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

type: Literal['Transaction.Failed']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestPaidData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestPaid#

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

type: Literal['Transaction.Paid']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestPartialCancelledData#

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

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

cancellation_id: str#: 포트원에서 채번한 결제건의 취소 고유 번호입니다. type 이 Transaction.PartialCancelled 혹은 Transaction.Cancelled 일 때 존재합니다.

class portone_server_sdk.webhook.WebhookTransactionRequestPartialCancelled#

결제가 부분 취소되었을 때

type: Literal['Transaction.PartialCancelled']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestPayPendingData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestPayPending#

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

type: Literal['Transaction.PayPending']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestReadyData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestReady#

결제창이 열렸을 때

type: Literal['Transaction.Ready']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestVirtualAccountIssuedData#

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

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

class portone_server_sdk.webhook.WebhookTransactionRequestVirtualAccountIssued#

가상계좌가 발급되었을 때

type: Literal['Transaction.VirtualAccountIssued']#: 웹훅을 트리거한 이벤트의 타입입니다.

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

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

portone_server_sdk.webhook

Contents

portone_server_sdk.webhook#