Teambank\EasyCreditApiV3\TransactionApi

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

Method	HTTP request	Description
apiMerchantV3TransactionGet()	GET /api/merchant/v3/transaction	Find transactions of a merchant according to some search parameters.
apiMerchantV3TransactionTransactionIdCapturePost()	POST /api/merchant/v3/transaction/{transactionId}/capture	Report a capture for a transaction according to its unique functional identifier
apiMerchantV3TransactionTransactionIdGet()	GET /api/merchant/v3/transaction/{transactionId}	Retrieve a transaction of a merchant according to a unique functional identifier
apiMerchantV3TransactionTransactionIdRefundPost()	POST /api/merchant/v3/transaction/{transactionId}/refund	Report a refund for a transaction according to its unique functional identifier
apiPaymentV3TransactionPost()	POST /api/payment/v3/transaction	Initiates a transaction based on the given request
apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost()	POST /api/payment/v3/transaction/{technicalTransactionId}/authorization	Authorizes a transaction after finishing the process in a webshop
apiPaymentV3TransactionTechnicalTransactionIdGet()	GET /api/payment/v3/transaction/{technicalTransactionId}	Get the necessary information about the transaction
apiPaymentV3TransactionTechnicalTransactionIdPatch()	PATCH /api/payment/v3/transaction/{technicalTransactionId}	Updates a transaction based on the given request
apiPaymentV3TransactionTechnicalTransactionIdSwitchPaymentMethodPost()	POST /api/payment/v3/transaction/{technicalTransactionId}/switchPaymentMethod	Switch payment method

`apiMerchantV3TransactionGet()`

apiMerchantV3TransactionGet($firstname, $lastname, $orderId, $pageSize, $page, $status, $minOrderValue, $maxOrderValue, $tId, $webshopIds): \Teambank\EasyCreditApiV3\Model\TransactionListInfo

Find transactions of a merchant according to some search parameters.

' Find transactions of a merchant according to the following search parameters: firstname, lastname, orderId, status (REPORT_CAPTURE, REPORT_CAPTURE_EXPIRING, IN_BILLING, BILLED, EXPIRED), minOrderValue, maxOrderValue. The search filter combines the search tags as follows: call /transaction?firstname=Ralf&minOrderValue=5000 -> find transactions with customers firstname Ralf and a minimum order value of 5000€ '

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\TransactionApi(
    // 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
);
$firstname = Ralf; // string
$lastname = Ratenkauf; // string
$orderId = ABCDE; // string
$pageSize = 50; // int
$page = 0; // int
$status = array('status_example'); // string[]
$minOrderValue = 200; // float
$maxOrderValue = 9999.99; // float
$tId = ["TKGZ67","TBKOP"]; // string[] | Multiple unique functional transaction identifier (consists of 6 characters) provided through the query
$webshopIds = array('webshopIds_example'); // string[]

