UploadPaymentsApi
in package
UploadPaymentsApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['importPayments' => ['text/plain']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- $mockMode : mixed
- Use the /rbcz/premium/mock/* path for endpoints ?
- $SUIPAddress : 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. Always provide the closest IP address to the real end-user possible. (optional)
- $xIBMClientId : string
- ClientID obtained from Developer Portal - when you registered your app with us.
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getXIBMClientId() : string
- Give you ClientID obtained from Developer Portal
- importPayments() : object|ImportPayments400Response|GetBalance401Response|GetBalance403Response|ImportPayments413Response|ImportPayments415Response|GetBalance429Response
- Operation importPayments
- importPaymentsAsync() : PromiseInterface
- Operation importPaymentsAsync
- importPaymentsAsyncWithHttpInfo() : PromiseInterface
- Operation importPaymentsAsyncWithHttpInfo
- importPaymentsRequest() : Request
- Create request for operation 'importPayments'
- importPaymentsWithHttpInfo() : array<string|int, mixed>
- Operation importPaymentsWithHttpInfo
- setHostIndex() : void
- Set the host index
- setMockMode() : mixed
- setSUIPAddress() : mixed
- setXIBMClientId() : string
- Keep ClientID obtained from Developer Portal
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['importPayments' => ['text/plain']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
$mockMode
Use the /rbcz/premium/mock/* path for endpoints ?
protected
mixed
$mockMode
= false
$SUIPAddress
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. Always provide the closest IP address to the real end-user possible. (optional)
protected
string
$SUIPAddress
= null
Description
$xIBMClientId
ClientID obtained from Developer Portal - when you registered your app with us.
protected
string
$xIBMClientId
= null
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getXIBMClientId()
Give you ClientID obtained from Developer Portal
public
getXIBMClientId() : string
Return values
string —importPayments()
Operation importPayments
public
importPayments(string $xRequestId, string $batchImportFormat, string $requestBody[, string $batchName = null ][, string $contentType = self::contentTypes['importPayments'][0] ]) : object|ImportPayments400Response|GetBalance401Response|GetBalance403Response|ImportPayments413Response|ImportPayments415Response|GetBalance429Response
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $batchImportFormat : string
-
Format of imported batch. For CCT format please use option SEPA-XML. (required)
- $requestBody : string
-
requestBody (required)
- $batchName : string = null
-
Batch name, if not present then will be generated in format `ImportApi_<DDMMYYYY>`. If the name is longer than 50 characters, it will be truncated (optional)
- $contentType : string = self::contentTypes['importPayments'][0]
-
The value for the Content-Type header. Check self::contentTypes['importPayments'] to see the possible values for this operation
Tags
Return values
object|ImportPayments400Response|GetBalance401Response|GetBalance403Response|ImportPayments413Response|ImportPayments415Response|GetBalance429Response —importPaymentsAsync()
Operation importPaymentsAsync
public
importPaymentsAsync(string $xRequestId, string $batchImportFormat, string $requestBody[, string $batchName = null ][, string $contentType = self::contentTypes['importPayments'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $batchImportFormat : string
-
Format of imported batch. For CCT format please use option SEPA-XML. (required)
- $requestBody : string
-
(required)
- $batchName : string = null
-
Batch name, if not present then will be generated in format `ImportApi_<DDMMYYYY>`. If the name is longer than 50 characters, it will be truncated (optional)
- $contentType : string = self::contentTypes['importPayments'][0]
-
The value for the Content-Type header. Check self::contentTypes['importPayments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —importPaymentsAsyncWithHttpInfo()
Operation importPaymentsAsyncWithHttpInfo
public
importPaymentsAsyncWithHttpInfo(string $xRequestId, string $batchImportFormat, string $requestBody[, string $batchName = null ][, string $contentType = self::contentTypes['importPayments'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $batchImportFormat : string
-
Format of imported batch. For CCT format please use option SEPA-XML. (required)
- $requestBody : string
-
(required)
- $batchName : string = null
-
Batch name, if not present then will be generated in format `ImportApi_<DDMMYYYY>`. If the name is longer than 50 characters, it will be truncated (optional)
- $contentType : string = self::contentTypes['importPayments'][0]
-
The value for the Content-Type header. Check self::contentTypes['importPayments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —importPaymentsRequest()
Create request for operation 'importPayments'
public
importPaymentsRequest(string $xRequestId, string $batchImportFormat, string $requestBody[, string $batchName = null ][, string $contentType = self::contentTypes['importPayments'][0] ]) : Request
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $batchImportFormat : string
-
Format of imported batch. For CCT format please use option SEPA-XML. (required)
- $requestBody : string
-
(required)
- $batchName : string = null
-
Batch name, if not present then will be generated in format `ImportApi_<DDMMYYYY>`. If the name is longer than 50 characters, it will be truncated (optional)
- $contentType : string = self::contentTypes['importPayments'][0]
-
The value for the Content-Type header. Check self::contentTypes['importPayments'] to see the possible values for this operation
Tags
Return values
Request —importPaymentsWithHttpInfo()
Operation importPaymentsWithHttpInfo
public
importPaymentsWithHttpInfo(string $xRequestId, string $batchImportFormat, string $requestBody[, string $batchName = null ][, string $contentType = self::contentTypes['importPayments'][0] ]) : array<string|int, mixed>
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $batchImportFormat : string
-
Format of imported batch. For CCT format please use option SEPA-XML. (required)
- $requestBody : string
-
(required)
- $batchName : string = null
-
Batch name, if not present then will be generated in format `ImportApi_<DDMMYYYY>`. If the name is longer than 50 characters, it will be truncated (optional)
- $contentType : string = self::contentTypes['importPayments'][0]
-
The value for the Content-Type header. Check self::contentTypes['importPayments'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of object|\VitexSoftware\Raiffeisenbank\Model\ImportPayments400Response|\VitexSoftware\Raiffeisenbank\Model\GetBalance401Response|\VitexSoftware\Raiffeisenbank\Model\GetBalance403Response|\VitexSoftware\Raiffeisenbank\Model\ImportPayments413Response|\VitexSoftware\Raiffeisenbank\Model\ImportPayments415Response|\VitexSoftware\Raiffeisenbank\Model\GetBalance429Response|\VitexSoftware\Raiffeisenbank\Model\ImportPayments415Response, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —setMockMode()
public
setMockMode(bool $mocking) : mixed
Parameters
- $mocking : bool
-
Use mocking api for development purposes ?
Return values
mixed —setSUIPAddress()
public
setSUIPAddress(string $SUIPAddress) : mixed
Parameters
- $SUIPAddress : string
-
IP address of a client
Return values
mixed —setXIBMClientId()
Keep ClientID obtained from Developer Portal
public
setXIBMClientId(string $clientId) : string
Parameters
- $clientId : string
-
Description
Return values
string —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options