Soxyl\Saferpay\TransactionApi

All URIs are relative to https://www.saferpay.com/api/Payment/v1

Method	HTTP request	Description
transactionAdjustAmountPost	POST /Transaction/AdjustAmount
transactionAssertCapturePost	POST /Transaction/AssertCapture
transactionAssertRedirectPaymentPost	POST /Transaction/AssertRedirectPayment
transactionAssertRefundPost	POST /Transaction/AssertRefund
transactionAuthorizeDirectPost	POST /Transaction/AuthorizeDirect
transactionAuthorizePost	POST /Transaction/Authorize
transactionAuthorizeReferencedPost	POST /Transaction/AuthorizeReferenced
transactionCancelPost	POST /Transaction/Cancel
transactionCapturePost	POST /Transaction/Capture
transactionInitializePost	POST /Transaction/Initialize
transactionMultipartCapturePost	POST /Transaction/MultipartCapture
transactionMultipartFinalizePost	POST /Transaction/MultipartFinalize
transactionQueryPaymentMeansPost	POST /Transaction/QueryPaymentMeans
transactionRedirectPaymentPost	POST /Transaction/RedirectPayment
transactionRefundDirectPost	POST /Transaction/RefundDirect
transactionRefundPost	POST /Transaction/Refund

transactionAdjustAmountPost

\Soxyl\Saferpay\Model\TransactionAdjustAmountResponse transactionAdjustAmountPost($transaction_adjust_amount_request)

This method may be used to adjust the amount after query payment means.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_adjust_amount_request = new \Soxyl\Saferpay\Model\TransactionAdjustAmountRequest(); // \Soxyl\Saferpay\Model\TransactionAdjustAmountRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_adjust_amount_request	\Soxyl\Saferpay\Model\TransactionAdjustAmountRequest

Return type

\Soxyl\Saferpay\Model\TransactionAdjustAmountResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAssertCapturePost

\Soxyl\Saferpay\Model\TransactionAssertCaptureResponse transactionAssertCapturePost($transaction_assert_capture_request)

This method is only supported for pending capture transactions (only used for paydirekt at the moment)

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_assert_capture_request = new \Soxyl\Saferpay\Model\TransactionAssertCaptureRequest(); // \Soxyl\Saferpay\Model\TransactionAssertCaptureRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_assert_capture_request	\Soxyl\Saferpay\Model\TransactionAssertCaptureRequest

Return type

\Soxyl\Saferpay\Model\TransactionAssertCaptureResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAssertRedirectPaymentPost

\Soxyl\Saferpay\Model\TransactionAssertRedirectPaymentResponse transactionAssertRedirectPaymentPost($transaction_assert_redirect_payment_request)

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_assert_redirect_payment_request = new \Soxyl\Saferpay\Model\TransactionAssertRedirectPaymentRequest(); // \Soxyl\Saferpay\Model\TransactionAssertRedirectPaymentRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_assert_redirect_payment_request	\Soxyl\Saferpay\Model\TransactionAssertRedirectPaymentRequest

Return type

\Soxyl\Saferpay\Model\TransactionAssertRedirectPaymentResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAssertRefundPost

\Soxyl\Saferpay\Model\TransactionAssertRefundResponse transactionAssertRefundPost($transaction_assert_refund_request)

This method may be used to inquire the status and further information of pending refunds.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_assert_refund_request = new \Soxyl\Saferpay\Model\TransactionAssertRefundRequest(); // \Soxyl\Saferpay\Model\TransactionAssertRefundRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_assert_refund_request	\Soxyl\Saferpay\Model\TransactionAssertRefundRequest

Return type

\Soxyl\Saferpay\Model\TransactionAssertRefundResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAuthorizeDirectPost

\Soxyl\Saferpay\Model\TransactionAuthorizeDirectResponse transactionAuthorizeDirectPost($transaction_authorize_direct_request)

