PaymentManager
in package
Tags
Table of Contents
- abandonPayment() : bool
- canBeAbandoned() : bool
- canBeCancelled() : bool
- canBeCompleted() : bool
- canBeFailed() : bool
- canBeOnHold() : bool
- canBeRefunded() : bool
- cancelPayment() : bool
- completePayment() : bool
- failPayment() : bool
- holdPayment() : bool
- refundPayment() : bool
Methods
abandonPayment()
public
abandonPayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be abandoned. False by default.
Tags
Return values
bool —canBeAbandoned()
public
canBeAbandoned(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —canBeCancelled()
public
canBeCancelled(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —canBeCompleted()
public
canBeCompleted(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —canBeFailed()
public
canBeFailed(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —canBeOnHold()
public
canBeOnHold(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —canBeRefunded()
public
canBeRefunded(Payment $payment) : bool
Parameters
- $payment : Payment
Tags
Return values
bool —cancelPayment()
public
cancelPayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be cancelled. False by default.
Tags
Return values
bool —completePayment()
public
completePayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be completed. False by default.
Tags
Return values
bool —failPayment()
public
failPayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be failed. False by default.
Tags
Return values
bool —holdPayment()
public
holdPayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be on hold. False by default.
Tags
Return values
bool —refundPayment()
public
refundPayment(Payment $payment[, string $log = '' ][, bool $skipCheck = false ]) : bool
Parameters
- $payment : Payment
- $log : string = ''
-
Optional. Custom reason. Not to be confused with the status transition log.
- $skipCheck : bool = false
-
Optional. Skip the check that the payment can be refunded. False by default.