Skip to content

Latest commit

 

History

History
285 lines (203 loc) · 18.2 KB

API.md

File metadata and controls

285 lines (203 loc) · 18.2 KB
Raw

Table of contents

Class: \VenelinIliev\Borica3ds\SaleResponse

Class Sale

Visibility Function
public getResponseCode() : string
Get response code - value of 'RC' field
public isSuccessful() : boolean
Is success payment?

This class extends \VenelinIliev\Borica3ds\Response

This class implements \VenelinIliev\Borica3ds\ResponseInterface

Class: \VenelinIliev\Borica3ds\Request (abstract)

Borica request

Visibility Function
public getAmount() : float/null
Get amount
public getBackRefUrl() : string
Get back ref url
public getCurrency() : string
Get currency
public getDescription() : mixed
Get description
public getNonce() : string
public getOrder() : mixed
Get order
public getSignatureTimestamp() : string
Get signature timestamp
public getTransactionType() : \VenelinIliev\Borica3ds\Enums\TransactionType
Get transaction type
public setAmount(string/float/integer $amount) : \VenelinIliev\Borica3ds\Request
Set amount
public setBackRefUrl(string $backRefUrl) : \VenelinIliev\Borica3ds\Request
Set back ref url
public setCurrency(string $currency) : \VenelinIliev\Borica3ds\Request
Set currency
public setDescription(string $description) : \VenelinIliev\Borica3ds\Request
Set description
public setNonce(string $nonce) : \VenelinIliev\Borica3ds\Request
public setOrder(mixed $order) : \VenelinIliev\Borica3ds\Request
Set order
public setSignatureTimestamp(string/null $signatureTimestamp=null) : \VenelinIliev\Borica3ds\Request
Set signature timestamp
public setTransactionType(\VenelinIliev\Borica3ds\Enums\TransactionType $transactionType) : \VenelinIliev\Borica3ds\Request
Set transaction type

This class extends \VenelinIliev\Borica3ds\Base

Class: \VenelinIliev\Borica3ds\ReversalRequest

Visibility Function
public __construct() : void
StatusCheckRequest constructor.
public generateForm() : array
public generateSignature() : string
public getData() : array
public getIntRef() : string
public getMerchantName() : string
public getRrn() : string
public send() : \VenelinIliev\Borica3ds\ReversalResponse
Send data to borica
public setIntRef(string $intRef) : \VenelinIliev\Borica3ds\ReversalRequest
Set transaction internal reference.
public setMerchantName(string $merchantName) : \VenelinIliev\Borica3ds\ReversalRequest
public setRrn(string $rrn) : \VenelinIliev\Borica3ds\ReversalRequest
Set transaction reference.
public validateRequiredParameters() : void

This class extends \VenelinIliev\Borica3ds\Request

This class implements \VenelinIliev\Borica3ds\RequestInterface

Class: \VenelinIliev\Borica3ds\Base (abstract)

Borica base

Visibility Function
public getEnvironmentUrl() : string
public getMerchantId() : mixed
Get merchant ID
public getPrivateKey() : string
Get private key
public getPrivateKeyPassword() : string/null
Get private key password
public getPublicKey() : string
Get public key
public getTerminalID() : mixed
Get terminal ID
public inDevelopment() : \VenelinIliev\Borica3ds\Base
Switch to development mode
public inProduction() : \VenelinIliev\Borica3ds\Base
Switch to production mode
public isDevelopment() : boolean
public isProduction() : boolean
public setEnvironment(bool/boolean $production=true) : \VenelinIliev\Borica3ds\Base
Switch environment to development/production
public setMerchantId(mixed $merchantId) : \VenelinIliev\Borica3ds\Base
Set merchant ID
public setPrivateKey(string $privateKeyPath, string/null $password=null) : \VenelinIliev\Borica3ds\Base
Set private key
public setPrivateKeyPassword(string/null $privateKeyPassword) : \VenelinIliev\Borica3ds\Base
Set private key password
public setPublicKey(string $publicKey) : \VenelinIliev\Borica3ds\Base
Set public key
public setSigningSchemaMacAdvanced() : \VenelinIliev\Borica3ds\Base
Switch signing schema to MAC_ADVANCED
public setSigningSchemaMacExtended() : \VenelinIliev\Borica3ds\Base
Switch signing schema to MAC_EXTENDED
public setTerminalID(string $terminalID) : \VenelinIliev\Borica3ds\Base
Set terminal ID
protected getPrivateSignature(array $data) : string
Generate signature of data with private key
protected getSignatureSource(array $data, bool/boolean $isResponse=false) : string
Generate signature source
protected isSigningSchemaMacAdvanced() : boolean
Is MAC_ADVANCE signing schema?

