Skip to content

UploadPaymentsApi.md

Latest commit

 

History

History
74 lines (51 loc) · 5.16 KB

UploadPaymentsApi.md

File metadata and controls

74 lines (51 loc) · 5.16 KB

VitexSoftware\Raiffeisenbank\UploadPaymentsApi

All URIs are relative to https://api.rb.cz.

Method HTTP request Description
importPayments() POST /rbcz/premium/api/payments/batches

importPayments()

importPayments( $xRequestId, $batchImportFormat, $requestBody,  $batchName, $batchCombinedPayments, $batchAutocorrect): \VitexSoftware\Raiffeisenbank\Model\ImportPayments200Response

Importing batch payments in one of supported formates - see request parameter Batch-Import-Format. This is an API alternative to the manual import of batch payments through Internet Banking. Imported payments are not immediately processed, they are just loaded into Internet Banking and they still must be authorized/certified in Internet Banking according to client settings of disposable rights and signatures. Once authorized/certified, uploaded payments will be processed in the Instant payments mode if the following conditions are met: 1. the batch has no more than 100 payments 2. no more than 10 batches per day were uploaded 3. individual payments meet the conditions for Instant payments - see Instant Payments 4. on the weekend, only payments within our bank are processed as Instant payments The number of transactions in one request is limited to 15.000 (this can change without prior notice). The limit is not checked during the call, it is performed later and a possible error is provided in Internet Banking.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new VitexSoftware\Raiffeisenbank\Api\UploadPaymentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client()
);
$xRequestId = 'xRequestId_example'; // string | Unique request id provided by consumer application for reference and auditing.
$batchImportFormat = 'batchImportFormat_example'; // string | Format of imported batch. For CCT format please use option SEPA-XML.
$requestBody = 'requestBody_example'; // string
$batchName = 'batchName_example'; // string | 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
$batchCombinedPayments = false; // bool | 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'.
$batchAutocorrect = true; // bool | 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.

try {
    $result = $apiInstance->importPayments( $xRequestId, $batchImportFormat, $requestBody,  $batchName, $batchCombinedPayments, $batchAutocorrect);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadPaymentsApi->importPayments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xRequestId string Unique request id provided by consumer application for reference and auditing.
batchImportFormat string Format of imported batch. For CCT format please use option SEPA-XML.
requestBody string
batchName string 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 bool 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 bool 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]

Return type

\VitexSoftware\Raiffeisenbank\Model\ImportPayments200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: text/plain
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]