1. interface
  2. Cable8mm
  3. \
  4. LaravelPortone
  5. \
  6. PaymentGateway

PaymentGateway

interface PaymentGateway (View source)

PortOne API 호출 규격. 모든 외부 요청은 이 인터페이스를 통한다.

Methods

GatewayPayment
lookup(string $paymentId)

PortOne에서 결제 1건을 조회한다.

GatewayPayment
lookupForExpiry(string $paymentId)

만료 확인용으로 결제 1건을 조회한다.

void
cancel(string $paymentId, string $reason, int|null $amount)

PortOne 결제를 취소(환불)한다. 금액 생략 시 전액 취소이다.

Details

at line 20
GatewayPayment lookup(string $paymentId)

PortOne에서 결제 1건을 조회한다.

Parameters

string $paymentId

PortOne 결제 식별자

Return Value

GatewayPayment

PortOne 결제 상태와 실결제액

Exceptions

Throwable

at line 33
GatewayPayment lookupForExpiry(string $paymentId)

만료 확인용으로 결제 1건을 조회한다.

lookup()과 같지만, PortOne이 결제를 모르면(PAYMENT_NOT_FOUND) 예외 대신 found가 false인 결과를 반환한다.

Parameters

string $paymentId

PortOne 결제 식별자

Return Value

GatewayPayment

PortOne 결제 상태와 실결제액

Exceptions

Throwable

at line 44
void cancel(string $paymentId, string $reason, int|null $amount)

PortOne 결제를 취소(환불)한다. 금액 생략 시 전액 취소이다.

Parameters

string $paymentId

PortOne 결제 식별자
string $reason

PortOne에 전달할 환불 사유
int|null $amount

환불 금액(원, null이면 전액)

Return Value

void

Exceptions

Throwable