Skip to content

Latest commit

 

History

History
189 lines (127 loc) · 6.46 KB

WebshopApi.md

File metadata and controls

189 lines (127 loc) · 6.46 KB

Teambank\EasyCreditApiV3\WebshopApi

All URIs are relative to https://partner.easycredit-ratenkauf.de, except if the operation defines another base path.

Method HTTP request Description
apiPaymentV3WebshopGet() GET /api/payment/v3/webshop Get the necessary information about the webshop
apiPaymentV3WebshopIntegrationcheckPost() POST /api/payment/v3/webshop/integrationcheck Verifies the correctness of the merchant's authentication credentials and, if enabled, the body signature
apiPaymentV3WebshopWebshopIdGet() GET /api/payment/v3/webshop/{webshopId} Get the necessary information about the webshop

apiPaymentV3WebshopGet()

apiPaymentV3WebshopGet(): \Teambank\EasyCreditApiV3\Model\WebshopResponse

Get the necessary information about the webshop

' This API returns the necessary information of the corresponding webshop. This includes max and min financing amount, interest rate, test mode, current availability information and privacy approval form '

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Teambank\EasyCreditApiV3\Configuration::getDefaultConfiguration()
              ->setHost('https://ratenkauf.easycredit.de')
              ->setUsername('1.de.1234.1') // use your "Webshop-ID"
              ->setPassword('YOUR_API_KEY'); // use your "API-Kennwort"


$apiInstance = new Teambank\EasyCreditApiV3\Api\WebshopApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Teambank\EasyCreditApiV3\Model\WebshopResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

apiPaymentV3WebshopIntegrationcheckPost()

apiPaymentV3WebshopIntegrationcheckPost($integrationCheckRequest): \Teambank\EasyCreditApiV3\Model\IntegrationCheckResponse

Verifies the correctness of the merchant's authentication credentials and, if enabled, the body signature

' After integrating the authentication credentials (basic auth: webshop id/ratenkauf token) and possibly enabling the body signature feature, the merchant can check its correctness. '

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Teambank\EasyCreditApiV3\Configuration::getDefaultConfiguration()
              ->setHost('https://ratenkauf.easycredit.de')
              ->setUsername('1.de.1234.1') // use your "Webshop-ID"
              ->setPassword('YOUR_API_KEY'); // use your "API-Kennwort"


$apiInstance = new Teambank\EasyCreditApiV3\Api\WebshopApi(
    // 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
);
$integrationCheckRequest = new \Teambank\EasyCreditApiV3\Model\IntegrationCheckRequest(); // \Teambank\EasyCreditApiV3\Model\IntegrationCheckRequest | integration check request

try {
    $result = $apiInstance->apiPaymentV3WebshopIntegrationcheckPost($integrationCheckRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebshopApi->apiPaymentV3WebshopIntegrationcheckPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integrationCheckRequest \Teambank\EasyCreditApiV3\Model\IntegrationCheckRequest integration check request [optional]

Return type

\Teambank\EasyCreditApiV3\Model\IntegrationCheckResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/problem+json

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

apiPaymentV3WebshopWebshopIdGet()

apiPaymentV3WebshopWebshopIdGet($webshopId): \Teambank\EasyCreditApiV3\Model\WebshopResponse

Get the necessary information about the webshop

' This API returns the necessary information of the corresponding webshop. This includes max and min financing amount, interest rate, test mode, current availability information and privacy approval form '

Example

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



$apiInstance = new Teambank\EasyCreditApiV3\Api\WebshopApi(
    // 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()
);
$webshopId = 'webshopId_example'; // string | Identifier of a webshop

try {
    $result = $apiInstance->apiPaymentV3WebshopWebshopIdGet($webshopId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebshopApi->apiPaymentV3WebshopWebshopIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
webshopId string Identifier of a webshop

Return type

\Teambank\EasyCreditApiV3\Model\WebshopResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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