This function may be used to directly authorize transactions which do not require a redirect of the customer (e.g. direct debit or recurring transactions based on a previously registered alias).

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_authorize_direct_request = new \Soxyl\Saferpay\Model\TransactionAuthorizeDirectRequest(); // \Soxyl\Saferpay\Model\TransactionAuthorizeDirectRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_authorize_direct_request	\Soxyl\Saferpay\Model\TransactionAuthorizeDirectRequest

Return type

\Soxyl\Saferpay\Model\TransactionAuthorizeDirectResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAuthorizePost

\Soxyl\Saferpay\Model\TransactionAuthorizeResponse transactionAuthorizePost($transaction_authorize_request)

This function may be called to authorize a transaction which was started by a call to Transaction/Initialize.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_authorize_request = new \Soxyl\Saferpay\Model\TransactionAuthorizeRequest(); // \Soxyl\Saferpay\Model\TransactionAuthorizeRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_authorize_request	\Soxyl\Saferpay\Model\TransactionAuthorizeRequest

Return type

\Soxyl\Saferpay\Model\TransactionAuthorizeResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionAuthorizeReferencedPost

\Soxyl\Saferpay\Model\TransactionAuthorizeReferencedResponse transactionAuthorizeReferencedPost($transaction_authorize_referenced_request)

This method may be used to perform follow-up authorizations to an earlier transaction. At this time, the referenced (initial) transaction must have been performed setting either the recurring or installment option.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_authorize_referenced_request = new \Soxyl\Saferpay\Model\TransactionAuthorizeReferencedRequest(); // \Soxyl\Saferpay\Model\TransactionAuthorizeReferencedRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_authorize_referenced_request	\Soxyl\Saferpay\Model\TransactionAuthorizeReferencedRequest

Return type

\Soxyl\Saferpay\Model\TransactionAuthorizeReferencedResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionCancelPost

\Soxyl\Saferpay\Model\TransactionCancelResponse transactionCancelPost($transaction_cancel_request)

This method may be used to cancel previously authorized transactions and refunds.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_cancel_request = new \Soxyl\Saferpay\Model\TransactionCancelRequest(); // \Soxyl\Saferpay\Model\TransactionCancelRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_cancel_request	\Soxyl\Saferpay\Model\TransactionCancelRequest

Return type

\Soxyl\Saferpay\Model\TransactionCancelResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionCapturePost

\Soxyl\Saferpay\Model\TransactionCaptureResponse transactionCapturePost($transaction_capture_request)

This method may be used to finalize previously authorized transactions and refunds.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_capture_request = new \Soxyl\Saferpay\Model\TransactionCaptureRequest(); // \Soxyl\Saferpay\Model\TransactionCaptureRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_capture_request	\Soxyl\Saferpay\Model\TransactionCaptureRequest

Return type

\Soxyl\Saferpay\Model\TransactionCaptureResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionInitializePost

\Soxyl\Saferpay\Model\TransactionInitializeResponse transactionInitializePost($transaction_initialize_request)

This method may be used to start a transaction which may involve either DCC and / or 3d-secure.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_initialize_request = new \Soxyl\Saferpay\Model\TransactionInitializeRequest(); // \Soxyl\Saferpay\Model\TransactionInitializeRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_initialize_request	\Soxyl\Saferpay\Model\TransactionInitializeRequest

Return type

\Soxyl\Saferpay\Model\TransactionInitializeResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionMultipartCapturePost

\Soxyl\Saferpay\Model\TransactionMultipartCaptureResponse transactionMultipartCapturePost($transaction_multipart_capture_request)

This method may be used to capture multiple parts of an authorized transaction.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_multipart_capture_request = new \Soxyl\Saferpay\Model\TransactionMultipartCaptureRequest(); // \Soxyl\Saferpay\Model\TransactionMultipartCaptureRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_multipart_capture_request	\Soxyl\Saferpay\Model\TransactionMultipartCaptureRequest

Return type

