WHMCS\Billing\Payment\Transaction

Class · extends AbstractModel

A payment transaction.

A Transaction tracks a payment or refund made to a Client via a specific Invoice.

If the Transaction is a payment by a client toward an invoice, the value of the transaction will be stored in "amountIn."

If the Transaction is a payment by the operator of this WHMCS install to a Client by way of a Refund, the value of the transaction is stored in "amountOut."

• ModelRelationBillingNote

public function client()

A transaction can belong to a client.

Returns \Illuminate\Database\Eloquent\Relations\BelongsTo

public function invoice()

A transaction can belong to an invoice.

Returns \Illuminate\Database\Eloquent\Relations\BelongsTo

public function refunds(): HasMany

public function originalTransaction(): BelongsTo

public function scopeLookup($query, $gateway, $transactionId)

Perform a transaction lookup for a given gateway and transaction ID.

Parameters

Returns \Illuminate\Database\Eloquent\Builder

public function scopeNotBillingNotes($query)

Parameters

Returns \Illuminate\Database\Eloquent\Builder

public function gateway(): ?Gateway

Load the transaction's gateway module, if known to the transaction.

Returns Gateway\|null

public function gatewaySafe(): ?Gateway

Load the transaction's gateway module in a fail-silent manner.

Returns Gateway\|null

public function gatewaySupports(string $feature): bool

Determine if this transaction's gateway supports the requested feature. False will be returned for a failing or inactive gateway.

Parameters

Returns bool

public function gatewayCallIfSupports($default, string $feature, array $params = [])

Call and return the result of the specified gateway feature of this transaction's gateway, if the gateway and the feature is available; otherwise return the $default value.

Parameters

Returns mixed

public function getFormattedTransactionIdAttribute()

Retrieve the transaction after formatting.

Returns string\|null

public function isBillingNoteReference(): bool

public function isCreditNoteReference(): bool

public function isDebitNoteReference(): bool

public function isInvoiceReference(): bool

public function getReferenceIdMarkup(): string

public function getTransactionIdMarkup(): string

Returns string — Return the transaction ID including possible markup for consistent decoration.

public function getBillingNoteLink(): string

public function getLink(): string

public static function isUnique($gateway, $transactionId): bool

Parameters

Returns bool

public static function assertUnique($gateway, $transactionId): void

Parameters

public function getRefundsAttribute(): Collection

public function refundToClientCredit(?float $partialAmount = null, ?float $partialFees = null): ?Transaction

public function getTypeAttribute(): LedgerType