Transactor
extends ApiClient
in package
Handle bank transactions.
Tags
Table of Contents
Properties
- $mockMode : bool
- Use mocking for api calls ?
- $pSUIPAddress : string
- the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser.
- $xIBMClientId : string
- ClientID obtained from Developer Portal - when you registered your app with us.
Methods
- __construct() : mixed
- Transaction Handler.
- checkCertificate() : bool
- checkCertificatePassword() : bool
- checkCertificatePresence() : bool
- Try to check certificate readibilty.
- getMockMode() : bool
- Use mocking uri for api calls ?
- getpSUIPAddress() : string
- Keep user public IP here.
- getPublicIP() : string
- Obtain Your current Public IP.
- getTransactions() : array<string|int, mixed>
- Obtain Transactions from RB.
- getXIBMClientId() : string
- ClientID obtained from Developer Portal.
- getxRequestId() : string
- Request Identifier.
- import() : void
- Import process itself.
- setScope() : void
- Prepare processing interval.
- sourceString() : string
- Source Identifier.
- takeTransactionData() : void
- Use Transaction data for Bank record.
Properties
$mockMode
Use mocking for api calls ?
protected
bool
$mockMode
= false
$pSUIPAddress
the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser.
protected
string
$pSUIPAddress
= ''
Always provide the closest IP address to the real end-user possible. (optional).
$xIBMClientId
ClientID obtained from Developer Portal - when you registered your app with us.
protected
string
$xIBMClientId
= ''
Methods
__construct()
Transaction Handler.
public
__construct(string $bankAccount[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $bankAccount : string
- $options : array<string|int, mixed> = []
checkCertificate()
public
static checkCertificate(mixed $certFile, mixed $password) : bool
Parameters
- $certFile : mixed
- $password : mixed
Return values
boolcheckCertificatePassword()
public
static checkCertificatePassword(string $certFile, string $password) : bool
Parameters
- $certFile : string
- $password : string
Return values
boolcheckCertificatePresence()
Try to check certificate readibilty.
public
static checkCertificatePresence(string $certFile[, bool $die = false ]) : bool
Parameters
- $certFile : string
-
path to certificate
- $die : bool = false
-
throw exception or return false ?
Tags
Return values
bool —certificate file
getMockMode()
Use mocking uri for api calls ?
public
getMockMode() : bool
Return values
boolgetpSUIPAddress()
Keep user public IP here.
public
getpSUIPAddress() : string
Return values
stringgetPublicIP()
Obtain Your current Public IP.
public
static getPublicIP() : string
since version 0.1 - Do not use in production Environment!
Return values
stringgetTransactions()
Obtain Transactions from RB.
public
getTransactions() : array<string|int, mixed>
Return values
array<string|int, mixed>getXIBMClientId()
ClientID obtained from Developer Portal.
public
getXIBMClientId() : string
Return values
stringgetxRequestId()
Request Identifier.
public
static getxRequestId() : string
since version 0.1 - Do not use in production Environment!
Return values
stringimport()
Import process itself.
public
import() : void
setScope()
Prepare processing interval.
public
setScope(string $scope) : void
Parameters
- $scope : string
Tags
sourceString()
Source Identifier.
public
static sourceString() : string
since version 0.1 - Do not use in production Environment!
Return values
stringtakeTransactionData()
Use Transaction data for Bank record.
public
takeTransactionData(array<string|int, mixed> $transactionData) : void
Parameters
- $transactionData : array<string|int, mixed>