Documentation

UploadPaymentsApi
in package

UploadPaymentsApi Class Doc Comment.

Tags
category

Class

author

OpenAPI Generator team

see
https://openapi-generator.tech

Table of Contents

contentTypes  = ['importPayments' => ['text/plain']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
$mockMode  : bool
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|GetBalance401Response|GetBalance403Response|GetBalance429Response|ImportPayments400Response|ImportPayments413Response|ImportPayments415Response
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()  : self
Set the host index.
setMockMode()  : self
setSUIPAddress()  : self
setXIBMClientId()  : self
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

$mockMode

Use the /rbcz/premium/mock/* path for endpoints ?

protected bool $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 = ''

Description

$xIBMClientId

ClientID obtained from Developer Portal - when you registered your app with us.

protected string $xIBMClientId = ''

Methods

__construct()

public __construct([ClientInterface|null $client = null ][, Configuration|null $config = null ][, HeaderSelector|null $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface|null = null
$config : Configuration|null = null
$selector : HeaderSelector|null = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

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[, null|string $batchName = null ][, null|bool $batchCombinedPayments = false ][, null|bool $batchAutocorrect = true ][, string $contentType = self::contentTypes['importPayments'][0] ]) : object|GetBalance401Response|GetBalance403Response|GetBalance429Response|ImportPayments400Response|ImportPayments413Response|ImportPayments415Response
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 : null|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)

$batchCombinedPayments : null|bool = false

Optional header for combined payments. Payments inside the import file are considered as combined in case the header is present and its value is set to 'true'. (optional, default to false)

$batchAutocorrect : null|bool = true

Flag if valueDate should be autocorrected in the imported file or not. Autocorrection moved valueDate on first available valid (working) day. Beware that this may affect if the payment will be sent as instant or not since only payments with valueDate same as actual date (during sending of payment to bank) can be sent as instant. (optional, default to true)

$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
throws
InvalidArgumentException
throws
ApiException

on non-2xx response or if the response body is not in the expected format

Return values
object|GetBalance401Response|GetBalance403Response|GetBalance429Response|ImportPayments400Response|ImportPayments413Response|ImportPayments415Response

importPaymentsAsync()

Operation importPaymentsAsync.

public importPaymentsAsync(string $xRequestId, string $batchImportFormat, string $requestBody[, null|string $batchName = null ][, null|bool $batchCombinedPayments = false ][, null|bool $batchAutocorrect = true ][, 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 : null|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)

$batchCombinedPayments : null|bool = false

Optional header for combined payments. Payments inside the import file are considered as combined in case the header is present and its value is set to 'true'. (optional, default to false)

$batchAutocorrect : null|bool = true

Flag if valueDate should be autocorrected in the imported file or not. Autocorrection moved valueDate on first available valid (working) day. Beware that this may affect if the payment will be sent as instant or not since only payments with valueDate same as actual date (during sending of payment to bank) can be sent as instant. (optional, default to true)

$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
throws
InvalidArgumentException
Return values
PromiseInterface

importPaymentsAsyncWithHttpInfo()

Operation importPaymentsAsyncWithHttpInfo.

public importPaymentsAsyncWithHttpInfo(string $xRequestId, string $batchImportFormat, string $requestBody[, null|string $batchName = null ][, null|bool $batchCombinedPayments = false ][, null|bool $batchAutocorrect = true ][, 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 : null|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)

$batchCombinedPayments : null|bool = false

Optional header for combined payments. Payments inside the import file are considered as combined in case the header is present and its value is set to 'true'. (optional, default to false)

$batchAutocorrect : null|bool = true

Flag if valueDate should be autocorrected in the imported file or not. Autocorrection moved valueDate on first available valid (working) day. Beware that this may affect if the payment will be sent as instant or not since only payments with valueDate same as actual date (during sending of payment to bank) can be sent as instant. (optional, default to true)

$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
throws
InvalidArgumentException
Return values
PromiseInterface

importPaymentsRequest()

Create request for operation 'importPayments'.

public importPaymentsRequest(string $xRequestId, string $batchImportFormat, string $requestBody[, null|string $batchName = null ][, null|bool $batchCombinedPayments = false ][, null|bool $batchAutocorrect = true ][, 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 : null|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)

$batchCombinedPayments : null|bool = false

Optional header for combined payments. Payments inside the import file are considered as combined in case the header is present and its value is set to 'true'. (optional, default to false)

$batchAutocorrect : null|bool = true

Flag if valueDate should be autocorrected in the imported file or not. Autocorrection moved valueDate on first available valid (working) day. Beware that this may affect if the payment will be sent as instant or not since only payments with valueDate same as actual date (during sending of payment to bank) can be sent as instant. (optional, default to true)

$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
throws
InvalidArgumentException
Return values
Request

importPaymentsWithHttpInfo()

Operation importPaymentsWithHttpInfo.

public importPaymentsWithHttpInfo(string $xRequestId, string $batchImportFormat, string $requestBody[, null|string $batchName = null ][, null|bool $batchCombinedPayments = false ][, null|bool $batchAutocorrect = true ][, 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 : null|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)

$batchCombinedPayments : null|bool = false

Optional header for combined payments. Payments inside the import file are considered as combined in case the header is present and its value is set to 'true'. (optional, default to false)

$batchAutocorrect : null|bool = true

Flag if valueDate should be autocorrected in the imported file or not. Autocorrection moved valueDate on first available valid (working) day. Beware that this may affect if the payment will be sent as instant or not since only payments with valueDate same as actual date (during sending of payment to bank) can be sent as instant. (optional, default to true)

$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
throws
InvalidArgumentException
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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) : self
Parameters
$hostIndex : int

Host index (required)

Return values
self

setMockMode()

public setMockMode(bool $mocking) : self
Parameters
$mocking : bool

Use mocking api for development purposes ?

Return values
self

setSUIPAddress()

public setSUIPAddress(string $SUIPAddress) : self
Parameters
$SUIPAddress : string

IP address of a client

Return values
self

setXIBMClientId()

Keep ClientID obtained from Developer Portal.

public setXIBMClientId(string $clientId) : self
Parameters
$clientId : string

Description

Return values
self

createHttpClientOption()

Create http client option.

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results