Bitrix API

Service implements RestrictableService

Class Service

Table of Contents

Interfaces

RestrictableService

Constants

EVENT_BEFORE_ON_INITIATE_PAY  = 'onSalePsBeforeInitiatePay'
EVENT_INITIATE_PAY_ERROR  = 'onSalePsInitiatePayError'
EVENT_INITIATE_PAY_SUCCESS  = 'onSalePsInitiatePaySuccess'
EVENT_ON_AFTER_PROCESS_REQUEST  = 'OnSaleAfterPsServiceProcessRequest'
EVENT_ON_BEFORE_PAYMENT_PAID  = 'OnSalePsServiceProcessRequestBeforePaid'
PAY_SYSTEM_PREFIX  = 'PAYSYSTEM_'

Methods

__construct()  : mixed
Service constructor.
basketButtonAction()  : mixed
cancel()  : ServiceResult
cancelRecurrent()  : ServiceResult
canPrintCheck()  : bool
canPrintCheckSelf()  : bool
check()  : ServiceResult
confirm()  : ServiceResult
createClone()  : Service
creditNoDemand()  : ServiceResult
debitNoDemand()  : ServiceResult
getCashboxClass()  : string
Returns class name of cashbox for pay system
getClientType()  : string
The type of client that the payment system can work with
getClientTypeFromHandler()  : string
The type of client that the handler can work with
getConsumerName()  : string
getContext()  : Context
getCurrency()  : array<string|int, mixed>
getDemoParams()  : array<string|int, mixed>
getField()  : mixed
getFieldsValues()  : array<string|int, mixed>
getHandlerDescription()  : array<string|int, mixed>
getParamsBusValue()  : array<string|int, mixed>
getPaymentPrice()  : mixed
getPdf()  : mixed
getPdfContent()  : mixed
getPrePaymentProps()  : mixed
getServiceId()  : int
getStartupRestrictions()  : RestrictionInfoCollection
initiatePay()  : ServiceResult
initPrePayment()  : mixed
isAffordDocumentGeneratePdf()  : bool
isAffordPdf()  : bool
isAllowEditPayment()  : bool
isBlockable()  : bool
isCash()  : bool
isCheckable()  : bool
isClone()  : bool
isCustom()  : bool
isFiscalizationAware()  : bool
Returns true if handler extends IFiscalizationAware interface
isFiscalizationEnabled()  : bool
Returns indicator showing if fiscalization is enabled on the payment system side
isPayable()  : bool
isPdfGenerated()  : mixed
isPrePayable()  : bool
isRecurring()  : bool
isRefundable()  : bool
isSupportPrintCheck()  : bool
Returns true if handler extends ISupportPrintCheck interface
isTuned()  : bool
payOrderByPrePayment()  : mixed
processRequest()  : Result
refund()  : ServiceResult|Result
registerCallbackOnGenerate()  : mixed
repeatRecurrent()  : ServiceResult
setOrderDataForPrePayment()  : mixed
setTemplateMode()  : mixed
setTemplateParams()  : mixed
showTemplate()  : ServiceResult

Constants

EVENT_BEFORE_ON_INITIATE_PAY

public mixed EVENT_BEFORE_ON_INITIATE_PAY = 'onSalePsBeforeInitiatePay'

EVENT_INITIATE_PAY_ERROR

public mixed EVENT_INITIATE_PAY_ERROR = 'onSalePsInitiatePayError'

EVENT_INITIATE_PAY_SUCCESS

public mixed EVENT_INITIATE_PAY_SUCCESS = 'onSalePsInitiatePaySuccess'

EVENT_ON_AFTER_PROCESS_REQUEST

public mixed EVENT_ON_AFTER_PROCESS_REQUEST = 'OnSaleAfterPsServiceProcessRequest'

EVENT_ON_BEFORE_PAYMENT_PAID

public mixed EVENT_ON_BEFORE_PAYMENT_PAID = 'OnSalePsServiceProcessRequestBeforePaid'

PAY_SYSTEM_PREFIX

public mixed PAY_SYSTEM_PREFIX = 'PAYSYSTEM_'

Methods

__construct()

Service constructor.

public __construct(mixed $fields) : mixed
Parameters
$fields : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException

basketButtonAction()

public basketButtonAction([array<string|int, mixed> $orderData = array() ]) : mixed
Parameters
$orderData : array<string|int, mixed> = array()
Tags
throws
NotSupportedException

cancelRecurrent()

public cancelRecurrent(Payment $payment[, Request|null $request = null ]) : ServiceResult
Parameters
$payment : Payment
$request : Request|null = null
Return values
ServiceResult

canPrintCheck()

public canPrintCheck() : bool
Return values
bool

canPrintCheckSelf()

public canPrintCheckSelf(Payment $payment) : bool
Parameters
$payment : Payment
Return values
bool

confirm()

public confirm(Payment $payment[, int $sum = 0 ]) : ServiceResult
Parameters
$payment : Payment
$sum : int = 0
Tags
throws
SystemException
Return values
ServiceResult

createClone()

