zfmaster/optile-opg-lib


Keywords
php, api, sdk, swagger, opg, optile
License
Other

Documentation

SwaggerClient-php

RESTful API for payments via optile Open Payment Gateway (OPG) for server to server communication. Calls to this API require authorization. ## Current version * API service version: 1.1.289 * API model version: 1.20.87

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.1.289
  • Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://www.optile.net

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/zfmaster/optile-opg-lib.git"
    }
  ],
  "require": {
    "zfmaster/optile-opg-lib": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?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\ActivationApi(
    // 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 an `ACTIVATION` operation
$network = "network_example"; // string | The code of selected payment network
$operation = new \Optile\Model\Operation(); // \Optile\Model\Operation | Holds information for `ACTIVATION` operation with selected payment network
$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->activatePaymentNetwork($list_id, $network, $operation, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivationApi->activatePaymentNetwork: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivationApi activatePaymentNetwork POST /lists/{listId}/{network}/activate Activate selected payment network
ActivationApi getActivatedPaymentNetwork GET /activations/{activationId} Get ACTIVATION details
ChargeApi cancelCharge DELETE /charges/{chargeId} Cancel deferred CHARGE
ChargeApi getCharge GET /charges/{chargeId} Get CHARGE operation details
ChargeApi payWithCustomerPaymentAccount POST /customers/{customerId}/charge Recurring CHARGE of registered customer
ChargeApi payWithExpressPreset POST /presets/{presetId}/charge Pay with confirmed express preset
ChargeApi payWithPaymentAccount POST /lists/{listId}/accounts/{accountId}/charge Pay with selected registered account
ChargeApi payWithPaymentNetwork POST /lists/{listId}/{network}/charge Pay with selected payment network
ChargeApi payWithSelectedPaymentNetwork POST /lists/{listId}/charge Pay with preset network or account
ChargeApi standalonePayment POST /charges Stand-alone payment with selected payment network
ClosingApi closeCharge POST /charges/{chargeId}/closing Close deferred CHARGE
ClosingApi closePayout POST /payouts/{payoutId}/closing Close deferred PAYOUT
CustomerApi deleteCustomerRegistration DELETE /customers/{customerId} Delete customer registration
CustomerApi getCustomerPaymentAccount GET /customers/{customerId}/accounts/{accountId} Get customer account details
CustomerApi getCustomerPaymentAccounts GET /customers/{customerId}/accounts Get customer accounts
CustomerApi getCustomerRegistration GET /customers/{customerId} Get customer details
ExpressApi confirmExpressPreset POST /presets/{presetId}/confirm Confirm express preset session
ExpressApi createExpressPreset POST /express/{network}/preset Create express preset session
ExpressApi getExpressList GET /express Get express checkout networks
ExpressApi getExpressPreset GET /presets/{presetId} Get express preset details
ExpressApi updateExpressPreset PUT /presets/{presetId} Update express preset session
ListApi cancelPaymentSession DELETE /lists/{listId} Cancel LIST session
ListApi createPaymentSession POST /lists Create new payment session
ListApi getPaymentAccount GET /lists/{listId}/accounts/{accountId} Get registered account of LIST
ListApi getPaymentNetwork GET /lists/{listId}/{network} Get payment network of LIST
ListApi getPaymentSession GET /lists/{listId} Get LIST session details
ListApi selectPaymentAccount PUT /lists/{listId}/accounts/{accountId} Select registered account of LIST
ListApi selectPaymentNetwork PUT /lists/{listId}/{network} Select payment network of LIST
ListApi updatePaymentSession PUT /lists/{listId} Update LIST session details
PayoutApi getPayout GET /payouts/{payoutId} Gets PAYOUT operation details
PayoutApi payoutOnCharge POST /charges/{chargeId}/payout Payout of successful CHARGE
PayoutApi payoutWithPaymentAccount POST /lists/{listId}/accounts/{accountId}/payout Payout with selected registered account
PayoutApi payoutWithPaymentNetwork POST /lists/{listId}/{network}/payout Payout with selected network
PresetApi presetPaymentAccount POST /lists/{listId}/accounts/{accountId}/preset Preset registered account of LIST
PresetApi presetPaymentNetwork POST /lists/{listId}/{network}/preset Preset payment network of LIST
RegistrationApi registerPaymentAccount POST /lists/{listId}/{network}/register Register new account
RegistrationApi setPaymentAccountAsPreferred POST /lists/{listId}/accounts/{accountId}/setpreferred Sets registered account as preferred
RegistrationApi unregisterPaymentAccount DELETE /lists/{listId}/accounts/{accountId} Delete registered account via LIST
RegistrationApi updatePaymentAccount POST /lists/{listId}/accounts/{accountId}/update Update selected registered account

Documentation For Models

Documentation For Authorization

payment_auth

  • Type: HTTP basic authentication

Author

support@optile.net