Optile\ListApi

All URIs are relative to https://api.sandbox.oscato.com/api

Method	HTTP request	Description
cancelPaymentSession	DELETE /lists/{listId}	Cancel LIST session
createPaymentSession	POST /lists	Create new payment session
getPaymentAccount	GET /lists/{listId}/accounts/{accountId}	Get registered account of LIST
getPaymentNetwork	GET /lists/{listId}/{network}	Get payment network of LIST
getPaymentSession	GET /lists/{listId}	Get LIST session details
selectPaymentAccount	PUT /lists/{listId}/accounts/{accountId}	Select registered account of LIST
selectPaymentNetwork	PUT /lists/{listId}/{network}	Select payment network of LIST
updatePaymentSession	PUT /lists/{listId}	Update LIST session details

cancelPaymentSession

cancelPaymentSession($list_id)

Cancel LIST session

Requests cancelation of a LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session to cancel

try {
    $apiInstance->cancelPaymentSession($list_id);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->cancelPaymentSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session to cancel

Return type

void (empty response body)

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

createPaymentSession

\Optile\Model\NetworkList createPaymentSession($transaction, $view)

Create new payment session

Initializes a payment session by executing LIST operation.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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 \Optile\Model\Transaction(); // \Optile\Model\Transaction | Transaction to initialize payment session
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

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

Parameters

Name	Type	Description	Notes
transaction	\Optile\Model\Transaction	Transaction to initialize payment session
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\NetworkList

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

getPaymentAccount

\Optile\Model\AccountRegistration getPaymentAccount($list_id, $account_id, $view)

Get registered account of LIST

Gets customer registered account in scope of initialized LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session
$account_id = "account_id_example"; // string | The ID of account from registered customer
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

try {
    $result = $apiInstance->getPaymentAccount($list_id, $account_id, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getPaymentAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session
account_id	string	The ID of account from registered customer
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\AccountRegistration

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

getPaymentNetwork

\Optile\Model\ApplicableNetwork getPaymentNetwork($list_id, $network, $view)

Get payment network of LIST

Retrieves information about payment network in scope of active LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session
$network = "network_example"; // string | Network code of network to retrieve
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

try {
    $result = $apiInstance->getPaymentNetwork($list_id, $network, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getPaymentNetwork: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session
network	string	Network code of network to retrieve
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\ApplicableNetwork

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

getPaymentSession

\Optile\Model\NetworkList getPaymentSession($list_id, $view)

Get LIST session details

Retrieves current state of a LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session to retrieve
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options. Supplying unknown options or conflicting options combination (e.g. \"-jsonForms,jsonForms\") will cause an error and HTTP 400 (Bad Request) response.  Following options are supported:   * `htmlForms` - this option enables generation of links to build HTML forms for applicable networks and registered     accounts in `LIST` response. **Enabled** by default.   * `jsonForms` - this option enables generation of structured (in JSON format) description of forms for applicable     networks and registered accounts in `LIST` response. **Disabled** by default.   * `routes` - this option enables routing configuration to be exposed for applicable networks and registered accounts     in `LIST` response. **Disabled** by default.  Note: if no value supplied for an option the API behaves according to the defaults. Empty `view` parameter is interpreted as **\"htmlForms,-jsonForms,-routes\"**

try {
    $result = $apiInstance->getPaymentSession($list_id, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getPaymentSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session to retrieve
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. Supplying unknown options or conflicting options combination (e.g. "-jsonForms,jsonForms") will cause an error and HTTP 400 (Bad Request) response. Following options are supported: * `htmlForms` - this option enables generation of links to build HTML forms for applicable networks and registered accounts in `LIST` response. Enabled by default. * `jsonForms` - this option enables generation of structured (in JSON format) description of forms for applicable networks and registered accounts in `LIST` response. Disabled by default. * `routes` - this option enables routing configuration to be exposed for applicable networks and registered accounts in `LIST` response. Disabled by default. Note: if no value supplied for an option the API behaves according to the defaults. Empty `view` parameter is interpreted as "htmlForms,-jsonForms,-routes"	[optional]

Return type

\Optile\Model\NetworkList

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

selectPaymentAccount

\Optile\Model\AccountRegistration selectPaymentAccount($list_id, $account_id, $network_selection, $view)

Select registered account of LIST

Pre-selects a registered account in scope of active LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session
$account_id = "account_id_example"; // string | The ID of account from registered customer to be selected
$network_selection = new \Optile\Model\NetworkSelection(); // \Optile\Model\NetworkSelection | Holds information that network should be selected or unselected
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

try {
    $result = $apiInstance->selectPaymentAccount($list_id, $account_id, $network_selection, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->selectPaymentAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session
account_id	string	The ID of account from registered customer to be selected
network_selection	\Optile\Model\NetworkSelection	Holds information that network should be selected or unselected
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\AccountRegistration

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

selectPaymentNetwork

\Optile\Model\ApplicableNetwork selectPaymentNetwork($list_id, $network, $network_selection, $view)

Select payment network of LIST

Pre-selects a payment network in scope of active LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session
$network = "network_example"; // string | The code of selected payment network
$network_selection = new \Optile\Model\NetworkSelection(); // \Optile\Model\NetworkSelection | Holds information that network should be selected or unselected
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

try {
    $result = $apiInstance->selectPaymentNetwork($list_id, $network, $network_selection, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->selectPaymentNetwork: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session
network	string	The code of selected payment network
network_selection	\Optile\Model\NetworkSelection	Holds information that network should be selected or unselected
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\ApplicableNetwork

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

updatePaymentSession

\Optile\Model\NetworkList updatePaymentSession($list_id, $transaction, $view)

Update LIST session details

Allows to update some parts of transaction information (customer, payment, products) of initialized LIST session.

Example

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

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


$apiInstance = new Optile\Api\ListApi(
    // 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
);
$list_id = "list_id_example"; // string | The `longId` of a `LIST` session to update
$transaction = new \Optile\Model\Transaction(); // \Optile\Model\Transaction | Transaction to update list session
$view = array("view_example"); // string[] | Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (\",\") to separate options.  See \"Get LIST session details\" for more detailed information about the `view` query parameter.

try {
    $result = $apiInstance->updatePaymentSession($list_id, $transaction, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->updatePaymentSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	string	The `longId` of a `LIST` session to update
transaction	\Optile\Model\Transaction	Transaction to update list session
view	string[]	Enables or disables view options to configure response when creating or retrieving `LIST`. Multiple options can be combined in the single value of the `view` query parameter. Use comma (",") to separate options. See "Get LIST session details" for more detailed information about the `view` query parameter.	[optional]

Return type

\Optile\Model\NetworkList

Authorization

payment_auth

HTTP request headers

Content-Type: application/vnd.optile.payment.enterprise-v1-extensible+json
Accept: application/vnd.optile.payment.enterprise-v1-extensible+json

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

Files

ListApi.md

Latest commit

History

ListApi.md

File metadata and controls

Optile\ListApi

cancelPaymentSession

Example

Parameters

Return type

Authorization

HTTP request headers

createPaymentSession

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentAccount

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentNetwork

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentSession

Example

Parameters

Return type

Authorization

HTTP request headers

selectPaymentAccount

Example

Parameters

Return type

Authorization

HTTP request headers

selectPaymentNetwork

Example

Parameters

Return type

Authorization

HTTP request headers

updatePaymentSession

Example

Parameters

Return type

Authorization

HTTP request headers