public createClone(SplObjectStorage $cloneEntity) : Service
Parameters
$cloneEntity : SplObjectStorage
Return values
Service

getCashboxClass()

Returns class name of cashbox for pay system

public getCashboxClass() : string
Tags
throws
NotSupportedException
Return values
string

getClientType()

The type of client that the payment system can work with

public getClientType() : string
Return values
string

getClientTypeFromHandler()

The type of client that the handler can work with

public getClientTypeFromHandler() : string
Return values
string

getConsumerName()

public getConsumerName() : string
Return values
string

getCurrency()

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

getDemoParams()

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

getField()

public getField(mixed $name) : mixed
Parameters
$name : mixed

getFieldsValues()

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

getHandlerDescription()

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

getParamsBusValue()

public getParamsBusValue(Payment $payment) : array<string|int, mixed>
Parameters
$payment : Payment
Return values
array<string|int, mixed>

getPaymentPrice()

public getPaymentPrice(Payment $payment) : mixed
Parameters
$payment : Payment

getPdf()

public getPdf(Payment $payment) : mixed
Parameters
$payment : Payment
Tags
throws
NotSupportedException

getPdfContent()

public getPdfContent(Payment $payment) : mixed
Parameters
$payment : Payment
Tags
throws
NotSupportedException

getPrePaymentProps()

public getPrePaymentProps() : mixed
Tags
throws
NotSupportedException

getServiceId()

public getServiceId() : int
Return values
int

initiatePay()

public initiatePay(Payment $payment[, Request|null $request = null ][, int $mode = BaseServiceHandler::STREAM ]) : ServiceResult
Parameters
$payment : Payment
$request : Request|null = null
$mode : int = BaseServiceHandler::STREAM
Return values
ServiceResult

initPrePayment()

public initPrePayment([Payment|null $payment = null ], Request $request) : mixed
Parameters
$payment : Payment|null = null
$request : Request
Tags
throws
NotSupportedException

isAffordDocumentGeneratePdf()

public isAffordDocumentGeneratePdf() : bool
Return values
bool

isAffordPdf()

public isAffordPdf() : bool
Return values
bool

isAllowEditPayment()

public isAllowEditPayment() : bool
Return values
bool

isBlockable()

public isBlockable() : bool
Return values
bool

isCash()

public isCash() : bool
Return values
bool

isCheckable()

public isCheckable() : bool
Return values
bool

isClone()

public isClone() : bool
Return values
bool

isCustom()

public isCustom() : bool
Return values
bool

isFiscalizationAware()

Returns true if handler extends IFiscalizationAware interface

public isFiscalizationAware() : bool
Return values
bool

isFiscalizationEnabled()

Returns indicator showing if fiscalization is enabled on the payment system side

public isFiscalizationEnabled(Payment $payment) : bool
Parameters
$payment : Payment
Tags
throws
NotSupportedException
Return values
bool

isPayable()

public isPayable() : bool
Return values
bool

isPdfGenerated()

public isPdfGenerated(Payment $payment) : mixed
Parameters
$payment : Payment
Tags
throws
NotSupportedException

isPrePayable()

public isPrePayable() : bool
Return values
bool

isRecurring()

public isRecurring(Payment $payment) : bool
Parameters
$payment : Payment
Return values
bool

isRefundable()

public isRefundable() : bool
Return values
bool

isSupportPrintCheck()

Returns true if handler extends ISupportPrintCheck interface

public isSupportPrintCheck() : bool
Return values
bool

isTuned()

public isTuned() : bool
Return values
bool

payOrderByPrePayment()

public payOrderByPrePayment(mixed $orderData) : mixed
Parameters
$orderData : mixed
Tags
throws
NotSupportedException

processRequest()

public processRequest(Request $request) : Result
Parameters
$request : Request
Tags
throws
NotSupportedException
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
ObjectException
throws
ObjectNotFoundException
Return values
Result

refund()

public refund(Payment $payment[, int $refundableSum = 0 ]) : ServiceResult|Result
Parameters
$payment : Payment
$refundableSum : int = 0
Tags
throws
SystemException
throws
ArgumentOutOfRangeException
Return values
ServiceResult|Result

registerCallbackOnGenerate()

public registerCallbackOnGenerate(Payment $payment, mixed $params) : mixed
Parameters
$payment : Payment
$params : mixed
Tags
throws
NotSupportedException

repeatRecurrent()

public repeatRecurrent(Payment $payment[, Request|null $request = null ]) : ServiceResult
Parameters
$payment : Payment
$request : Request|null = null
Return values
ServiceResult

setOrderDataForPrePayment()

public setOrderDataForPrePayment([array<string|int, mixed> $orderData = array() ]) : mixed
Parameters
$orderData : array<string|int, mixed> = array()
Tags
throws
NotSupportedException

setTemplateMode()

public setTemplateMode(mixed $mode) : mixed
Parameters
$mode : mixed

setTemplateParams()

public setTemplateParams(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

showTemplate()

public showTemplate([Payment|null $payment = null ], mixed $templateName) : ServiceResult
Parameters
$payment : Payment|null = null
$templateName : mixed
Return values
ServiceResult 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results