\Soxyl\Saferpay\Model\TransactionMultipartCaptureResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionMultipartFinalizePost

\Soxyl\Saferpay\Model\TransactionMultipartFinalizeResponse transactionMultipartFinalizePost($transaction_multipart_finalize_request)

This method may be used to finalize an authorized transaction (i.e. marks the end of partial captures).

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_multipart_finalize_request = new \Soxyl\Saferpay\Model\TransactionMultipartFinalizeRequest(); // \Soxyl\Saferpay\Model\TransactionMultipartFinalizeRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_multipart_finalize_request	\Soxyl\Saferpay\Model\TransactionMultipartFinalizeRequest

Return type

\Soxyl\Saferpay\Model\TransactionMultipartFinalizeResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionQueryPaymentMeansPost

\Soxyl\Saferpay\Model\TransactionQueryPaymentMeansResponse transactionQueryPaymentMeansPost($transaction_query_payment_means_request)

This method may be used to query the payment means and payer data (address) after initialize and wallet redirect.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_query_payment_means_request = new \Soxyl\Saferpay\Model\TransactionQueryPaymentMeansRequest(); // \Soxyl\Saferpay\Model\TransactionQueryPaymentMeansRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_query_payment_means_request	\Soxyl\Saferpay\Model\TransactionQueryPaymentMeansRequest

Return type

\Soxyl\Saferpay\Model\TransactionQueryPaymentMeansResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionRedirectPaymentPost

\Soxyl\Saferpay\Model\TransactionRedirectPaymentResponse transactionRedirectPaymentPost($transaction_redirect_payment_request)

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_redirect_payment_request = new \Soxyl\Saferpay\Model\TransactionRedirectPaymentRequest(); // \Soxyl\Saferpay\Model\TransactionRedirectPaymentRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_redirect_payment_request	\Soxyl\Saferpay\Model\TransactionRedirectPaymentRequest

Return type

\Soxyl\Saferpay\Model\TransactionRedirectPaymentResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionRefundDirectPost

\Soxyl\Saferpay\Model\TransactionRefundDirectResponse transactionRefundDirectPost($transaction_refund_direct_request)

This method may be called to refund an amount to the given means of payment (not supported for all means of payment) without referencing a previous transaction. This might be the case if the original transaction was done with a card which is not valid any more.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_refund_direct_request = new \Soxyl\Saferpay\Model\TransactionRefundDirectRequest(); // \Soxyl\Saferpay\Model\TransactionRefundDirectRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_refund_direct_request	\Soxyl\Saferpay\Model\TransactionRefundDirectRequest

Return type

\Soxyl\Saferpay\Model\TransactionRefundDirectResponse

Authorization

BasicAuth

HTTP request headers

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

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

transactionRefundPost

\Soxyl\Saferpay\Model\TransactionRefundResponse transactionRefundPost($transaction_refund_request)

This method may be called to refund a previous transaction.

Example

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

// Configure HTTP basic authorization: BasicAuth
$config = Soxyl\Saferpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Soxyl\Saferpay\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_refund_request = new \Soxyl\Saferpay\Model\TransactionRefundRequest(); // \Soxyl\Saferpay\Model\TransactionRefundRequest | 

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

Parameters

Name	Type	Description	Notes
transaction_refund_request	\Soxyl\Saferpay\Model\TransactionRefundRequest

Return type

\Soxyl\Saferpay\Model\TransactionRefundResponse

Authorization

BasicAuth

HTTP request headers

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

[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

Soxyl\Saferpay\TransactionApi

transactionAdjustAmountPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAssertCapturePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAssertRedirectPaymentPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAssertRefundPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAuthorizeDirectPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAuthorizePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionAuthorizeReferencedPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionCancelPost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionCapturePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionInitializePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionMultipartCapturePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionMultipartFinalizePost

Example

Parameters

Return type

Authorization

HTTP request headers

transactionQueryPaymentMeansPost