Class: \VenelinIliev\Borica3ds\StatusCheckResponse

Visibility Function

This class extends \VenelinIliev\Borica3ds\Response

This class implements \VenelinIliev\Borica3ds\ResponseInterface

Class: \VenelinIliev\Borica3ds\Response (abstract)

Visibility Function
public getResponseData(bool/boolean $verify=true) : array
Get response data
public getVerifiedData(string $key) : mixed
Get verified data by key
public setResponseData(array $responseData) : \VenelinIliev\Borica3ds\Response
Set response data
protected getVerifyingFields() : string[]
protected verifyData() : void
Verify data with public certificate
protected verifyPublicSignature(array $data, string $publicSignature) : void
Verify data with public certificate

This class extends \VenelinIliev\Borica3ds\Base

Class: \VenelinIliev\Borica3ds\StatusCheckRequest

Visibility Function
public __construct() : void
StatusCheckRequest constructor.
public generateForm() : mixed/void
public generateSignature() : string
public getData() : array
public getOriginalTransactionType() : \VenelinIliev\Borica3ds\Enums\TransactionType
public send() : \VenelinIliev\Borica3ds\StatusCheckResponse
Send data to borica
public setOriginalTransactionType(\VenelinIliev\Borica3ds\Enums\TransactionType $tranType) : \VenelinIliev\Borica3ds\StatusCheckRequest
Set original transaction type
public validateRequiredParameters() : void

This class extends \VenelinIliev\Borica3ds\Request

This class implements \VenelinIliev\Borica3ds\RequestInterface

Class: \VenelinIliev\Borica3ds\SaleRequest

Class Sale

Visibility Function
public __construct() : void
Sale constructor.
public generateForm() : string
Generate HTML hidden form
public generateSignature() : string
Generate signature of data
public getAdCustBorOrderId() : string
Get 'AD.CUST_BOR_ORDER_ID' field
public getCountryCode() : string
Get country code
public getData() : array
Get data required for request to borica
public getEmailAddress() : string
Get notification email address
public getMerchantGMT() : string/null
Get merchant GMT
public getMerchantName() : string
public getMerchantUrl() : string
Get merchant URL
public send() : void
Send to borica. Generate form and auto submit with JS.
public setAdCustBorOrderId(string $adCustBorOrderId) : \VenelinIliev\Borica3ds\SaleRequest
Set 'AD.CUST_BOR_ORDER_ID' field
public setCountryCode(string $countryCode) : \VenelinIliev\Borica3ds\SaleRequest
Set country code
public setEmailAddress(string $emailAddress) : \VenelinIliev\Borica3ds\SaleRequest
Set notification email address
public setMerchantGMT(string $merchantGMT) : \VenelinIliev\Borica3ds\SaleRequest
Set merchant GMT
public setMerchantName(string $merchantName) : \VenelinIliev\Borica3ds\SaleRequest
public setMerchantUrl(string $merchantUrl) : \VenelinIliev\Borica3ds\SaleRequest
Set merchant URL
public validateRequiredParameters() : void
Validate required fields to post

This class extends \VenelinIliev\Borica3ds\Request

This class implements \VenelinIliev\Borica3ds\RequestInterface

Class: \VenelinIliev\Borica3ds\ReversalResponse

Class ReversalResponse

Visibility Function

This class extends \VenelinIliev\Borica3ds\Response

This class implements \VenelinIliev\Borica3ds\ResponseInterface

Interface: \VenelinIliev\Borica3ds\ResponseInterface

Interface ResponseInterface

Visibility Function
public getResponseData() : array
public getVerifiedData(string $key) : mixed

Interface: \VenelinIliev\Borica3ds\RequestInterface

Interface RequestInterface

Visibility Function
public generateForm() : mixed
Generate hidden html form without submit
public generateSignature() : string
Sign request
public getData() : array
Get data with post inputs
public send() : void/\VenelinIliev\Borica3ds\Response
Generate html form and send request with js
public validateRequiredParameters() : void
Validate required data before sending

Class: \VenelinIliev\Borica3ds\Enums\TransactionType

Class TransactionType

Visibility Function

This class extends \MyCLabs\Enum\Enum

This class implements \JsonSerializable

Class: \VenelinIliev\Borica3ds\Exceptions\SendingException

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \VenelinIliev\Borica3ds\Exceptions\DataMissingException

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \VenelinIliev\Borica3ds\Exceptions\ParameterValidationException

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \VenelinIliev\Borica3ds\Exceptions\SignatureException

Visibility Function

This class extends \Exception

This class implements \Throwable