revenuewire/merchant-gateway-api-sdk-php

v1.0.3 2018-01-23 20:55 UTC

This package is auto-updated.

Last update: 2024-04-29 03:56:56 UTC


README

Merchant Gateway API

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

  • API version: 1.2.6
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/revenuewire/merchant-gateway-api-sdk-php.git"
    }
  ],
  "require": {
    "revenuewire/merchant-gateway-api-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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 API key authorization: APIKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');
// Configure API key authorization: JWTHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Authorization-JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Authorization-JWT', 'Bearer');

$api_instance = new Swagger\Client\Api\MerchantGatewayApi();
$clientId = "clientId_example"; // string | 
$gatewayPolicy = "gatewayPolicy_example"; // string | 

try {
    $result = $api_instance->createMerchantGateway($clientId, $gatewayPolicy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MerchantGatewayApi->createMerchantGateway: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://merchant-gateway-api.revenuewire.io/v1

Class Method HTTP request Description
MerchantGatewayApi createMerchantGateway POST /merchants create merchant gateway configuration
MerchantGatewayApi getMerchantGateway GET /merchants/{clientId} get merchant gateway configuration
MerchantGatewayConfigurationApi activateMerchantGatewayVersion POST /merchants/{clientId}/versions/{version}/activate activate gateway version
MerchantGatewayConfigurationApi createMerchantGatewayVersion POST /merchants/{clientId}/versions create a new gateway configuration version.
MerchantGatewayConfigurationApi getMerchantGatewayVersion GET /merchants/{clientId}/versions/{version} get gateway version detail
MerchantGatewayConfigurationApi updateMerchantGatewayVersion PUT /merchants/{clientId}/versions/{version} update gateway version detail
PayApi chooseGateway GET /merchants/{clientId}/choose-gateway Choose a gateway
PublicApi getPaymentMethods GET /merchants/{clientId}/payment-methods get list of payment methods

Documentation For Models

Documentation For Authorization

APIKeyHeader

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

JWTHeader

  • Type: API key
  • API key parameter name: X-Authorization-JWT
  • Location: HTTP header

Author