Skip to content

Latest commit

 

History

History
130 lines (92 loc) · 5.29 KB

PresetApi.md

File metadata and controls

130 lines (92 loc) · 5.29 KB

Optile\PresetApi

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

Method HTTP request Description
presetPaymentAccount POST /lists/{listId}/accounts/{accountId}/preset Preset registered account of LIST
presetPaymentNetwork POST /lists/{listId}/{network}/preset Preset payment network of LIST

presetPaymentAccount

\Optile\Model\Preset presetPaymentAccount($list_id, $account_id, $operation)

Preset registered account of LIST

Initiates PRESET operation in scope of LIST session with selected registered account. Note: This is only available for registered customers and works if LIST session was initialized with presetFirst option.

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\PresetApi(
    // 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 complete a `CHARGE` operation
$account_id = "account_id_example"; // string | The ID of account from registered customer to perform a `PRESET` operation
$operation = new \Optile\Model\Operation(); // \Optile\Model\Operation | Holds information for `PRESET` operation with selected payment network

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

Parameters

Name Type Description Notes
list_id string The `longId` of a `LIST` session to complete a `CHARGE` operation
account_id string The ID of account from registered customer to perform a `PRESET` operation
operation \Optile\Model\Operation Holds information for `PRESET` operation with selected payment network

Return type

\Optile\Model\Preset

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]

presetPaymentNetwork

\Optile\Model\Preset presetPaymentNetwork($list_id, $network, $operation)

Preset payment network of LIST

Initiates PRESET operation in scope of LIST session with selected payment network and collected account-input-data. Note: This is only available if LIST session was initialized with presetFirst option.

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\PresetApi(
    // 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 complete a `PRESET` operation
$network = "network_example"; // string | The code of selected payment network
$operation = new \Optile\Model\Operation(); // \Optile\Model\Operation | Holds information for `PRESET` operation with selected payment network

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

Parameters

Name Type Description Notes
list_id string The `longId` of a `LIST` session to complete a `PRESET` operation
network string The code of selected payment network
operation \Optile\Model\Operation Holds information for `PRESET` operation with selected payment network

Return type

\Optile\Model\Preset

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]