Skip to content

ObjectPaymentgatewayApi.md

Latest commit

 

History

History
340 lines (233 loc) · 12.2 KB

ObjectPaymentgatewayApi.md

File metadata and controls

340 lines (233 loc) · 12.2 KB

eZmaxAPI\ObjectPaymentgatewayApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
paymentgatewayCreateObjectV1() POST /1/object/paymentgateway Create a new Paymentgateway
paymentgatewayEditObjectV1() PUT /1/object/paymentgateway/{pkiPaymentgatewayID} Edit an existing Paymentgateway
paymentgatewayGetAutocompleteV2() GET /2/object/paymentgateway/getAutocomplete/{sSelector} Retrieve Paymentgateways and IDs
paymentgatewayGetListV1() GET /1/object/paymentgateway/getList Retrieve Paymentgateway list
paymentgatewayGetObjectV2() GET /2/object/paymentgateway/{pkiPaymentgatewayID} Retrieve an existing Paymentgateway

paymentgatewayCreateObjectV1()

paymentgatewayCreateObjectV1($paymentgatewayCreateObjectV1Request): \eZmaxAPI\Model\PaymentgatewayCreateObjectV1Response

Create a new Paymentgateway

The endpoint allows to create one or many elements at once.

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectPaymentgatewayApi(
    // 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
);
$paymentgatewayCreateObjectV1Request = new \eZmaxAPI\Model\PaymentgatewayCreateObjectV1Request(); // \eZmaxAPI\Model\PaymentgatewayCreateObjectV1Request

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

Parameters

Name Type Description Notes
paymentgatewayCreateObjectV1Request \eZmaxAPI\Model\PaymentgatewayCreateObjectV1Request

Return type

\eZmaxAPI\Model\PaymentgatewayCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

paymentgatewayEditObjectV1()

paymentgatewayEditObjectV1($pkiPaymentgatewayID, $paymentgatewayEditObjectV1Request): \eZmaxAPI\Model\PaymentgatewayEditObjectV1Response

Edit an existing Paymentgateway

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectPaymentgatewayApi(
    // 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
);
$pkiPaymentgatewayID = 56; // int | The unique ID of the Paymentgateway
$paymentgatewayEditObjectV1Request = new \eZmaxAPI\Model\PaymentgatewayEditObjectV1Request(); // \eZmaxAPI\Model\PaymentgatewayEditObjectV1Request

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

Parameters

Name Type Description Notes
pkiPaymentgatewayID int The unique ID of the Paymentgateway
paymentgatewayEditObjectV1Request \eZmaxAPI\Model\PaymentgatewayEditObjectV1Request

Return type

\eZmaxAPI\Model\PaymentgatewayEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

paymentgatewayGetAutocompleteV2()

paymentgatewayGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\PaymentgatewayGetAutocompleteV2Response

Retrieve Paymentgateways and IDs

Get the list of Paymentgateway to be used in a dropdown or autocomplete control.

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectPaymentgatewayApi(
    // 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
);
$sSelector = 'sSelector_example'; // string | The type of Paymentgateways to return
$eFilterActive = 'Active'; // string | Specify which results we want to display.
$sQuery = 'sQuery_example'; // string | Allow to filter the returned results
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage

try {
    $result = $apiInstance->paymentgatewayGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectPaymentgatewayApi->paymentgatewayGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sSelector string The type of Paymentgateways to return
eFilterActive string Specify which results we want to display. [optional] [default to 'Active']
sQuery string Allow to filter the returned results [optional]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]

Return type

\eZmaxAPI\Model\PaymentgatewayGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

paymentgatewayGetListV1()

paymentgatewayGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\PaymentgatewayGetListV1Response

Retrieve Paymentgateway list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | ePaymentgatewayProcessor | Moneris |

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectPaymentgatewayApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->paymentgatewayGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectPaymentgatewayApi->paymentgatewayGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\PaymentgatewayGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

paymentgatewayGetObjectV2()

paymentgatewayGetObjectV2($pkiPaymentgatewayID): \eZmaxAPI\Model\PaymentgatewayGetObjectV2Response

Retrieve an existing Paymentgateway

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectPaymentgatewayApi(
    // 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
);
$pkiPaymentgatewayID = 56; // int | The unique ID of the Paymentgateway

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

Parameters

Name Type Description Notes
pkiPaymentgatewayID int The unique ID of the Paymentgateway

Return type

\eZmaxAPI\Model\PaymentgatewayGetObjectV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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