Skip to content

Latest commit

 

History

History
147 lines (110 loc) · 5.41 KB

README.md

File metadata and controls

147 lines (110 loc) · 5.41 KB
Raw

zipMoney Payments Pty Ltd.

ZipMoney Merchant API Initial build

  • API version: 2017-03-01

Requirements

PHP 5.3 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/zipMoney/merchantapi-php.git"
    }
  ],
  "require": {
    "zipMoney/merchantapi-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer require 
phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: Authorization
\zipMoney\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
\zipMoney\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bearer');
\zipMoney\Configuration::getDefaultConfiguration()->setEnvironment('ENVIRONMENT HERE'); // Allowed values are  ( sandbox | production )
\zipMoney\Configuration::getDefaultConfiguration()->setPlatform('PLATFORM HERE'); // E.g. Magento/1.9.1.2

$api_instance = new zipMoney\Api\ChargesApi();
$id = "id_example"; // string | The id of the authorised charge
$idempotency_key = "idempotency_key_example"; // string | The unique idempotency key.

try {
    $result = $api_instance->chargesCancel($id, $idempotency_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChargesApi->chargesCancel: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.zipmoney.com.au/merchant/v1

Class Method HTTP request Description
ChargesApi chargesCancel POST /charges/{id}/cancel Cancel a charge
ChargesApi chargesCapture POST /charges/{id}/capture Capture a charge
ChargesApi chargesCreate POST /charges Create a charge
ChargesApi chargesList GET /charges List charges
ChargesApi chargesRetrieve GET /charges/{id} Retrieve a charge
CheckoutsApi checkoutsCreate POST /checkouts Create a checkout
CheckoutsApi checkoutsGet GET /checkouts/{id} Retrieve a checkout
CustomersApi customersGet GET /customers/{id} Retrieve customer
CustomersApi customersList GET /customers List customers
RefundsApi refundsCreate POST /refunds Create a refund
RefundsApi refundsList GET /refunds List refunds
RefundsApi refundsRetrieve GET /refunds/{id} Retrieve a refund
SettlementsApi settlementsGet GET /settlements/{id} Retrieve a settlement
SettlementsApi settlementsList GET /settlements List settlements
TokensApi tokensCreate POST /tokens Create token

Documentation For Models

Documentation For Authorization

Authorization

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author