ExpressSmsGatewayInterface
extends
PaymentGatewayInterface
in
A premium SMS gateway that can receive SMS on one fixed address (`api/system/payment/express-execute`).
Table of Contents
Methods
- allowRedirect() : bool
- checkDelivery() : GatewayCheckResult
- checkPayment() : GatewayCheckResult
- createPayment() : GatewayCreateResult
- getExpressKeyword() : string
- Keyword of this web on the aggregator account (first word(s) of every SMS).
- getScriptName() : string
- loadPayment() : Payment|null
- loadPaymentFromDelivery() : Payment|null
- sendDeliveryResponse() : void
- verifyNotificationOrigin() : string|null
- Proof that the request comes from the aggregator (shared secret, optional IP allowlist).
Methods
allowRedirect()
public
allowRedirect() : bool
Return values
boolcheckDelivery()
public
checkDelivery(Payment $payment, PaymentGate $paymentGate, array<string, mixed> $params) : GatewayCheckResult
Parameters
- $payment : Payment
- $paymentGate : PaymentGate
- $params : array<string, mixed>
Return values
GatewayCheckResultcheckPayment()
public
checkPayment(Payment $payment, PaymentGate $paymentGate, array<string, mixed> $params) : GatewayCheckResult
Parameters
- $payment : Payment
- $paymentGate : PaymentGate
- $params : array<string, mixed>
Return values
GatewayCheckResultcreatePayment()
public
createPayment(Payment $payment, PaymentGate $paymentGate, array{notifyUrl: string, successUrl: string, cancelUrl: string} $urls) : GatewayCreateResult
Parameters
- $payment : Payment
- $paymentGate : PaymentGate
- $urls : array{notifyUrl: string, successUrl: string, cancelUrl: string}
Return values
GatewayCreateResultgetExpressKeyword()
Keyword of this web on the aggregator account (first word(s) of every SMS).
public
getExpressKeyword(PaymentGate $paymentGate) : string
Parameters
- $paymentGate : PaymentGate
Return values
stringgetScriptName()
public
getScriptName() : string
Return values
stringloadPayment()
public
loadPayment(PaymentGate $paymentGate, array<string, mixed> $params) : Payment|null
Parameters
- $paymentGate : PaymentGate
- $params : array<string, mixed>
Return values
Payment|nullloadPaymentFromDelivery()
public
loadPaymentFromDelivery(PaymentGate $paymentGate, array<string, mixed> $params) : Payment|null
Parameters
- $paymentGate : PaymentGate
- $params : array<string, mixed>
Return values
Payment|nullsendDeliveryResponse()
public
sendDeliveryResponse() : void
verifyNotificationOrigin()
Proof that the request comes from the aggregator (shared secret, optional IP allowlist).
public
verifyNotificationOrigin(PaymentGate $paymentGate, array<string, mixed> $params) : string|null
Null = OK, otherwise the reason of rejection. Fail-closed without a configured secret.
Parameters
- $paymentGate : PaymentGate
- $params : array<string, mixed>