README

The ratenkauf by easyCredit API v3 Library is the official PHP library for using the following ratenkauf by easyCredit API's:

Payment API v3 (https://ratenkauf.easycredit.de/api/payment/v3/openapi)
Calculator API v3 (https://ratenkauf.easycredit.de/api/ratenrechner/v3/openapi)
Merchant API v3 (https://partner.easycredit-ratenkauf.de/api/merchant/v3/openapi)

Installation & Usage

Requirements

PHP >= 7.0

Composer

To install the API Library via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/netzkollektiv/ratenkaufbyeasycredit-api-v3-php.git"
    }
  ],
  "require": {
    "netzkollektiv/ratenkaufbyeasycredit-api-v3-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/ratenkaufbyeasycredit-api-v3-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: basicAuth
$config = Teambank\RatenkaufByEasyCreditApiV3\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\RatenkaufByEasyCreditApiV3\Api\DocumentApi(
    // 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
);
$billingDateFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | set by default to the last month if not specified
$billingDateTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | set by default to billingDateFrom + one month if not specified
$documentType = array('documentType_example'); // string[] | set by default to all options if not specified
$fileType = array('fileType_example'); // string[] | set by default to all options if not specified

try {
    $result = $apiInstance->apiMerchantV3DocumentsGet($billingDateFrom, $billingDateTo, $documentType, $fileType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->apiMerchantV3DocumentsGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://partner.easycredit-ratenkauf.de

Class	Method	HTTP request	Description
DocumentApi	apiMerchantV3DocumentsGet	GET /api/merchant/v3/documents	Download billing documents of a merchant.
InstallmentplanApi	apiRatenrechnerV3WebshopShopIdentifierInstallmentplansPost	POST /api/ratenrechner/v3/webshop/{shopIdentifier}/installmentplans	Calculates the installmentplan
TransactionApi	apiMerchantV3TransactionGet	GET /api/merchant/v3/transaction	Find transactions of a merchant according to some search parameters.
TransactionApi	apiMerchantV3TransactionTransactionIdCapturePost	POST /api/merchant/v3/transaction/{transactionId}/capture	Report a capture for a transaction according to its unique functional identifier
TransactionApi	apiMerchantV3TransactionTransactionIdGet	GET /api/merchant/v3/transaction/{transactionId}	Retrieve a transaction of a merchant according to a unique functional identifier
TransactionApi	apiMerchantV3TransactionTransactionIdRefundPost	POST /api/merchant/v3/transaction/{transactionId}/refund	Report a refund for a transaction according to its unique functional identifier
TransactionApi	apiPaymentV3TransactionPost	POST /api/payment/v3/transaction	Initiates a transaction based on the given request
TransactionApi	apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost	POST /api/payment/v3/transaction/{technicalTransactionId}/authorization	Authorizes a transaction after finishing the process in a webshop
TransactionApi	apiPaymentV3TransactionTechnicalTransactionIdGet	GET /api/payment/v3/transaction/{technicalTransactionId}	Get the necessary information about the transaction
TransactionApi	apiPaymentV3TransactionTechnicalTransactionIdPatch	PATCH /api/payment/v3/transaction/{technicalTransactionId}	Updates a transaction based on the given request
WebshopApi	apiPaymentV3WebshopGet	GET /api/payment/v3/webshop	Get the necessary information about the webshop
WebshopApi	apiPaymentV3WebshopIntegrationcheckPost	POST /api/payment/v3/webshop/integrationcheck	Verifies the correctness of the merchant's authentication credentials and, if enabled, the body signature
WebshopApi	apiPaymentV3WebshopWebshopIdGet	GET /api/payment/v3/webshop/{webshopId}	Get the necessary information about the webshop

Models

Authorization

basicAuth

Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: V3.125.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

netzkollektiv / ratenkaufbyeasycredit-api-v3-php

Maintainers

Details