try {
    $result = $apiInstance->apiMerchantV3TransactionGet($firstname, $lastname, $orderId, $pageSize, $page, $status, $minOrderValue, $maxOrderValue, $tId, $webshopIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionApi->apiMerchantV3TransactionGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
firstname	string		[optional]
lastname	string		[optional]
orderId	string		[optional]
pageSize	int		[optional] [default to 100]
page	int		[optional]
status	string[]		[optional]
minOrderValue	float		[optional]
maxOrderValue	float		[optional]
tId	string[]	Multiple unique functional transaction identifier (consists of 6 characters) provided through the query	[optional]
webshopIds	string[]		[optional]

Return type

\Teambank\EasyCreditApiV3\Model\TransactionListInfo

Authorization

basicAuth

HTTP request headers

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

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

`apiMerchantV3TransactionTransactionIdCapturePost()`

apiMerchantV3TransactionTransactionIdCapturePost($transactionId, $captureRequest)

Report a capture for a transaction according to its unique functional identifier

Reports a capture for the specified merchant's transaction. Only one capture can be reported per transaction.

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\TransactionApi(
    // 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
);
$transactionId = EWZEN7; // string | Unique functional transaction identifier (consists of 6 characters)
$captureRequest = new \Teambank\EasyCreditApiV3\Model\CaptureRequest(); // \Teambank\EasyCreditApiV3\Model\CaptureRequest | Capture Request Object

try {
    $apiInstance->apiMerchantV3TransactionTransactionIdCapturePost($transactionId, $captureRequest);
} catch (Exception $e) {
    echo 'Exception when calling TransactionApi->apiMerchantV3TransactionTransactionIdCapturePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
transactionId	string	Unique functional transaction identifier (consists of 6 characters)
captureRequest	\Teambank\EasyCreditApiV3\Model\CaptureRequest	Capture Request Object	[optional]

Return type

void (empty response body)

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]

`apiMerchantV3TransactionTransactionIdGet()`

apiMerchantV3TransactionTransactionIdGet($transactionId): \Teambank\EasyCreditApiV3\Model\TransactionResponse

Retrieve a transaction of a merchant according to a unique functional identifier

A single transaction is loaded according to its unique functional identifier.

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\TransactionApi(
    // 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
);
$transactionId = EWZEN7; // string | Unique functional transaction identifier (consists of 6 characters)

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

Parameters

Name	Type	Description	Notes
transactionId	string	Unique functional transaction identifier (consists of 6 characters)

Return type

\Teambank\EasyCreditApiV3\Model\TransactionResponse

Authorization

basicAuth

HTTP request headers

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

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

`apiMerchantV3TransactionTransactionIdRefundPost()`

apiMerchantV3TransactionTransactionIdRefundPost($transactionId, $refundRequest)

Report a refund for a transaction according to its unique functional identifier

Reports a refund for the specified merchant's transaction. There can be multiple active refunds.

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\TransactionApi(
    // 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
);
$transactionId = EWZEN7; // string | Unique functional transaction identifier (consists of 6 characters)
$refundRequest = new \Teambank\EasyCreditApiV3\Model\RefundRequest(); // \Teambank\EasyCreditApiV3\Model\RefundRequest | Refund Request Object

try {
    $apiInstance->apiMerchantV3TransactionTransactionIdRefundPost($transactionId, $refundRequest);
} catch (Exception $e) {
    echo 'Exception when calling TransactionApi->apiMerchantV3TransactionTransactionIdRefundPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
transactionId	string	Unique functional transaction identifier (consists of 6 characters)
refundRequest	\Teambank\EasyCreditApiV3\Model\RefundRequest	Refund Request Object	[optional]

Return type

void (empty response body)

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]

`apiPaymentV3TransactionPost()`

apiPaymentV3TransactionPost($transaction): \Teambank\EasyCreditApiV3\Model\TransactionInitResponse

Initiates a transaction based on the given request

' A transaction is created with unique identifiers (a TeamBank identifier and a functional identifier ). The data in the request is validated and normalised and, if necessary, corresponding error messages are returned. Supports body signature. '

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\TransactionApi(
    // 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
);
$transaction = new \Teambank\EasyCreditApiV3\Model\Transaction(); // \Teambank\EasyCreditApiV3\Model\Transaction | init request

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

Parameters

Name	Type	Description	Notes
transaction	\Teambank\EasyCreditApiV3\Model\Transaction	init request	[optional]

Return type

\Teambank\EasyCreditApiV3\Model\TransactionInitResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/problem+json

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

`apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost()`

apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost($technicalTransactionId, $authorizationRequest)

Authorizes a transaction after finishing the process in a webshop

' The authorization of a transaction will be triggered asynchronous. After processing all necessary checks there will be an optional callback to the url that was provided in initialization and you can get the updated status information. '

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\TransactionApi(
    // 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
);
$technicalTransactionId = 'technicalTransactionId_example'; // string | Unique TeamBank transaction identifier
$authorizationRequest = new \Teambank\EasyCreditApiV3\Model\AuthorizationRequest(); // \Teambank\EasyCreditApiV3\Model\AuthorizationRequest | authorization request

try {
    $apiInstance->apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost($technicalTransactionId, $authorizationRequest);
} catch (Exception $e) {
    echo 'Exception when calling TransactionApi->apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
technicalTransactionId	string	Unique TeamBank transaction identifier
authorizationRequest	\Teambank\EasyCreditApiV3\Model\AuthorizationRequest	authorization request	[optional]

Return type

void (empty response body)

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]

`apiPaymentV3TransactionTechnicalTransactionIdGet()`

apiPaymentV3TransactionTechnicalTransactionIdGet($technicalTransactionId): \Teambank\EasyCreditApiV3\Model\TransactionInformation

Get the necessary information about the transaction

Based on the unique TeamBank identifier, transaction's specific data is returned. Supports body signature.

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\TransactionApi(
    // 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
);
$technicalTransactionId = 'technicalTransactionId_example'; // string | Unique TeamBank transaction identifier

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

Parameters

Name	Type	Description	Notes
technicalTransactionId	string	Unique TeamBank transaction identifier

Return type

\Teambank\EasyCreditApiV3\Model\TransactionInformation

Authorization

basicAuth

HTTP request headers

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

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

`apiPaymentV3TransactionTechnicalTransactionIdPatch()`

apiPaymentV3TransactionTechnicalTransactionIdPatch($technicalTransactionId, $transactionUpdate): \Teambank\EasyCreditApiV3\Model\TransactionSummary

Updates a transaction based on the given request

Based on the unique TeamBank identifier, the specific data of the transaction can be changed in the ‘PREAUTHORIZED’ status. Supports the body signature.

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\TransactionApi(
    // 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
);
$technicalTransactionId = 'technicalTransactionId_example'; // string | Unique TeamBank transaction identifier
$transactionUpdate = new \Teambank\EasyCreditApiV3\Model\TransactionUpdate(); // \Teambank\EasyCreditApiV3\Model\TransactionUpdate | update request

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

Parameters

Name	Type	Description	Notes
technicalTransactionId	string	Unique TeamBank transaction identifier
transactionUpdate	\Teambank\EasyCreditApiV3\Model\TransactionUpdate	update request	[optional]

Return type

\Teambank\EasyCreditApiV3\Model\TransactionSummary

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/problem+json

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

`apiPaymentV3TransactionTechnicalTransactionIdSwitchPaymentMethodPost()`

apiPaymentV3TransactionTechnicalTransactionIdSwitchPaymentMethodPost($technicalTransactionId): \Teambank\EasyCreditApiV3\Model\TransactionInformation

Switch payment method

' Switch payment method for transaction to other variant, e.g. from installment plan to invoice. '

Example

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



$apiInstance = new Teambank\EasyCreditApiV3\Api\TransactionApi(
    // 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()
);
$technicalTransactionId = 'technicalTransactionId_example'; // string | Unique TeamBank transaction identifier

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

Parameters

Name	Type	Description	Notes
technicalTransactionId	string	Unique TeamBank transaction identifier

Return type

\Teambank\EasyCreditApiV3\Model\TransactionInformation

Authorization

No authorization required

HTTP request headers

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

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

Files

TransactionApi.md

Latest commit

History

TransactionApi.md

File metadata and controls

Teambank\EasyCreditApiV3\TransactionApi

apiMerchantV3TransactionGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiMerchantV3TransactionTransactionIdCapturePost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiMerchantV3TransactionTransactionIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiMerchantV3TransactionTransactionIdRefundPost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiPaymentV3TransactionPost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiPaymentV3TransactionTechnicalTransactionIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiPaymentV3TransactionTechnicalTransactionIdPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

apiPaymentV3TransactionTechnicalTransactionIdSwitchPaymentMethodPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`apiMerchantV3TransactionGet()`

`apiMerchantV3TransactionTransactionIdCapturePost()`

`apiMerchantV3TransactionTransactionIdGet()`

`apiMerchantV3TransactionTransactionIdRefundPost()`

`apiPaymentV3TransactionPost()`

`apiPaymentV3TransactionTechnicalTransactionIdAuthorizationPost()`

`apiPaymentV3TransactionTechnicalTransactionIdGet()`

`apiPaymentV3TransactionTechnicalTransactionIdPatch()`

`apiPaymentV3TransactionTechnicalTransactionIdSwitchPaymentMethodPost()`