zipmoney / merchantapi-php
Installs: 177 755
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 9
Forks: 7
Open Issues: 2
Requires
- php: >=5.3
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- phpunit/phpunit: ^5.0
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-10-29 05:04:53 UTC
README
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
Documentation For Models
- Address
- Authority
- CaptureChargeRequest
- Charge
- ChargeCollection
- ChargeOrder
- Checkout
- CheckoutConfiguration
- CheckoutFeatures
- CheckoutFeaturesTokenisation
- CheckoutOrder
- CreateChargeRequest
- CreateCheckoutRequest
- CreateCheckoutRequestFeatures
- CreateCheckoutRequestFeaturesTokenisation
- CreateRefundRequest
- CreateTokenRequest
- Customer
- ErrorResponse
- ErrorResponseError
- ErrorResponseErrorDetails
- InlineResponse200
- Metadata
- OrderItem
- OrderShipping
- OrderShippingTracking
- Refund
- Shopper
- ShopperStatistics
- Token
Documentation For Authorization
Authorization
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header