zipmoney_merchantapi 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc7fbec9ca15a7ea7dcfc1275bb0bd59595e44cc
+  data.tar.gz: 5a25a954c186d8491c194314fc7a37cdf3591e6b
+SHA512:
+  metadata.gz: 42f21a8e9f0e1516af44209c7e9f9759149e91bc158a1f4a731ac37456270d5f468a82932146555a7801b54ebe6c73d36594a572746da13ce40888e28f68104b
+  data.tar.gz: 3c356bfd538e75cc37ebd0d23c17e306cb602ec52b5ae1342b7e79ac76937c55aefd58002cfc215391e201a815fc0f6d54b6f8f10bcb8c80c0d35f20c0383204

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    zipmoney_merchantapi (1.0.0)
+      json (~> 1.8, >= 1.8.3)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.12)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    hashdiff (0.3.2)
+    json (1.8.6)
+    public_suffix (2.0.5)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.1.2)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  rake (~> 12.0.0)
+  rspec (~> 3.4, >= 3.4.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+  zipmoney_merchantapi!
+
+BUNDLED WITH
+   1.14.3

data/README.md

@@ -0,0 +1,128 @@
+# zip_money
+
+ZipMoney - the Ruby gem for the Merchant API
+
+ZipMoney Merchant API Initial build
+
+- API version: 2017-03-01
+- Package version: 1.0.1
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build zipmoney_merchantapi.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./zipmoney_merchantapi.gem
+```
+(for development, run `gem install --dev ./zipmoney_merchantapi.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'zipmoney_merchantapi', '~> 1.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'zipmoney_merchantapi', :git => 'https://github.com/zipMoney/merchantapi-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'zipmoney_merchantapi'
+
+# Setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ZipMoney::ChargesApi* | [**charges_cancel**](docs/ChargesApi.md#charges_cancel) | **POST** /charges/{id}/cancel | Cancel a charge
+*ZipMoney::ChargesApi* | [**charges_capture**](docs/ChargesApi.md#charges_capture) | **POST** /charges/{id}/capture | Capture a charge
+*ZipMoney::ChargesApi* | [**charges_create**](docs/ChargesApi.md#charges_create) | **POST** /charges | Create a charge
+*ZipMoney::ChargesApi* | [**charges_list**](docs/ChargesApi.md#charges_list) | **GET** /charges | List charges
+*ZipMoney::ChargesApi* | [**charges_retrieve**](docs/ChargesApi.md#charges_retrieve) | **GET** /charges/{id} | Retrieve a charge
+*ZipMoney::CheckoutsApi* | [**checkouts_create**](docs/CheckoutsApi.md#checkouts_create) | **POST** /checkouts | Create a checkout
+*ZipMoney::CheckoutsApi* | [**checkouts_get**](docs/CheckoutsApi.md#checkouts_get) | **GET** /checkouts/{id} | Retrieve a checkout
+*ZipMoney::CustomersApi* | [**customers_get**](docs/CustomersApi.md#customers_get) | **GET** /customers/{id} | Retrieve customer
+*ZipMoney::CustomersApi* | [**customers_list**](docs/CustomersApi.md#customers_list) | **GET** /customers | List customers
+*ZipMoney::RefundsApi* | [**refunds_create**](docs/RefundsApi.md#refunds_create) | **POST** /refunds | Create a refund
+*ZipMoney::RefundsApi* | [**refunds_list**](docs/RefundsApi.md#refunds_list) | **GET** /refunds | List refunds
+*ZipMoney::RefundsApi* | [**refunds_retrieve**](docs/RefundsApi.md#refunds_retrieve) | **GET** /refunds/{id} | Retrieve a refund
+*ZipMoney::SettlementsApi* | [**settlements_get**](docs/SettlementsApi.md#settlements_get) | **GET** /settlements/{id} | Retrieve a settlement
+*ZipMoney::SettlementsApi* | [**settlements_list**](docs/SettlementsApi.md#settlements_list) | **GET** /settlements | List settlements
+*ZipMoney::TokensApi* | [**tokens_create**](docs/TokensApi.md#tokens_create) | **POST** /tokens | Create token
+
+
+## Documentation for Models
+
+ - [ZipMoney::Address](docs/Address.md)
+ - [ZipMoney::Authority](docs/Authority.md)
+ - [ZipMoney::CaptureChargeRequest](docs/CaptureChargeRequest.md)
+ - [ZipMoney::Charge](docs/Charge.md)
+ - [ZipMoney::ChargeCollection](docs/ChargeCollection.md)
+ - [ZipMoney::ChargeOrder](docs/ChargeOrder.md)
+ - [ZipMoney::Checkout](docs/Checkout.md)
+ - [ZipMoney::CheckoutConfiguration](docs/CheckoutConfiguration.md)
+ - [ZipMoney::CheckoutFeatures](docs/CheckoutFeatures.md)
+ - [ZipMoney::CheckoutFeaturesTokenisation](docs/CheckoutFeaturesTokenisation.md)
+ - [ZipMoney::CheckoutOrder](docs/CheckoutOrder.md)
+ - [ZipMoney::CreateChargeRequest](docs/CreateChargeRequest.md)
+ - [ZipMoney::CreateCheckoutRequest](docs/CreateCheckoutRequest.md)
+ - [ZipMoney::CreateCheckoutRequestFeatures](docs/CreateCheckoutRequestFeatures.md)
+ - [ZipMoney::CreateCheckoutRequestFeaturesTokenisation](docs/CreateCheckoutRequestFeaturesTokenisation.md)
+ - [ZipMoney::CreateRefundRequest](docs/CreateRefundRequest.md)
+ - [ZipMoney::CreateTokenRequest](docs/CreateTokenRequest.md)
+ - [ZipMoney::Customer](docs/Customer.md)
+ - [ZipMoney::ErrorResponse](docs/ErrorResponse.md)
+ - [ZipMoney::ErrorResponseError](docs/ErrorResponseError.md)
+ - [ZipMoney::ErrorResponseErrorDetails](docs/ErrorResponseErrorDetails.md)
+ - [ZipMoney::InlineResponse200](docs/InlineResponse200.md)
+ - [ZipMoney::Metadata](docs/Metadata.md)
+ - [ZipMoney::OrderItem](docs/OrderItem.md)
+ - [ZipMoney::OrderShipping](docs/OrderShipping.md)
+ - [ZipMoney::OrderShippingTracking](docs/OrderShippingTracking.md)
+ - [ZipMoney::Refund](docs/Refund.md)
+ - [ZipMoney::Shopper](docs/Shopper.md)
+ - [ZipMoney::ShopperStatistics](docs/ShopperStatistics.md)
+ - [ZipMoney::Token](docs/Token.md)
+
+
+## Documentation for Authorization
+
+
+### Authorization
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Address.md

@@ -0,0 +1,15 @@
+# ZipMoney::Address
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line1** | **String** | The first line in the address | 
+**line2** | **String** | The (optional) second address line | [optional] 
+**city** | **String** | The address city | 
+**state** | **String** | The state or province | 
+**postal_code** | **String** | The post or zip code | 
+**country** | **String** | The ISO-3166 country code. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. | 
+**first_name** | **String** | The recipient's first name | [optional] 
+**last_name** | **String** | The recipient's last name | [optional] 
+
+

data/docs/Authority.md

@@ -0,0 +1,9 @@
+# ZipMoney::Authority
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of authority (checkout_id, account_token, store_code) | 
+**value** | **String** | The authority value/token | 
+
+

data/docs/CaptureChargeRequest.md

@@ -0,0 +1,8 @@
+# ZipMoney::CaptureChargeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Amount can be less than or equal to the previously authorised amount | 
+
+

data/docs/Charge.md

@@ -0,0 +1,17 @@
+# ZipMoney::Charge
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**reference** | **String** |  | [optional] 
+**amount** | **Float** |  | 
+**currency** | **String** |  | 
+**state** | **String** |  | 
+**captured_amount** | **Float** |  | 
+**refunded_amount** | **Float** | The amount of the charge that has been refunded  | 
+**created_date** | **DateTime** |  | 
+**order** | [**ChargeOrder**](ChargeOrder.md) |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+
+

data/docs/ChargeCollection.md

@@ -0,0 +1,8 @@
+# ZipMoney::ChargeCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Charge>**](Charge.md) |  | 
+
+

data/docs/ChargeOrder.md

@@ -0,0 +1,11 @@
+# ZipMoney::ChargeOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **String** | The order id in the eCommerce system | [optional] 
+**shipping** | [**OrderShipping**](OrderShipping.md) |  | 
+**items** | [**Array<OrderItem>**](OrderItem.md) | The order item breakdown | [optional] 
+**cart_reference** | **String** | The shopping cart reference id | [optional] 
+
+

data/docs/ChargesApi.md

@@ -0,0 +1,307 @@
+# ZipMoney::ChargesApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**charges_cancel**](ChargesApi.md#charges_cancel) | **POST** /charges/{id}/cancel | Cancel a charge
+[**charges_capture**](ChargesApi.md#charges_capture) | **POST** /charges/{id}/capture | Capture a charge
+[**charges_create**](ChargesApi.md#charges_create) | **POST** /charges | Create a charge
+[**charges_list**](ChargesApi.md#charges_list) | **GET** /charges | List charges
+[**charges_retrieve**](ChargesApi.md#charges_retrieve) | **GET** /charges/{id} | Retrieve a charge
+
+
+# **charges_cancel**
+> Charge charges_cancel(id, opts)
+
+Cancel a charge
+
+Cancels an authorised charge.  | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | invalid_state | The charge is not in authorised state |
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::ChargesApi.new
+
+id = "id_example" # String | The id of the authorised charge
+
+opts = { 
+  idempotency_key: "idempotency_key_example" # String | The unique idempotency key.
+}
+
+begin
+  #Cancel a charge
+  result = api_instance.charges_cancel(id, opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling ChargesApi->charges_cancel: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the authorised charge | 
+ **idempotency_key** | **String**| The unique idempotency key. | [optional] 
+
+### Return type
+
+[**Charge**](Charge.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/javascript
+
+
+
+# **charges_capture**
+> Charge charges_capture(id, opts)
+
+Capture a charge
+
+| Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | amount_invalid | Capture amount greater than authorised amount | | invalid_state | The charge is not in authorised state |
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::ChargesApi.new
+
+id = "id_example" # String | The id of the authorised charge
+
+opts = { 
+  body: ZipMoney::CaptureChargeRequest.new, # CaptureChargeRequest | 
+  idempotency_key: "idempotency_key_example" # String | The unique idempotency key.
+}
+
+begin
+  #Capture a charge
+  result = api_instance.charges_capture(id, opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling ChargesApi->charges_capture: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the authorised charge | 
+ **body** | [**CaptureChargeRequest**](CaptureChargeRequest.md)|  | [optional] 
+ **idempotency_key** | **String**| The unique idempotency key. | [optional] 
+
+### Return type
+
+[**Charge**](Charge.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/javascript
+
+
+
+# **charges_create**
+> Charge charges_create(opts)
+
+Create a charge
+
+Creates a #model:ehEN48PET29iNdex3 which represents a charge against a customer's account.  To execute this endpoint you must first obtain customer approval by implementing the #docTextSection:43C79g2JjeGs8AHWi as a part of your online store.  This endpoint will return 201 if successful otherwise 402 with a specific error response.  ## Capture or authorisation  A charge can be created as either an authorisation or an immediate capture. This can be controlled in the initial request to the charge.  In most cases you will want to immediately capture the payment, this will mark the debit for settlement into your account the very same day and will immediately deduct the funds from the customer's account.  In some cases you may wish to delay the settlement of funds until a later date, perhaps until the goods are shipped to the customer. In this scenario you should send { capture: false } in the request to the #endpoint:dtmp3HxaHKjewvvGW endpoint and the charge will be created in an authorised state.  An authorised charge will place a hold for the specified amount on the customer's account in the form of a pending debit. Once authorised you are guaranteed the funds are available and awaiting a capture request to the #endpoint:wReod3JtbzNutMSXj endpoint, at which point the charge will move to the captured state and the funds will be settled into your account. It is at this point the customer's interest free period will start if applicable for the selected account.  ## Specific error responses  If a charge was not able to be performed a \"402 - Request Failed\" status code will be returned as detailed in #docTextSection:fJYHM2ZKtEui8RrAM. The error object can contain more specific error reason codes, which are detailed below.  | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | account_insufficient_funds | Customer does not have sufficient funds to perform the charge | | account_inoperative | The account is in arrears or closed and cannot be charged | | account_locked | The account is locked | | amount_invalid | The amount provided does not match the approved checkout amount | | fraud_check | Fraud checks resulted in payment failure |
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::ChargesApi.new
+
+opts = { 
+  body: ZipMoney::CreateChargeRequest.new, # CreateChargeRequest | 
+  idempotency_key: "idempotency_key_example" # String | The unique idempotency key.
+}
+
+begin
+  #Create a charge
+  result = api_instance.charges_create(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling ChargesApi->charges_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateChargeRequest**](CreateChargeRequest.md)|  | [optional] 
+ **idempotency_key** | **String**| The unique idempotency key. | [optional] 
+
+### Return type
+
+[**Charge**](Charge.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **charges_list**
+> ChargeCollection charges_list(opts)
+
+List charges
+
+Lists all charges matching search criteria.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::ChargesApi.new
+
+opts = { 
+  state: "state_example", # String | The state filter
+  skip: 0, # Integer | Number of items to skip when paging
+  limit: 100, # Integer | Number of items to retrieve when paging
+  expand: "expand_example" # String | Allows expanding related entities in the response. Only valid entry is 'customer'
+}
+
+begin
+  #List charges
+  result = api_instance.charges_list(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling ChargesApi->charges_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | **String**| The state filter | [optional] 
+ **skip** | **Integer**| Number of items to skip when paging | [optional] [default to 0]
+ **limit** | **Integer**| Number of items to retrieve when paging | [optional] [default to 100]
+ **expand** | **String**| Allows expanding related entities in the response. Only valid entry is 'customer' | [optional] 
+
+### Return type
+
+[**ChargeCollection**](ChargeCollection.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+
+# **charges_retrieve**
+> Charge charges_retrieve(id, opts)
+
+Retrieve a charge
+
+Retrieve details of a previously created charge.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::ChargesApi.new
+
+id = "id_example" # String | The id of the charge
+
+opts = { 
+  expand: "expand_example" # String | Allows expanding related entities in the response. Only valid entry is 'customer'
+}
+
+begin
+  #Retrieve a charge
+  result = api_instance.charges_retrieve(id, opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling ChargesApi->charges_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the charge | 
+ **expand** | **String**| Allows expanding related entities in the response. Only valid entry is 'customer' | [optional] 
+
+### Return type
+
+[**Charge**](Charge.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+