OpenAPI\Client\TPPCertificatesApi

All URIs are relative to https://sandbox.finapi.io, except if the operation defines another base path.

Method	HTTP request	Description
createNewCertificate()	POST /api/v2/tppCertificates	Upload TPP certificate
deleteCertificate()	DELETE /api/v2/tppCertificates/{id}	Delete a TPP certificate
getAllCertificates()	GET /api/v2/tppCertificates	Get all TPP certificates
getCertificate()	GET /api/v2/tppCertificates/{id}	Get a TPP certificate

`createNewCertificate()`

createNewCertificate($tpp_certificate_params, $x_request_id): \OpenAPI\Client\Model\TppCertificate

Upload TPP certificate

Upload a new TPP certificate. Must pass the mandator admin client's access_token. QWAC certificate is used to verify your identity by the bank during the TLS handshake.
QsealC certificate is used to sign the requests to the bank.

Example

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


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TPPCertificatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tpp_certificate_params = new \OpenAPI\Client\Model\TppCertificateParams(); // \OpenAPI\Client\Model\TppCertificateParams | Create new TPP certificate parameters
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->createNewCertificate($tpp_certificate_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TPPCertificatesApi->createNewCertificate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tpp_certificate_params	\OpenAPI\Client\Model\TppCertificateParams	Create new TPP certificate parameters
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\TppCertificate

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`deleteCertificate()`

deleteCertificate($id, $x_http_method_override, $x_request_id)

Delete a TPP certificate

Delete a single TPP certificate by its id. Must pass the mandator admin client's access_token.

Example

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


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TPPCertificatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Id of the TPP certificate to delete
$x_http_method_override = 'x_http_method_override_example'; // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this  header set will be treated either as PATCH or DELETE by the finAPI servers.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $apiInstance->deleteCertificate($id, $x_http_method_override, $x_request_id);
} catch (Exception $e) {
    echo 'Exception when calling TPPCertificatesApi->deleteCertificate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Id of the TPP certificate to delete
x_http_method_override	string	Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers.	[optional]
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

void (empty response body)

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getAllCertificates()`

getAllCertificates($page, $per_page, $order, $x_request_id): \OpenAPI\Client\Model\PageableTppCertificateList

Get all TPP certificates

Returns all TPP certificates that you have uploaded via 'Upload TPP certificate' service. Must pass the mandator admin client's access_token.

Example

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


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TPPCertificatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Result page that you want to retrieve
$per_page = 20; // int | Maximum number of records per page. By default it's 20.
$order = array('order_example'); // string[] | Determines the order of the results. You can order the results by 'label'. The default order for this service is 'label,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->getAllCertificates($page, $per_page, $order, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TPPCertificatesApi->getAllCertificates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Result page that you want to retrieve	[optional] [default to 1]
per_page	int	Maximum number of records per page. By default it's 20.	[optional] [default to 20]
order	string[]	Determines the order of the results. You can order the results by 'label'. The default order for this service is 'label,asc'. The general format is: 'property[,asc	desc]', with 'asc' being the default value.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\PageableTppCertificateList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getCertificate()`

getCertificate($id, $x_request_id): \OpenAPI\Client\Model\TppCertificate

Get a TPP certificate

Get a single TPP certificate by its id. Must pass the mandator admin client's access_token.

Example

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


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TPPCertificatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Id of requested TPP certificate
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->getCertificate($id, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TPPCertificatesApi->getCertificate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Id of requested TPP certificate
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\TppCertificate

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TPPCertificatesApi.md

TPPCertificatesApi.md

OpenAPI\Client\TPPCertificatesApi

`createNewCertificate()`

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteCertificate()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getAllCertificates()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getCertificate()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

TPPCertificatesApi.md

Latest commit

History

TPPCertificatesApi.md

File metadata and controls

OpenAPI\Client\TPPCertificatesApi

createNewCertificate()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCertificate()

Example

Parameters

Return type

Authorization

HTTP request headers

getAllCertificates()

Example

Parameters

Return type

Authorization

HTTP request headers

getCertificate()

Example

Parameters

Return type

Authorization

HTTP request headers

`createNewCertificate()`

`deleteCertificate()`

`getAllCertificates()`

`getCertificate()`