Documentation

PaymentGateway

Payment gateway interface class Every payment gateway has to implements this interface.

Table of Contents

__construct()  : mixed
Construct.
fetchTransactionInternalStatus()  : string
Returns mapped CRM status name for given transaction id.
getConfigFields()  : array<string|int, mixed>
Returns configuration fields used by this gateway.
getGatewayName()  : string
Returns gateway name visible in settings module.
getName()  : string
Returns gateway name.
getPaymentSystemName()  : string
Returns CRM payment_system name.
getStatusesNames()  : array<string|int, mixed>
Returns all CRM statuses names that are used by this gateway.
getUpdatableStatusesNames()  : array<string|int, mixed>
Returns CRM paymentsIn statuses names which points to payment that can receive status update.
initialize()  : void
Initialize gateway.

Methods

__construct()

Construct.

public __construct(array<string|int, mixed> $config, Payments $payments) : mixed
Parameters
$config : array<string|int, mixed>
$payments : Payments
Return values
mixed

fetchTransactionInternalStatus()

Returns mapped CRM status name for given transaction id.

public fetchTransactionInternalStatus(string $transactionId) : string
Parameters
$transactionId : string
Return values
string

getConfigFields()

Returns configuration fields used by this gateway.

public static getConfigFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGatewayName()

Returns gateway name visible in settings module.

public static getGatewayName() : string
Return values
string

getName()

Returns gateway name.

public getName() : string
Return values
string

getPaymentSystemName()

Returns CRM payment_system name.

public getPaymentSystemName() : string
Return values
string

getStatusesNames()

Returns all CRM statuses names that are used by this gateway.

public getStatusesNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUpdatableStatusesNames()

Returns CRM paymentsIn statuses names which points to payment that can receive status update.

public getUpdatableStatusesNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

initialize()

Initialize gateway.

public initialize() : void
Return values
void

        

Search results