mollie-api-ruby 3.1.5 → 4.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d4dd143310a3cb0cac754c9fe18a688c9c2c11823cf5b24a2a1fcae781051614
-  data.tar.gz: '026965173ffbe4a828adb04c4c4be8222987c482db21d75f6098d1e4aa8af2ae'
+SHA1:
+  metadata.gz: 2139d0d55616baeeaf00a1ae05206e2ec5db8da5
+  data.tar.gz: 61184bdd17e9cef70da234a3c5561403c13929b7
 SHA512:
-  metadata.gz: baee58a7d1c413f720adec1e7f1d98b7c952958947bf53a6828517d33855edadd1a2f376383a5dd32a2cad54bc38edf684da39f52f1169bd14815d3ef8b05ea3
-  data.tar.gz: a58d95cbdf3057ca82d9ac1a3c3b651950aa2475b321fa314ca0373ef989b4f4e696f0f7caa716e93cf3ffc33e962f2cf46379c08dd85fb560e4cca364276e2f
+  metadata.gz: e143c49e7e9f03d70a46a826f1704856544237b0d9848cfeb2e3ee8ee1ab26f4c12e43818e1d8f58cfd8b7864d2e97c958ed15ebcc5c92d45b9869ba5fdfb081
+  data.tar.gz: 21414570b0a4dca58b1add62a8765e6c7463e791b5d6b7540e1047e0a77f87815f36673be9b30c8b7ed6c3fe2d25af01ca2f11e84773a51c786920ca0f7d3c91

data/.travis.yml

@@ -1,13 +1,10 @@
 language: ruby
 before_install: gem install bundler
 rvm:
- - 2.0.0
  - 2.1
  - 2.2
  - 2.3.0
 matrix:
-  allow_failures:
-  - rvm: 2.0.0
 deploy:
   provider: rubygems
   api_key:

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 All notable changes to this project will be documented in this file.
 
+#### 4.0 - 2018-07-23
+
+  - Migrated to the v2 API
+    Refer to the [migration guide](/docs/migration_v3_x.md) for a complete list of changes
+  - Dropped Ruby 2.0.0 support.
+
 #### 3.1.0 - ....
   - Removed old api
 

data/README.md

