adyen-ruby-api-library 1.2.0

data/docs/javascripts/prism.js

@@ -0,0 +1,5 @@
+/* PrismJS 1.14.0
+http://prismjs.com/download.html#themes=prism&languages=clike+ruby */
+var _self="undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{},Prism=function(){var e=/\blang(?:uage)?-([\w-]+)\b/i,t=0,n=_self.Prism={manual:_self.Prism&&_self.Prism.manual,disableWorkerMessageHandler:_self.Prism&&_self.Prism.disableWorkerMessageHandler,util:{encode:function(e){return e instanceof r?new r(e.type,n.util.encode(e.content),e.alias):"Array"===n.util.type(e)?e.map(n.util.encode):e.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/\u00a0/g," ")},type:function(e){return Object.prototype.toString.call(e).match(/\[object (\w+)\]/)[1]},objId:function(e){return e.__id||Object.defineProperty(e,"__id",{value:++t}),e.__id},clone:function(e,t){var r=n.util.type(e);switch(t=t||{},r){case"Object":if(t[n.util.objId(e)])return t[n.util.objId(e)];var a={};t[n.util.objId(e)]=a;for(var l in e)e.hasOwnProperty(l)&&(a[l]=n.util.clone(e[l],t));return a;case"Array":if(t[n.util.objId(e)])return t[n.util.objId(e)];var a=[];return t[n.util.objId(e)]=a,e.forEach(function(e,r){a[r]=n.util.clone(e,t)}),a}return e}},languages:{extend:function(e,t){var r=n.util.clone(n.languages[e]);for(var a in t)r[a]=t[a];return r},insertBefore:function(e,t,r,a){a=a||n.languages;var l=a[e];if(2==arguments.length){r=arguments[1];for(var i in r)r.hasOwnProperty(i)&&(l[i]=r[i]);return l}var o={};for(var s in l)if(l.hasOwnProperty(s)){if(s==t)for(var i in r)r.hasOwnProperty(i)&&(o[i]=r[i]);o[s]=l[s]}return n.languages.DFS(n.languages,function(t,n){n===a[e]&&t!=e&&(this[t]=o)}),a[e]=o},DFS:function(e,t,r,a){a=a||{};for(var l in e)e.hasOwnProperty(l)&&(t.call(e,l,e[l],r||l),"Object"!==n.util.type(e[l])||a[n.util.objId(e[l])]?"Array"!==n.util.type(e[l])||a[n.util.objId(e[l])]||(a[n.util.objId(e[l])]=!0,n.languages.DFS(e[l],t,l,a)):(a[n.util.objId(e[l])]=!0,n.languages.DFS(e[l],t,null,a)))}},plugins:{},highlightAll:function(e,t){n.highlightAllUnder(document,e,t)},highlightAllUnder:function(e,t,r){var a={callback:r,selector:'code[class*="language-"], [class*="language-"] code, code[class*="lang-"], [class*="lang-"] code'};n.hooks.run("before-highlightall",a);for(var l,i=a.elements||e.querySelectorAll(a.selector),o=0;l=i[o++];)n.highlightElement(l,t===!0,a.callback)},highlightElement:function(t,r,a){for(var l,i,o=t;o&&!e.test(o.className);)o=o.parentNode;o&&(l=(o.className.match(e)||[,""])[1].toLowerCase(),i=n.languages[l]),t.className=t.className.replace(e,"").replace(/\s+/g," ")+" language-"+l,t.parentNode&&(o=t.parentNode,/pre/i.test(o.nodeName)&&(o.className=o.className.replace(e,"").replace(/\s+/g," ")+" language-"+l));var s=t.textContent,u={element:t,language:l,grammar:i,code:s};if(n.hooks.run("before-sanity-check",u),!u.code||!u.grammar)return u.code&&(n.hooks.run("before-highlight",u),u.element.textContent=u.code,n.hooks.run("after-highlight",u)),n.hooks.run("complete",u),void 0;if(n.hooks.run("before-highlight",u),r&&_self.Worker){var g=new Worker(n.filename);g.onmessage=function(e){u.highlightedCode=e.data,n.hooks.run("before-insert",u),u.element.innerHTML=u.highlightedCode,a&&a.call(u.element),n.hooks.run("after-highlight",u),n.hooks.run("complete",u)},g.postMessage(JSON.stringify({language:u.language,code:u.code,immediateClose:!0}))}else u.highlightedCode=n.highlight(u.code,u.grammar,u.language),n.hooks.run("before-insert",u),u.element.innerHTML=u.highlightedCode,a&&a.call(t),n.hooks.run("after-highlight",u),n.hooks.run("complete",u)},highlight:function(e,t,a){var l={code:e,grammar:t,language:a};return n.hooks.run("before-tokenize",l),l.tokens=n.tokenize(l.code,l.grammar),n.hooks.run("after-tokenize",l),r.stringify(n.util.encode(l.tokens),l.language)},matchGrammar:function(e,t,r,a,l,i,o){var s=n.Token;for(var u in r)if(r.hasOwnProperty(u)&&r[u]){if(u==o)return;var g=r[u];g="Array"===n.util.type(g)?g:[g];for(var c=0;c<g.length;++c){var h=g[c],f=h.inside,d=!!h.lookbehind,m=!!h.greedy,p=0,y=h.alias;if(m&&!h.pattern.global){var v=h.pattern.toString().match(/[imuy]*$/)[0];h.pattern=RegExp(h.pattern.source,v+"g")}h=h.pattern||h;for(var b=a,k=l;b<t.length;k+=t[b].length,++b){var w=t[b];if(t.length>e.length)return;if(!(w instanceof s)){if(m&&b!=t.length-1){h.lastIndex=k;var _=h.exec(e);if(!_)break;for(var j=_.index+(d?_[1].length:0),P=_.index+_[0].length,A=b,x=k,O=t.length;O>A&&(P>x||!t[A].type&&!t[A-1].greedy);++A)x+=t[A].length,j>=x&&(++b,k=x);if(t[b]instanceof s)continue;I=A-b,w=e.slice(k,x),_.index-=k}else{h.lastIndex=0;var _=h.exec(w),I=1}if(_){d&&(p=_[1]?_[1].length:0);var j=_.index+p,_=_[0].slice(p),P=j+_.length,N=w.slice(0,j),S=w.slice(P),C=[b,I];N&&(++b,k+=N.length,C.push(N));var E=new s(u,f?n.tokenize(_,f):_,y,_,m);if(C.push(E),S&&C.push(S),Array.prototype.splice.apply(t,C),1!=I&&n.matchGrammar(e,t,r,b,k,!0,u),i)break}else if(i)break}}}}},tokenize:function(e,t){var r=[e],a=t.rest;if(a){for(var l in a)t[l]=a[l];delete t.rest}return n.matchGrammar(e,r,t,0,0,!1),r},hooks:{all:{},add:function(e,t){var r=n.hooks.all;r[e]=r[e]||[],r[e].push(t)},run:function(e,t){var r=n.hooks.all[e];if(r&&r.length)for(var a,l=0;a=r[l++];)a(t)}}},r=n.Token=function(e,t,n,r,a){this.type=e,this.content=t,this.alias=n,this.length=0|(r||"").length,this.greedy=!!a};if(r.stringify=function(e,t,a){if("string"==typeof e)return e;if("Array"===n.util.type(e))return e.map(function(n){return r.stringify(n,t,e)}).join("");var l={type:e.type,content:r.stringify(e.content,t,a),tag:"span",classes:["token",e.type],attributes:{},language:t,parent:a};if(e.alias){var i="Array"===n.util.type(e.alias)?e.alias:[e.alias];Array.prototype.push.apply(l.classes,i)}n.hooks.run("wrap",l);var o=Object.keys(l.attributes).map(function(e){return e+'="'+(l.attributes[e]||"").replace(/"/g,"&quot;")+'"'}).join(" ");return"<"+l.tag+' class="'+l.classes.join(" ")+'"'+(o?" "+o:"")+">"+l.content+"</"+l.tag+">"},!_self.document)return _self.addEventListener?(n.disableWorkerMessageHandler||_self.addEventListener("message",function(e){var t=JSON.parse(e.data),r=t.language,a=t.code,l=t.immediateClose;_self.postMessage(n.highlight(a,n.languages[r],r)),l&&_self.close()},!1),_self.Prism):_self.Prism;var a=document.currentScript||[].slice.call(document.getElementsByTagName("script")).pop();return a&&(n.filename=a.src,n.manual||a.hasAttribute("data-manual")||("loading"!==document.readyState?window.requestAnimationFrame?window.requestAnimationFrame(n.highlightAll):window.setTimeout(n.highlightAll,16):document.addEventListener("DOMContentLoaded",n.highlightAll))),_self.Prism}();"undefined"!=typeof module&&module.exports&&(module.exports=Prism),"undefined"!=typeof global&&(global.Prism=Prism);
+Prism.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/((?:\b(?:class|interface|extends|implements|trait|instanceof|new)\s+)|(?:catch\s+\())[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:if|else|while|do|for|return|in|instanceof|function|new|try|throw|catch|finally|null|break|continue)\b/,"boolean":/\b(?:true|false)\b/,"function":/[a-z0-9_]+(?=\()/i,number:/\b0x[\da-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/--?|\+\+?|!=?=?|<=?|>=?|==?=?|&&?|\|\|?|\?|\*|\/|~|\^|%/,punctuation:/[{}[\];(),.:]/};
+!function(e){e.languages.ruby=e.languages.extend("clike",{comment:[/#.*/,{pattern:/^=begin(?:\r?\n|\r)(?:.*(?:\r?\n|\r))*?=end/m,greedy:!0}],keyword:/\b(?:alias|and|BEGIN|begin|break|case|class|def|define_method|defined|do|each|else|elsif|END|end|ensure|false|for|if|in|module|new|next|nil|not|or|protected|private|public|raise|redo|require|rescue|retry|return|self|super|then|throw|true|undef|unless|until|when|while|yield)\b/});var n={pattern:/#\{[^}]+\}/,inside:{delimiter:{pattern:/^#\{|\}$/,alias:"tag"},rest:e.languages.ruby}};e.languages.insertBefore("ruby","keyword",{regex:[{pattern:/%r([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1[gim]{0,3}/,greedy:!0,inside:{interpolation:n}},{pattern:/%r\((?:[^()\\]|\\[\s\S])*\)[gim]{0,3}/,greedy:!0,inside:{interpolation:n}},{pattern:/%r\{(?:[^#{}\\]|#(?:\{[^}]+\})?|\\[\s\S])*\}[gim]{0,3}/,greedy:!0,inside:{interpolation:n}},{pattern:/%r\[(?:[^\[\]\\]|\\[\s\S])*\][gim]{0,3}/,greedy:!0,inside:{interpolation:n}},{pattern:/%r<(?:[^<>\\]|\\[\s\S])*>[gim]{0,3}/,greedy:!0,inside:{interpolation:n}},{pattern:/(^|[^\/])\/(?!\/)(\[.+?]|\\.|[^\/\\\r\n])+\/[gim]{0,3}(?=\s*($|[\r\n,.;})]))/,lookbehind:!0,greedy:!0}],variable:/[@$]+[a-zA-Z_]\w*(?:[?!]|\b)/,symbol:{pattern:/(^|[^:]):[a-zA-Z_]\w*(?:[?!]|\b)/,lookbehind:!0}}),e.languages.insertBefore("ruby","number",{builtin:/\b(?:Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Stat|Fixnum|Float|Hash|Integer|IO|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|String|Struct|TMS|Symbol|ThreadGroup|Thread|Time|TrueClass)\b/,constant:/\b[A-Z]\w*(?:[?!]|\b)/}),e.languages.ruby.string=[{pattern:/%[qQiIwWxs]?([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0,inside:{interpolation:n}},{pattern:/%[qQiIwWxs]?\((?:[^()\\]|\\[\s\S])*\)/,greedy:!0,inside:{interpolation:n}},{pattern:/%[qQiIwWxs]?\{(?:[^#{}\\]|#(?:\{[^}]+\})?|\\[\s\S])*\}/,greedy:!0,inside:{interpolation:n}},{pattern:/%[qQiIwWxs]?\[(?:[^\[\]\\]|\\[\s\S])*\]/,greedy:!0,inside:{interpolation:n}},{pattern:/%[qQiIwWxs]?<(?:[^<>\\]|\\[\s\S])*>/,greedy:!0,inside:{interpolation:n}},{pattern:/("|')(?:#\{[^}]+\}|\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0,inside:{interpolation:n}}]}(Prism);

data/docs/javascripts/scale.fix.js

@@ -0,0 +1,17 @@
+var metas = document.getElementsByTagName('meta');
+var i;
+if (navigator.userAgent.match(/iPhone/i)) {
+  for (i=0; i<metas.length; i++) {
+    if (metas[i].name == "viewport") {
+      metas[i].content = "width=device-width, minimum-scale=1.0, maximum-scale=1.0";
+    }
+  }
+  document.addEventListener("gesturestart", gestureStart, false);
+}
+function gestureStart() {
+  for (i=0; i<metas.length; i++) {
+    if (metas[i].name == "viewport") {
+      metas[i].content = "width=device-width, minimum-scale=0.25, maximum-scale=1.6";
+    }
+  }
+}

data/docs/marketpay.html

@@ -0,0 +1,169 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for ruby</p>
+
+      <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        <h2 id="availablemethods">Available methods</h2>
+
+        <h4 id="marketpayaccount">marketpay.account:</h4>
+
+        <ul>
+        <li>create_account_holder</li>
+
+        <li>get_account_holder</li>
+
+        <li>update_account_holder</li>
+
+        <li>update_account_holder_state</li>
+
+        <li>suspend_account_holder</li>
+
+        <li>un_suspend_account_holder</li>
+
+        <li>close_account_holder</li>
+
+        <li>create_account</li>
+
+        <li>update_account</li>
+
+        <li>close_account</li>
+
+        <li>upload_document</li>
+
+        <li>get_uploaded_documents</li>
+
+        <li>delete_bank_accounts</li>
+
+        <li>delete_shareholders</li>
+        </ul>
+
+        <h4 id="marketpayfund">marketpay.fund:</h4>
+
+        <ul>
+        <li>account_holder_balance</li>
+
+        <li>account_holder_transaction_list</li>
+
+        <li>payout_account_holder</li>
+
+        <li>transfer_funds</li>
+
+        <li>setup_beneficiary</li>
+
+        <li>refund_not_paid_out_transfers</li>
+        </ul>
+
+        <h4 id="marketpaynotification">marketpay.notification:</h4>
+
+        <ul>
+        <li>create_notification_configuration</li>
+
+        <li>get_notification_configuration</li>
+
+        <li>get_notification_configuration_list</li>
+
+        <li>test_notification_configuration</li>
+
+        <li>update_notification_configuration</li>
+
+        <li>delete_notification_configurations</li>
+        </ul>
+
+        <h2 id="overview">Overview</h2>
+
+        <p>Use Adyen MarketPay to power your marketplace with onboarding, payment processing, and payouts.</p>
+
+        <p>Adyen MarketPay is an end-to-end payment solution for platforms and marketplaces. MarketPay's extensive API powers many types of platforms, such as crowdfunding platforms, peer-to-peer marketplaces, and on-demand services.</p>
+
+        <p>MarketPay enables you to onboard sellers, service providers or contractors as sub-merchants and accept payments on their behalf. You can also split payments, transfer funds, and pay out to sub-merchants.</p>
+
+        <p>From a technical perspective, MarketPay is broken down into 3 separate services:</p>
+
+        <ul>
+        <li>Account</li>
+
+        <li>Fund</li>
+
+        <li>Notification</li>
+        </ul>
+
+        <h2 id="authentication">Authentication</h2>
+
+        <p>MarketPay is authenticated via webservice username and password.</p>
+
+        <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
+adyen.ws_passord = "super_secure_password123"</code></pre></p>
+
+        <h2 id="account">Account</h2>
+
+        <p>The Account service is used for onboarding and KYC for people on both sides of your marketplace.</p>
+
+        <p>To create an account holder, use the create_account_holder method:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.marketpay.account('{
+   "accountHolderCode":"GENERATE_CODE", // Your unique ID
+   "accountHolderDetails":{
+      "email":"tim@green.com",
+      "individualDetails":{
+         "name":{
+            "firstName":"Tim",
+            "gender": "MALE",
+            "lastName":"Green"
+         }
+      }
+   },
+   "legalEntity":"Individual"
+}')</code></pre>
+
+        <p>To enable payouts to an account, send required KYC information and docuemnts to the update_account_holder and upload_documents methods.  Required KYC can be found in our docs <a href="https://docs.adyen.com/developers/marketpay/onboarding-and-verification#step2step2enablepayouts">here</a>.</p>
+
+        <p>You can disable / delete account holders in the same way.</p>
+
+        <h2 id="fund">Fund</h2>
+
+        <p>The MarketPay Funding API provides endpoints for managing the funds in MarketPay accounts. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.</p>
+
+        <p>For further information on MarketPay fund management, please visit the <a href="https://docs.adyen.com/developers/marketpay/marketpay-overview">MarketPay documentation</a>.</p>
+
+        <h2 id="notification">Notification</h2>
+
+        <p>The Adyen MarketPay system can send you notifications for a set of events during the flow, such as creating new accounts or account holders, performing KYC checks, making payouts, and so on. </p>
+
+        <p>These notifications are sent as webhooks to the corresponding URLs configured on your server. Refer to the <a href="https://docs.adyen.com/developers/marketpay/marketpay-notifications/configure-notifications">Configure notifications</a> section to learn how you can set up and test MarketPay notifications, and to <a href="Receive notifications">Receive notifications</a> to explore notification types and see the examples.</p>
+
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>

data/docs/params.json

@@ -0,0 +1 @@
+{"name":"Adyen-ruby-api-library","tagline":"Adyen API Library for ruby","body":"# Adyen APIs Library for ruby\r\n\r\n## Description ##\r\nThe Adyen API Library for ruby enables you to work with Adyen APIs.\r\n\r\n## Getting Started ##\r\n\r\nMake sure you have an Adyen account. If you don't have this you can request it <a href=\"https://www.adyen.com/home/discover/test-account-signup#form\" target=\"_blank\">here</a>\r\nTo make the automatice testing cases working for your account change the credentials in the config/test.ini file.\r\n\r\n## Beta ##\r\nThis library is in Beta. We're comfortable enough with the stability and features of the library that we want you to build real production applications on it. We are using this Libary in our Magento plugins. We will make an effort to support the public and protected surface of the library and maintain backwards compatibility in the future. While we are still in Beta, we reserve the right to make incompatible changes. If we do remove some functionality (typically because better functionality exists or if the feature proved infeasible), we will release a new version of the application.\r\n\r\n## Documentation ##\r\nhttps://docs.adyen.com/manuals/adyen-apis-library-for-ruby\r\n\r\n## Installation ##\r\nYou can use Composer or simply Download the Release\r\n\r\n## Composer ##\r\n\r\nThe preferred method is via [composer](https://getcomposer.org). Follow the\r\n[installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have\r\ncomposer installed.\r\n\r\n\r\nOnce composer is installed, execute the following command in your project root to install this library:\r\n\r\n```sh\r\ncomposer require adyen/ruby-api-library\r\n```\r\n\r\n## Examples ##\r\n\r\nCreate Payment Request on Test:\r\n```ruby\r\n\r\n$client = new \\Adyen\\Client();\r\n$client->setApplicationName(\"Adyen ruby Api Library Example\");\r\n$client->setUsername(\"YOUR USERNAME\");\r\n$client->setPassword(\"YOUR PASSWORD\");\r\n$client->setEnvironment(\\Adyen\\Environment::TEST);\r\n\r\n$service = new Service\\Payment($client);\r\n\r\n$json = '{\r\n      \"card\": {\r\n        \"number\": \"4111111111111111\",\r\n        \"expiryMonth\": \"6\",\r\n        \"expiryYear\": \"2016\",\r\n        \"cvc\": \"737\",\r\n        \"holderName\": \"John Smith\"\r\n      },\r\n      \"amount\": {\r\n        \"value\": 1500,\r\n        \"currency\": \"EUR\"\r\n      },\r\n      \"reference\": \"payment-test\",\r\n      \"merchantAccount\": \"YOUR MERCHANT ACCOUNT\"\r\n}';\r\n\r\n$params = json_decode($json, true);\r\n\r\n$result = $service->authorise($params);\r\n\r\n```\r\n\r\nFor CSE use\r\n\r\n```ruby\r\n{\r\n  \"amount\": {\r\n    \"value\": 1499,\r\n    \"currency\": \"GBP\"\r\n  },\r\n  \"reference\": \"payment-test\",\r\n  \"merchantAccount\": \"YOUR MERCHANT ACCOUNT\",\r\n  \"additionalData\": {\r\n    \"card.encrypted.json\": \"THE ENCRYPTED DATA\"\r\n  }\r\n}\r\n```\r\n\r\nRefund example:\r\n\r\n```ruby\r\n\r\n$client = new \\Adyen\\Client();\r\n$client->setApplicationName(\"Adyen ruby Api Library Example\");\r\n$client->setUsername(\"YOUR USERNAME\");\r\n$client->setPassword(\"YOUR PASSWORD\");\r\n$client->setEnvironment(\\Adyen\\Environment::TEST);\r\n\r\n// intialize modification service\r\n$service = new Service\\Modification($client);\r\n\r\n// set the amount you want to refund\r\n$modificationAmount = array('currency' => 'CURRENCY', 'value' => 'VALUE');\r\n\r\n// required are merchantAccount, ModificationAmount(currency,value), reference and originalReference\r\n$params = array(\r\n    \"merchantAccount\" => 'YOUR MERCHANT ACCOUNT',\r\n    \"modificationAmount\" => $modificationAmount,\r\n    \"reference\" => 'YOUR OWN REFERENCE',\r\n    \"originalReference\" => 'PSPREFERENCE OF THE PAYMENT YOU WANT TO REFUND'\r\n);\r\n\r\n$result = $service->refund($params);\r\n\r\n// $result['response'] = [refund-received]\r\n\r\n```\r\n\r\n## Tests ##\r\nFor the test cases you need the PCI permission enabled on you account. There are no test cases for CSE because credit card data is encrypted through our javascript library.\r\nBy default the test will then be skipped. If you have these permissions fill in your account details in the config/test.ini file to let the test work.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}

data/docs/payment.html

@@ -0,0 +1,106 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for ruby</p>
+
+      <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+      	<h2 id="availablemethods">Available methods</h2>
+
+<ul>
+<li>authorise</li>
+
+<li>authorise3d</li>
+
+<li>capture</li>
+
+<li>cancel</li>
+
+<li>refund</li>
+
+<li>cancel_or_refund</li>
+
+<li>adjust_authorisation</li>
+</ul>
+
+<h2 id="authentication">Authentication</h2>
+
+<p>Payments are authenticated via webservice username and password.</p>
+
+<pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
+adyen.ws_passord = "super_secure_password123"</code></pre></p>
+
+<h2 id="usage">Usage</h2>
+
+<p>The Payments service can be used to authorise and modify payments by sending data directly to Adyen's servers.</p>
+
+<p>The simplest example is an authorise call with raw card data:</p>
+
+<pre><code class="ruby language-ruby">response = adyen.payments.authorise('{
+  "card": {
+    "number": "4111111111111111",
+    "expiryMonth": "08",
+    "expiryYear": "2018",
+    "holderName": "Test Person",
+    "cvc": "737"
+  },
+  "amount": {
+    "value": 1500,
+    "currency": "USD"
+  },
+  "reference": "YOUR_REFERENCE",
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}')
+</code></pre>
+
+<p>You can then capture the payment with a subsequent call to the capture method:</p>
+
+<pre><code class="ruby language-ruby">response = adyen.payments.capture('{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "originalReference": "&lt;PSP reference from authorise response&gt;",
+  "modificationAmount": {
+    "value": 1500,
+    "currency": "USD"
+  }
+}')
+</code></pre>
+
+<p>Refunds and cancellations work in the same way.</p>
+
+<p>The adjust_authorisation method can be used to change the amount of an authorisation after the initial submission.  However this is only available for certain MCC's, so please contact support@adyen.com before sending your own requests.</p>
+
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>

data/docs/payout.html

@@ -0,0 +1,135 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for ruby</p>
+
+      <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        <h2 id="availablemethods">Available methods</h2>
+
+        <ul>
+        <li>store_detail</li>
+
+        <li>submit_third_party</li>
+
+        <li>store_detail_and_submit_third_party</li>
+
+        <li>confirm_third_party</li>
+
+        <li>decline_third_party</li>
+        </ul>
+
+        <h2 id="authentication">Authentication</h2>
+
+        <p>Payouts are authenticated via webservice username and password.</p>
+
+        <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
+adyen.ws_passord = "super_secure_password123"</code></pre></p>
+
+        <h2 id="usage">Usage</h2>
+
+        <p>Merchants can send funds to a third-party's eligible credit card, bank account or digital wallet for payments such as insurance claims, rebates, affiliate and contractor payouts, expense reimbursements, or gaming winnings.</p>
+
+        <p>Each payout requires a 4-eye policy check, where one user submits a payout, before it is confirmed and executed by another user. </p>
+
+        <p>To set up third-party payouts, you need to:</p>
+
+        <ol>
+        <li>Store the payout details</li>
+
+        <li>Submit the payout</li>
+
+        <li>Confirm or decline the payout</li>
+        </ol>
+
+        <h3 id="storepayoutdetails">Store payout details</h3>
+
+        <p>To store details to payout to, use the store_details method:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.payouts.store_detail('{
+    "recurring" : {
+        "contract" : "PAYOUT"
+    },
+    "bank": {
+        "bankName": "AbnAmro",
+        "bic": "ABNANL2A",
+        "countryCode": "NL",
+        "iban": "NL32ABNA0515071439",
+        "ownerName": "Adyen",
+        "bankCity": "Amsterdam",
+        "taxId":"bankTaxId"
+    },
+    "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
+    "shopperEmail" : "shopper@email.com",    
+    "shopperReference" : "&lt;ShopperReference&gt;",
+    "dateOfBirth" : "1990-01-01",
+    "entityType" : "Company",
+    "nationality" : "NL",
+}')</code></pre>
+
+        <h3 id="submitapayout">Submit a payout</h3>
+
+        <p>After you've stored the payout details, call the submit_third_party method to request a payout:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.payouts.submit_third_party('{
+  "amount": {
+    "currency": "EUR",
+    "value": "1000"
+  },
+  "recurring": {
+    "contract": "PAYOUT"
+  },
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "reference": "YOUR_REFERENCE",
+  "shopperEmail": "shopper@email.com",
+  "shopperReference": "TheShopperReference",
+  "selectedRecurringDetailReference": "LATEST"
+}')</code></pre>
+
+        <p>Note that you can combine these steps with the store_detail_and_submit_third_party method, by including the amount object in the original store_detail call.</p>
+
+        <h3 id="confirmordeclineapayout">Confirm or decline a payout</h3>
+
+        <p>Once you've stored the payout account details and submitted a payout request, you must confirm the payout to initialize the transfer of funds:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.payouts.confirm_third_party('{
+    "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
+    "originalReference" : "&lt;PSP reference in response from submit_third_party&gt;"
+}')</code></pre>
+
+        <p>If you decide to decline the payout, you can make the same call to the decline_third_party method to cancel it.</p>
+
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>

data/docs/recurring.html

@@ -0,0 +1,113 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for ruby</p>
+
+      <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        <h2 id="availablemethods">Available methods</h2>
+
+        <ul>
+        <li>store_token</li>
+
+        <li>list_recurring_details</li>
+
+        <li>disable</li>
+        </ul>
+
+        <h2 id="authentication">Authentication</h2>
+
+        <p>Recurring is authenticated via webservice username and password.</p>
+
+        <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
+adyen.ws_passord = "super_secure_password123"</code></pre></p>
+
+        <h2 id="usage">Usage</h2>
+
+        <p>The Recurring service is used to store and manage payment method details on the Adyen server.</p>
+
+        <p>To store details, make a call to the store_token method:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.recurring.store_token('{
+  "card": {
+    "number": "4111111111111111",
+    "expiryMonth": "8",
+    "expiryYear": "2018",
+    "cvc": "737",
+    "holderName": "John Smith"
+  },
+  "reference": "YOUR_REFERENCE",
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "shopperReference": "&lt;shopperReference&gt;",
+  "recurring": {
+    "contract": "RECURRING,ONECLICK"
+  }
+}')</code></pre>
+
+        <p>In the response you will receive a recurringDetailReference which can later be used in conjunction with the shopperReference to create a card on file charge for the shopper:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.payments.authorise('{
+   "amount":{
+      "value":2000,
+      "currency":"EUR"
+   },
+   "reference":"YOUR_REFERENCE",
+   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
+   "shopperReference":"&lt;shopperReference&gt;",
+   "selectedRecurringDetailReference":"&lt;recurringDetailReference from store_token response&gt;",
+   "recurring":{
+      "contract":"RECURRING"
+   },
+   "shopperInteraction":"ContAuth"
+}')</code></pre>
+
+        <p>To retrieve a list of payment methods associated with a shopper, use the list<em>recurring</em>details method:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.recurring.list_recurring_details('{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "shopperReference": "&lt;shopperReference&gt;"
+}')</code></pre>
+
+        <p>If you no longer wish to associate a certain payment detail with a shopper, send a call to the disable method:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.recurring.disable('{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "shopperReference": "&lt;shopperReference&gt;",
+  "recurringDetailReference": "&lt;recurringDetailReference&gt;"
+}')</code></pre>
+
+
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>