@@ -1,23 +1,25 @@
 ![Mollie](https://www.mollie.nl/files/Mollie-Logo-Style-Small.png)
 
-# LOOKING FOR VERSION v2.2.X README [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/2.2.x) #
+# Mollie API client for Ruby
 
-# Mollie API client for Ruby #
+> LOOKING FOR VERSION v2.2.X README? [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/2.2.x)
+
+> LOOKING FOR VERSION v3.1.X README? [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/3.1.x)
 
 [![Gem Version](https://badge.fury.io/rb/mollie-api-ruby.svg)](https://badge.fury.io/rb/mollie-api-ruby)
 [![](https://travis-ci.org/mollie/mollie-api-ruby.png)](https://travis-ci.org/mollie/mollie-api-ruby)
 
-Accepting [iDEAL](https://www.mollie.com/ideal/), [Bancontact/Mister Cash](https://www.mollie.com/mistercash/), [SOFORT Banking](https://www.mollie.com/sofort/), [Creditcard](https://www.mollie.com/creditcard/), [SEPA Bank transfer](https://www.mollie.com/overboeking/), [SEPA Direct debit](https://www.mollie.com/directdebit/), [Bitcoin](https://www.mollie.com/bitcoin/), [PayPal](https://www.mollie.com/paypal/), [KBC/CBC Payment Button](https://www.mollie.com/kbccbc/), [Belfius Direct Net](https://www.mollie.com/belfiusdirectnet/), [paysafecard](https://www.mollie.com/paysafecard/) and [ING Home’Pay](https://www.mollie.com/ing-homepay/) online payments without fixed monthly costs or any punishing registration procedures. Just use the Mollie API to receive payments directly on your website or easily refund transactions to your customers.
+Accepting [iDEAL](https://www.mollie.com/en/payments/ideal), [Bancontact](https://www.mollie.com/en/payments/bancontact), [SOFORT Banking](https://www.mollie.com/en/payments/sofort), [Creditcard](https://www.mollie.com/en/payments/credit-card), [SEPA Bank transfer](https://www.mollie.com/en/payments/bank-transfer), [SEPA Direct debit](https://www.mollie.com/en/payments/direct-debit), [Bitcoin](https://www.mollie.com/en/payments/bitcoin), [PayPal](https://www.mollie.com/en/payments/paypal), [KBC/CBC Payment Button](https://www.mollie.com/en/payments/kbc-cbc), [Belfius Direct Net](https://www.mollie.com/en/payments/belfius), [paysafecard](https://www.mollie.com/en/payments/paysafecard), [ING Home’Pay](https://www.mollie.com/en/payments/ing-homepay), [Gift cards](https://www.mollie.com/en/payments/gift-cards), [EPS](https://www.mollie.com/en/payments/eps) and [Giropay](https://www.mollie.com/en/payments/giropay) online payments without fixed monthly costs or any punishing registration procedures. Just use the Mollie API to receive payments directly on your website or easily refund transactions to your customers.
 
-## Requirements ##
+## Requirements
 To use the Mollie API client, the following things are required:
 
-+ Get yourself a free [Mollie account](https://www.mollie.nl/aanmelden). No sign up costs.
-+ Create a new [Website profile](https://www.mollie.nl/beheer/account/profielen/) to generate API keys (live and test mode) and setup your webhook.
++ Get yourself a free [Mollie account](https://www.mollie.com/dashboard/signup). No sign up costs.
++ Create a new [Website profile](https://www.mollie.com/dashboard/settings/profiles) to generate API keys (live and test mode) and setup your webhook.
 + Now you're ready to use the Mollie API client in test mode.
 + In order to accept payments in live mode, payment methods must be activated in your account. Follow [a few of steps](https://www.mollie.nl/beheer/diensten), and let us handle the rest.
 
-## Installation ##
+## Installation
 
 By far the easiest way to install the Mollie API client is to install it with [gem](http://rubygems.org/).
 
@@ -30,7 +32,7 @@ $ gem install mollie-api-ruby
 
 You may also git checkout or [download all the files](https://github.com/mollie/mollie-api-ruby/archive/master.zip), and include the Mollie API client manually.
 
-## How to receive payments ##
+## How to receive payments
 
 To successfully receive a payment, these steps should be implemented:
 
@@ -40,9 +42,9 @@ To successfully receive a payment, these steps should be implemented:
 
 3. The customer returns, and should be satisfied to see that the order was paid and is now being processed.
 
-## Getting started ##
+## Getting started
 
-Requiring the Mollie API Client. *Not required when used with a Gemfile*
+Require the Mollie API Client. *Not required when used with a Gemfile*
 
 ```ruby
 require 'mollie-api-ruby'
@@ -56,20 +58,20 @@ Mollie::Client.configure do |config|
 end
 ```
 
-You can also include the API Key in each request you make, for instance if you are using the Connect API
+You can also include the API Key in each request you make, for instance if you are using the Connect API:
 
 ```ruby
-Mollie::Payment.get("pay-id", api_key: '<your-api-key>')
+Mollie::Payment.get('pay-id', api_key: '<your-api-key>')
 ```
 
-If you need to do multiple calls with the same API Key, use the following helper
+If you need to do multiple calls with the same API Key, use the following helper:
 
 ```ruby
 Mollie::Client.with_api_key('<your-api-key>') do
   mandates = Mollie::Customer::Mandate.all(customer_id: params[:customer_id])
   if mandates.any?
     payment = Mollie::Payment.create(
-      amount:       10.00,
+      amount:       { value: '10.00', currency: 'EUR' },
       description:  'My first API payment',
       redirect_url: 'https://webshop.example.org/order/12345/',
       webhook_url:  'https://webshop.example.org/mollie-webhook/'
@@ -78,18 +80,23 @@ Mollie::Client.with_api_key('<your-api-key>') do
 end
 ```
 
-Creating a new payment.
+### Creating a new payment
 
 ```ruby
 payment = Mollie::Payment.create(
-  amount:       10.00,
+  amount:       { value: '10.00', currency: 'EUR' },
   description:  'My first API payment',
   redirect_url: 'https://webshop.example.org/order/12345/',
   webhook_url:  'https://webshop.example.org/mollie-webhook/'
 )
 ```
 
-Retrieving a payment.
+**Note**: If you specify an `amount`, you must specify the *correct* number of decimals.
+We strongly recommend sending `value `as a string. Note that even though most currencies
+use two decimals, some use three or none, like `JPY`. All amounts returned in the v2
+API will use this format.
+
+### Retrieving a payment
 
 ```ruby
 payment = Mollie::Payment.get(payment.id)
@@ -99,127 +106,64 @@ if payment.paid?
 end
 ```
 
-### Refunding payments ###
+### Refunding payments
 
 The API also supports refunding payments. Note that there is no confirmation and that all refunds are immediate and
-definitive. Refunds are only supported for iDEAL, credit card and Bank Transfer payments. Other types of payments cannot
-be refunded through our API at the moment.
+definitive. Refunds are only supported for [certain payment methods](https://help.mollie.com/hc/en-us/articles/115000014489-How-do-I-refund-a-payment-to-one-of-my-consumers-).
 
 ```ruby
 payment = Mollie::Payment.get(payment.id)
-refund  = payment.refunds.create
+refund  = payment.refund!(amount: { value: '10.00', currency: 'EUR' })
 ```
 
-## Examples ##
-
-In order to run the examples first run `bundle install`
+### Pagination
 
-```
-$ cd mollie-api-ruby
-$ bundle install
-$ cd examples
-$ rackup
-```
+Fetching all objects of a resource can be convenient. At the same time,
+returning too many objects at once can be unpractical from a performance
+perspective. Doing so might be too much work for the Mollie API to generate, or
+for your website to process. The maximum number of objects returned is 250.
 
-## API documentation ##
-If you wish to learn more about the Ruby API, download the source code and run the Example app as follows:
-
-```
-$ git clone git@github.com:mollie/mollie-api-ruby.git
-$ cd mollie-api-ruby
-$ bundle
-$ cd examples
-$ API_KEY=test_xxxxxx rackup
-```
-You can then browse the swagger documentation on [http://localhost:9292](http://localhost:9292)
-
-If you wish to learn more about our API, please visit the [Mollie Developer Portal](https://www.mollie.com/developer/). API Documentation is available in both Dutch and English.
-
-## Migration from v2.2.x ##
-
-The version 2.2.x used a client that contained methods to call API methods on the mollie servers.
-The responses were converted in to Mollie objects and attributes could be retrieved.
-Version 3.1.x uses a more Resource oriented approach that fits better with the Active Record principle.
-Instead of calling the methods on the client, you now use the Resource class or instance to call the API methods.
-
-You can now require the mollie client by using the gem name.
-If you are using bundler and Rails you don't even need to require it anymore
+For this reason the Mollie API only returns a subset of the requested set of
+objects. In other words, the Mollie API chops the result of a certain API method
+call into pages you’re able to programmatically scroll through.
 
 ```ruby
-# require 'mollie/api/client'
-require 'mollie-api-ruby'
+payments = Mollie::Payment.all
+payments.next
+payments.previous
 ```
 
-Instead of creating a client with an API key, the client is now stored as a threadsafe singleton object.
-Configuration can now be simplified by adding a global configure block in a Rails initializer or a Rack loader file.
+## Upgrading
 
+* [Migration from v2.2.x](docs/migration_v2_2_x.md)
+* [Migration from v3.x](docs/migration_v3_x.md)
 
-```ruby
-# mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
- 
-# config/initializers/mollie.rb or in your app.rb 
-Mollie::Client.configure do |config|
-  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
-end
-
-# You may also pass a specific API key in the params for each request.
-payment = Mollie::Payment.get(api_key: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
-
-# Or in a Rails around filter
-around_action :set_mollie_key
-
-def set_mollie_key
-  Mollie::Client.with_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM') do
-    yield
-  end
-end
- 
-```
-
-Change the client calls to Resource calls
+## API documentation ##
 
-```ruby
-# mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
-# payment = mollie.payments.create(
-#  amount:       10.00,
-#  description:  'My first API payment',
-#  redirect_url: 'https://webshop.example.org/order/12345/',
-#  webhook_url:  'https://webshop.example.org/mollie-webhook/'
-#)
- 
-payment = Mollie::Payment.create(
-  amount:       10.00,
-  description:  'My first API payment',
-  redirect_url: 'https://webshop.example.org/order/12345/',
-  webhook_url:  'https://webshop.example.org/mollie-webhook/'
-) 
-```
+If you wish to learn more about our API, please visit the [Mollie API Documentation](https://docs.mollie.com).
 
-The resources created are similar to the old resources but have an extra option to retrieve nested resources
+## Want to help us make our API client even better?
 
-```ruby
-# payment = mollie.payments.get(payment.id)
-# refund  = mollie.payments_refunds.with(payment).create
-payment = Mollie::Payment.get("id")
-refund = payment.refunds.create 
-```
+Want to help us make our API client even better? We take [pull requests](https://github.com/mollie/mollie-api-ruby/pulls?utf8=%E2%9C%93&q=is%3Apr), sure. But how would you like to contribute to a technology oriented organization? Mollie is hiring developers and system engineers. [Check out our vacancies](https://jobs.mollie.com/) or [get in touch](mailto:recruitment@mollie.com).
 
-## License ##
-[BSD (Berkeley Software Distribution) License](https://opensource.org/licenses/bsd-license.php).
-Copyright (c) 2014-2018, Mollie B.V.
+## License
+[BSD (Berkeley Software Distribution) License](https://opensource.org/licenses/bsd-license.php). Copyright (c) 2014-2018, Mollie B.V.
 
-## Support ##
+## Support
 Contact: [www.mollie.com](https://www.mollie.com) — info@mollie.com — +31 20-612 88 55
 
-+ [More information about iDEAL via Mollie](https://www.mollie.com/ideal/)
-+ [More information about credit card via Mollie](https://www.mollie.com/creditcard/)
-+ [More information about Bancontact/Mister Cash via Mollie](https://www.mollie.com/mistercash/)
-+ [More information about SOFORT Banking via Mollie](https://www.mollie.com/sofort/)
-+ [More information about SEPA Bank transfer via Mollie](https://www.mollie.com/banktransfer/)
-+ [More information about SEPA Direct debit via Mollie](https://www.mollie.com/directdebit/)
-+ [More information about Bitcoin via Mollie](https://www.mollie.com/bitcoin/)
-+ [More information about PayPal via Mollie](https://www.mollie.com/paypal/)
-+ [More information about KBC/CBC Payment Button via Mollie](https://www.mollie.com/kbccbc/)
-+ [More information about Belfius Direct Net via Mollie](https://www.mollie.com/belfiusdirectnet/)
-+ [More information about paysafecard via Mollie](https://www.mollie.com/paysafecard/)
-+ [More information about ING Home’Pay via Mollie](https://www.mollie.com/ing-homepay/)
++ [More information about iDEAL via Mollie](https://www.mollie.com/en/payments/ideal/)
++ [More information about Credit card via Mollie](https://www.mollie.com/en/payments/credit-card/)
++ [More information about Bancontact via Mollie](https://www.mollie.com/en/payments/bancontact/)
++ [More information about SOFORT Banking via Mollie](https://www.mollie.com/en/payments/sofort/)
++ [More information about SEPA Bank transfer via Mollie](https://www.mollie.com/en/payments/bank-transfer/)
++ [More information about SEPA Direct debit via Mollie](https://www.mollie.com/en/payments/direct-debit/)
++ [More information about Bitcoin via Mollie](https://www.mollie.com/en/payments/bitcoin/)
++ [More information about PayPal via Mollie](https://www.mollie.com/en/payments/paypal/)
++ [More information about KBC/CBC Payment Button via Mollie](https://www.mollie.com/en/payments/kbc-cbc/)
++ [More information about Belfius Direct Net via Mollie](https://www.mollie.com/en/payments/belfius)
++ [More information about paysafecard via Mollie](https://www.mollie.com/en/payments/paysafecard/)
++ [More information about ING Home’Pay via Mollie](https://www.mollie.com/en/payments/ing-homepay/)
++ [More information about Gift cards via Mollie](https://www.mollie.com/en/payments/gift-cards)
++ [More information about EPS via Mollie](https://www.mollie.com/en/payments/eps)
++ [More information about Giropay via Mollie](https://www.mollie.com/en/payments/giropay)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mollie"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+require "pp"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/migration_v2_2_x.md

@@ -0,0 +1,67 @@
+# Migration from v2.2.x
+
+The version 2.2.x used a client that contained methods to call API methods on the mollie servers.
+The responses were converted in to Mollie objects and attributes could be retrieved.
+Version 3.1.x uses a more Resource oriented approach that fits better with the Active Record principle.
+Instead of calling the methods on the client, you now use the Resource class or instance to call the API methods.
+
+You can now require the mollie client by using the gem name.
+If you are using bundler and Rails you don't even need to require it anymore.
+
+```ruby
+# require 'mollie/api/client'
+require 'mollie-api-ruby'
+```
+
+Instead of creating a client with an API key, the client is now stored as a threadsafe singleton object.
+Configuration can now be simplified by adding a global configure block in a Rails initializer or a Rack loader file.
+
+```ruby
+# mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
+
+# config/initializers/mollie.rb or in your app.rb
+Mollie::Client.configure do |config|
+  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
+end
+
+# You may also pass a specific API key in the params for each request.
+payment = Mollie::Payment.get(api_key: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
+
+# Or in a Rails around filter
+around_action :set_mollie_key
+
+def set_mollie_key
+  Mollie::Client.with_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM') do
+    yield
+  end
+end
+
+```
+
+Change the client calls to Resource calls
+
+```ruby
+# mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
+# payment = mollie.payments.create(
+#  amount:       10.00,
+#  description:  'My first API payment',
+#  redirect_url: 'https://webshop.example.org/order/12345/',
+#  webhook_url:  'https://webshop.example.org/mollie-webhook/'
+#)
+
+payment = Mollie::Payment.create(
+  amount:       { amount: '10.00', currency: 'EUR' },
+  description:  'My first API payment',
+  redirect_url: 'https://webshop.example.org/order/12345/',
+  webhook_url:  'https://webshop.example.org/mollie-webhook/'
+)
+```
+
+The resources created are similar to the old resources but have an extra option to retrieve nested resources
+
+```ruby
+# payment = mollie.payments.get(payment.id)
+# refund  = mollie.payments_refunds.with(payment).create
+payment = Mollie::Payment.get("id")
+refund = payment.refunds.create({ amount: '10.00', currency: 'EUR' })
+```

data/docs/migration_v3_x.md

@@ -0,0 +1,227 @@
+# Migration from v3.x
+
+Please refer to [Migrating from v1 to v2](https://docs.mollie.com/migrating-v1-to-v2)
+for a general overview of the switch to Mollie v2 API.
+
+Code examples can be found in the [/examples](/examples) folder.
+
+## Nested resources
+
+Several helper methods were added to retrieve nested resources. Nested resources
+now return a collection or the object itself:
+
+```ruby
+payment  = Mollie::Payment.get('tr_7UhSN1zuXS')
+refunds  = payment.refunds # => Mollie::List
+customer = payment.customer # => Mollie::Customer
+```
+
+## Multi-currency
+
+The Ruby client v4 adds support for multi-currency. All amounts are parsed as a
+`Mollie::Amount` object.
+
+```ruby
+payment = Mollie::Payment.create(
+  amount:      { value: '42.10', currency: 'EUR' },
+  description: 'My first payment'
+)
+
+payment = Mollie::Payment.get('tr_7UhSN1zuXS')
+payment.amount # => Mollie::Amount
+payment.amount.value # => 42.10 # BigDecimal
+payment.amount.currency # => 'EUR'
+```
+
+**Note**: If you specify an amount, you must specify the *correct* number of decimals.
+We strongly recommend sending value as a string. Note that even though most currencies
+use two decimals, some use three or none, like JPY. All amounts returned in the v2
+API will use this format.
+
+## Error handling
+
+A `RequestError` is raised for all API error responses. The `RequestError` object
+contains the following details:
+
+* `status`: HTTP status code of the response
+* `title`: Title of the error
+* `detail`: Extra information about the error
+* `field`: Field of your request that is likely causing the error. Only available in case of 422 Unprocessable Entity errors.
+* `links`: Links to relevant API documentation
+
+# Changes in Mollie API v2
+
+* The identifier for the payment method Bancontact has been renamed from `mistercash` to `bancontact`
+* Some resources support embedding of related sub-resources. For instance, when retrieving a payment
+any refunds can be embedded by using the `embed: 'refunds'` option. See the
+[Get payment documentation](https://docs.mollie.com/reference/v2/payments-api/get-payment) for more information.
+
+## Locale changes
+
+Only full locales with both the language and the country code are supported,
+e.g. `nl_NL`. Locales are always returned as full locales.
+
+## Combined date and time fields
+
+Formatting of fields such as `created_at` has been updated to be strictly
+compliant to ISO-8601 formatting. Example value: `2018-03-05T12:30:10+00:00`.
+
+## Changes in the Payments API
+
+The following changes have been made in regards to the status of payments:
+
+* The statuses `paidout`, `refunded` and `charged_back` have been removed
+* The status `cancelled` has been renamed to `canceled` (US English spelling)
+* The individual billing and shipping address parameters that can be used when
+creating a credit card or PayPal payment have been replaced by address objects.
+Instead of passing `billing_address`, `billing_postal`, `billing_city`, `billing_region`
+and/or `billing_country` (or the equivalent fields starting with `shipping`), one
+should now pass a `billing_address` (and/or `shipping_address`) object, as follows:
+
+```ruby
+{
+  amount: { value: '100.00', currency: 'USD' },
+  description: 'My first payment',
+  billing_address: {
+    street_and_number: 'Dorpstraat 1',
+    postal_code: '1122 AA',
+    city: 'Amsterdam',
+    region: 'Noord-Holland',
+    country: 'NL'
+  }
+}
+```
+
+The following fields have been changed, renamed or moved:
+
+* `cancelled_datetime` has been renamed to `canceled_at`
+* `created_datetime` has been renamed to `created_at`
+* `expired_datetime` has been renamed to `expired_at`
+* `failed_datetime` has been renamed to `failed_at`
+* `paid_datetime` has been renamed to `paid_at`
+* `recurring_type` has been renamed to `sequence_type`. This field is now always present. A one-off payment (not the start of a recurring sequence and not a recurring payment) will have the value `oneoff`.
+* `failure_reason` has been moved from the Payment resource to the credit card detail object, and no longer available for Bancontact payments.
+* `details.bitcoin_amount` is now an amount object in the XBT currency
+
+The following fields have been removed:
+
+* `expiry_period` has been removed from the Payment resource. You can use `expires_at` which contains the same information.
+* `issuer` has been removed from the Payment resource. You can however, still pass it to the Create payment API.
+* `details.bitcoin_rate` has been removed from the Bitcoin detail object
+* `details.card_country` has been removed from the credit card detail object
+* The option to include the settlement using the `include` query string parameter has been removed
+
+These new fields have been added:
+
+* `settlement_amount` has been added to the responses of the Payments API, the Refunds API and the Chargebacks API. This optional field will contain the amount that will be settled to your account, converted to the currency your account is settled in. It follows the same syntax as the `amount` property.
+  * Note that for refunds and chargebacks, the `value` key of `settlement_amount` will be negative.
+  * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards.
+* `links['status']` has been added to the responses for `banktransfer` payments. Your customer can check the status of their transfer at this URL.
+* `links['pay_online']` has been added to the responses for `banktransfer` payments. At this URL your customer can finish the payment using an alternative payment method also activated on your website profile.
+
+## Changes in the Refunds API
+
+The following fields have been changed, renamed or moved:
+
+* `amount` is now mandatory when creating a refund. You must specify both `amount.currency` and `amount.value`.
+* The `amount` field is now of the `amount` type and contains a `value` and a `currency`
+* `payment`, which contained the payment resource related to the refund, is no longer returned. Instead, the payment ID
+is returned by default, in the `payment_id` field. The payment resource can still easily be accessed using the `payment`
+helper method.
+
+These new fields have been added:
+
+* `settlement_amount` has been added. See the explanation of the [settlementAmount](https://docs.mollie.com/migrating-v1-to-v2#settlementamount) for the Payments API.
+
+## Changes in the Chargebacks API
+
+The following fields have been changed, renamed or moved:
+
+* The `amount` field is now of the `amount` type and contains a `value` and a `currency`
+* `chargeback_datetime` has been renamed to `created_at`
+* `reversed_datetime` has been renamed to `reversed_at`. This field is now only returned if the chargeback is reversed.
+* `payment`, which contained the payment ID related to the chargeback, has been renamed to `payment_id`. The payment resource can easily be accessed using the `payment` helper method.
+* Pagination has been removed, so all fields related to pagination are not available anymore. The list method will now return all chargebacks.
+
+These new fields have been added:
+
+* `settlement_amount` has been added. See the explanation of the [settlementAmount](https://docs.mollie.com/migrating-v1-to-v2#settlementamount) for the Payments API.
+
+## Changes in the Methods API
+
+The following fields have been changed, renamed or moved:
+
+* `amount` including `minimum` and `maximum` have been removed
+* Pagination has been removed, so all fields related to pagination are not available anymore. The list method will now return all payment methods.
+
+The following parameters have been changed or added:
+
+* The parameter `recurring_type` has been renamed to `sequence_type`. Possible values are `oneoff`, `first` or `recurring`.
+* The parameter `amount` has been added. This should be an object containing `value` and `currency`. Only payment methods that
+support the amount/currency will be returned.
+
+## Changes in the Issuers API
+
+The issuers API has been removed. Instead, you can get the issuers via the Get Method API using the `issuers` include.
+
+## Changes in the Customers API
+
+The following fields have been changed, renamed or moved:
+
+* `created_datetime` has been renamed to `created_at`
+* `recently_used_methods` has been removed
+
+## Changes in the Subscriptions API
+
+The following changes have been made in regards to the status of subscriptions:
+
+* Subscriptions that are canceled can be retrieved from the API
+* The `canceled` status is changed from British English to American English
+
+The following fields have been changed, renamed or moved:
+
+* `created_datetime` has been renamed to `created_at`
+* `cancelled_datetime` has been renamed to `canceled_at`, and is now only returned when the subscription is canceled
+
+## Changes in the Profiles API
+
+The following fields have been changed, renamed or removed:
+
+* `created_datetime` has been renamed to `created_at`
+* `updated_datetime` has been removed
+* `phone` is now formatted in E.164 formatting
+* The API keys subresource has been removed
+
+## Changes in the Settlements API
+
+The following fields have been changed, renamed or moved:
+
+* `created_datetime` has been renamed to `created_at`
+* `settled_datetime` has been renamed to `settled_at`
+* The fields `payment_ids`, `refund_ids` and `chargeback_ids` has been removed
+* All amounts have been changed to the `amount` type. Note that the `costs.amount`* fields can have more decimals than you would expect. The same goes for `rate.fixed`, which can contain fractional cents.
+* `amount.net`, `amount.vat` and `amount.gross` have been moved one level up as `amount_net`, `amount_vat` and `amount_gross`
+
+## Changes in the Mandates API
+
+The following fields have been changed, renamed or moved:
+
+* `created_datetime` has been renamed to `created_at`
+
+## Changes in the Organizations API
+
+The fields `country`, `registration_date` and `registration_type` have been removed.
+The field `address` is now an `OpenStruct` with address details. See
+[Address object](https://docs.mollie.com/guides/common-data-types#address-object).
+
+## Changes in the Permissions API
+
+The field `warning` has been removed.
+
+## Changes in the Invoice API
+
+* `issued_date` has been renamed to `issued_at`
+* `paid_date` has been renamed to `paid_at`
+* `due_date` has been renamed to `due_at`
+* `amount.net`, `amount.vat` and `amount.gross` have been moved one level up as
+`amount_net`, `amount_vat` and `amountGross`