adyen-ruby-api-library 9.6.0 → 9.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (21) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -0
  3. data/VERSION +1 -1
  4. data/lib/adyen/client.rb +8 -3
  5. data/lib/adyen/services/checkout/donations_api.rb +9 -0
  6. data/lib/adyen/version.rb +1 -1
  7. metadata +2 -16
  8. data/docs/checkout.html +0 -128
  9. data/docs/index.html +0 -50
  10. data/docs/install-library.html +0 -61
  11. data/docs/javascripts/prism.js +0 -5
  12. data/docs/javascripts/scale.fix.js +0 -17
  13. data/docs/marketpay.html +0 -171
  14. data/docs/params.json +0 -1
  15. data/docs/payment.html +0 -106
  16. data/docs/payout.html +0 -135
  17. data/docs/recurring.html +0 -113
  18. data/docs/stylesheets/github-light.css +0 -115
  19. data/docs/stylesheets/prism.css +0 -140
  20. data/docs/stylesheets/styles.css +0 -324
  21. data/docs/using-library.html +0 -67
data/docs/payment.html DELETED
@@ -1,106 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="chrome=1">
6
- <title>Adyen-ruby-api-library by Adyen</title>
7
-
8
- <link rel="stylesheet" href="stylesheets/styles.css">
9
- <link rel="stylesheet" href="stylesheets/github-light.css">
10
- <meta name="viewport" content="width=device-width">
11
- <meta name="viewport" content="width=device-width">
12
-
13
- <link rel="stylesheet" href="stylesheets/prism.css">
14
- <script src="javascripts/prism.js"></script>
15
- <!--[if lt IE 9]>
16
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
17
- <![endif]-->
18
- </head>
19
- <body>
20
- <div class="wrapper">
21
- <header>
22
- <h1>Adyen-ruby-api-library</h1>
23
- <p>Adyen API Library for ruby</p>
24
-
25
- <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>
26
- <ul>
27
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/main">Download <strong>ZIP File</strong></a></li>
28
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/main">Download <strong>TAR Ball</strong></a></li>
29
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
30
- </ul>
31
- </header>
32
- <section>
33
- <h2 id="availablemethods">Available methods</h2>
34
-
35
- <ul>
36
- <li>authorise</li>
37
-
38
- <li>authorise3d</li>
39
-
40
- <li>capture</li>
41
-
42
- <li>cancel</li>
43
-
44
- <li>refund</li>
45
-
46
- <li>cancel_or_refund</li>
47
-
48
- <li>adjust_authorisation</li>
49
- </ul>
50
-
51
- <h2 id="authentication">Authentication</h2>
52
-
53
- <p>Payments are authenticated via webservice username and password.</p>
54
-
55
- <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
56
- adyen.ws_passord = "super_secure_password123"</code></pre></p>
57
-
58
- <h2 id="usage">Usage</h2>
59
-
60
- <p>The Payments service can be used to authorise and modify payments by sending data directly to Adyen's servers.</p>
61
-
62
- <p>The simplest example is an authorise call with raw card data:</p>
63
-
64
- <pre><code class="ruby language-ruby">response = adyen.payments.authorise('{
65
- "card": {
66
- "number": "4111111111111111",
67
- "expiryMonth": "08",
68
- "expiryYear": "2018",
69
- "holderName": "Test Person",
70
- "cvc": "737"
71
- },
72
- "amount": {
73
- "value": 1500,
74
- "currency": "USD"
75
- },
76
- "reference": "YOUR_REFERENCE",
77
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
78
- }')
79
- </code></pre>
80
-
81
- <p>You can then capture the payment with a subsequent call to the capture method:</p>
82
-
83
- <pre><code class="ruby language-ruby">response = adyen.payments.capture('{
84
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
85
- "originalReference": "&lt;PSP reference from authorise response&gt;",
86
- "modificationAmount": {
87
- "value": 1500,
88
- "currency": "USD"
89
- }
90
- }')
91
- </code></pre>
92
-
93
- <p>Refunds and cancellations work in the same way.</p>
94
-
95
- <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>
96
-
97
- </section>
98
- <footer>
99
- <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
100
- <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
101
- </footer>
102
- </div>
103
- <script src="javascripts/scale.fix.js"></script>
104
-
105
- </body>
106
- </html>
data/docs/payout.html DELETED
@@ -1,135 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="chrome=1">
6
- <title>Adyen-ruby-api-library by Adyen</title>
7
-
8
- <link rel="stylesheet" href="stylesheets/styles.css">
9
- <link rel="stylesheet" href="stylesheets/github-light.css">
10
- <meta name="viewport" content="width=device-width">
11
-
12
- <link rel="stylesheet" href="stylesheets/prism.css">
13
- <script src="javascripts/prism.js"></script>
14
- <!--[if lt IE 9]>
15
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
- <![endif]-->
17
- </head>
18
- <body>
19
- <div class="wrapper">
20
- <header>
21
- <h1>Adyen-ruby-api-library</h1>
22
- <p>Adyen API Library for ruby</p>
23
-
24
- <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>
25
- <ul>
26
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/main">Download <strong>ZIP File</strong></a></li>
27
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/main">Download <strong>TAR Ball</strong></a></li>
28
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
29
- </ul>
30
- </header>
31
- <section>
32
- <h2 id="availablemethods">Available methods</h2>
33
-
34
- <ul>
35
- <li>store_detail</li>
36
-
37
- <li>submit_third_party</li>
38
-
39
- <li>store_detail_and_submit_third_party</li>
40
-
41
- <li>confirm_third_party</li>
42
-
43
- <li>decline_third_party</li>
44
- </ul>
45
-
46
- <h2 id="authentication">Authentication</h2>
47
-
48
- <p>Payouts are authenticated via webservice username and password.</p>
49
-
50
- <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
51
- adyen.ws_passord = "super_secure_password123"</code></pre></p>
52
-
53
- <h2 id="usage">Usage</h2>
54
-
55
- <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>
56
-
57
- <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>
58
-
59
- <p>To set up third-party payouts, you need to:</p>
60
-
61
- <ol>
62
- <li>Store the payout details</li>
63
-
64
- <li>Submit the payout</li>
65
-
66
- <li>Confirm or decline the payout</li>
67
- </ol>
68
-
69
- <h3 id="storepayoutdetails">Store payout details</h3>
70
-
71
- <p>To store details to payout to, use the store_details method:</p>
72
-
73
- <pre><code class="ruby language-ruby">response = adyen.payouts.store_detail('{
74
- "recurring" : {
75
- "contract" : "PAYOUT"
76
- },
77
- "bank": {
78
- "bankName": "AbnAmro",
79
- "bic": "ABNANL2A",
80
- "countryCode": "NL",
81
- "iban": "NL32ABNA0515071439",
82
- "ownerName": "Adyen",
83
- "bankCity": "Amsterdam",
84
- "taxId":"bankTaxId"
85
- },
86
- "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
87
- "shopperEmail" : "shopper@email.com",
88
- "shopperReference" : "&lt;ShopperReference&gt;",
89
- "dateOfBirth" : "1990-01-01",
90
- "entityType" : "Company",
91
- "nationality" : "NL"
92
- }')</code></pre>
93
-
94
- <h3 id="submitapayout">Submit a payout</h3>
95
-
96
- <p>After you've stored the payout details, call the submit_third_party method to request a payout:</p>
97
-
98
- <pre><code class="ruby language-ruby">response = adyen.payouts.submit_third_party('{
99
- "amount": {
100
- "currency": "EUR",
101
- "value": "1000"
102
- },
103
- "recurring": {
104
- "contract": "PAYOUT"
105
- },
106
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
107
- "reference": "YOUR_REFERENCE",
108
- "shopperEmail": "shopper@email.com",
109
- "shopperReference": "TheShopperReference",
110
- "selectedRecurringDetailReference": "LATEST"
111
- }')</code></pre>
112
-
113
- <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>
114
-
115
- <h3 id="confirmordeclineapayout">Confirm or decline a payout</h3>
116
-
117
- <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>
118
-
119
- <pre><code class="ruby language-ruby">response = adyen.payouts.confirm_third_party('{
120
- "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
121
- "originalReference" : "&lt;PSP reference in response from submit_third_party&gt;"
122
- }')</code></pre>
123
-
124
- <p>If you decide to decline the payout, you can make the same call to the decline_third_party method to cancel it.</p>
125
-
126
- </section>
127
- <footer>
128
- <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
129
- <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
130
- </footer>
131
- </div>
132
- <script src="javascripts/scale.fix.js"></script>
133
-
134
- </body>
135
- </html>
data/docs/recurring.html DELETED
@@ -1,113 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="chrome=1">
6
- <title>Adyen-ruby-api-library by Adyen</title>
7
-
8
- <link rel="stylesheet" href="stylesheets/styles.css">
9
- <link rel="stylesheet" href="stylesheets/github-light.css">
10
- <meta name="viewport" content="width=device-width">
11
-
12
- <link rel="stylesheet" href="stylesheets/prism.css">
13
- <script src="javascripts/prism.js"></script>
14
- <!--[if lt IE 9]>
15
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
- <![endif]-->
17
- </head>
18
- <body>
19
- <div class="wrapper">
20
- <header>
21
- <h1>Adyen-ruby-api-library</h1>
22
- <p>Adyen API Library for ruby</p>
23
-
24
- <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>
25
- <ul>
26
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/main">Download <strong>ZIP File</strong></a></li>
27
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/main">Download <strong>TAR Ball</strong></a></li>
28
- <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
29
- </ul>
30
- </header>
31
- <section>
32
- <h2 id="availablemethods">Available methods</h2>
33
-
34
- <ul>
35
- <li>store_token</li>
36
-
37
- <li>list_recurring_details</li>
38
-
39
- <li>disable</li>
40
- </ul>
41
-
42
- <h2 id="authentication">Authentication</h2>
43
-
44
- <p>Recurring is authenticated via webservice username and password.</p>
45
-
46
- <pre><code class="ruby language-ruby">adyen.ws_user = "ws@Company.TestCompany"
47
- adyen.ws_passord = "super_secure_password123"</code></pre></p>
48
-
49
- <h2 id="usage">Usage</h2>
50
-
51
- <p>The Recurring service is used to store and manage payment method details on the Adyen server.</p>
52
-
53
- <p>To store details, make a call to the store_token method:</p>
54
-
55
- <pre><code class="ruby language-ruby">response = adyen.recurring.store_token('{
56
- "card": {
57
- "number": "4111111111111111",
58
- "expiryMonth": "8",
59
- "expiryYear": "2018",
60
- "cvc": "737",
61
- "holderName": "John Smith"
62
- },
63
- "reference": "YOUR_REFERENCE",
64
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
65
- "shopperReference": "&lt;shopperReference&gt;",
66
- "recurring": {
67
- "contract": "RECURRING,ONECLICK"
68
- }
69
- }')</code></pre>
70
-
71
- <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>
72
-
73
- <pre><code class="ruby language-ruby">response = adyen.payments.authorise('{
74
- "amount":{
75
- "value":2000,
76
- "currency":"EUR"
77
- },
78
- "reference":"YOUR_REFERENCE",
79
- "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
80
- "shopperReference":"&lt;shopperReference&gt;",
81
- "selectedRecurringDetailReference":"&lt;recurringDetailReference from store_token response&gt;",
82
- "recurring":{
83
- "contract":"RECURRING"
84
- },
85
- "shopperInteraction":"ContAuth"
86
- }')</code></pre>
87
-
88
- <p>To retrieve a list of payment methods associated with a shopper, use the list<em>recurring</em>details method:</p>
89
-
90
- <pre><code class="ruby language-ruby">response = adyen.recurring.list_recurring_details('{
91
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
92
- "shopperReference": "&lt;shopperReference&gt;"
93
- }')</code></pre>
94
-
95
- <p>If you no longer wish to associate a certain payment detail with a shopper, send a call to the disable method:</p>
96
-
97
- <pre><code class="ruby language-ruby">response = adyen.recurring.disable('{
98
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
99
- "shopperReference": "&lt;shopperReference&gt;",
100
- "recurringDetailReference": "&lt;recurringDetailReference&gt;"
101
- }')</code></pre>
102
-
103
-
104
- </section>
105
- <footer>
106
- <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
107
- <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
108
- </footer>
109
- </div>
110
- <script src="javascripts/scale.fix.js"></script>
111
-
112
- </body>
113
- </html>
data/docs/stylesheets/github-light.css DELETED
@@ -1,115 +0,0 @@
1
- /*
2
- Copyright 2014 GitHub Inc.
3
-
4
- Licensed under the Apache License, Version 2.0 (the "License");
5
- you may not use this file except in compliance with the License.
6
- You may obtain a copy of the License at
7
-
8
- http://www.apache.org/licenses/LICENSE-2.0
9
-
10
- Unless required by applicable law or agreed to in writing, software
11
- distributed under the License is distributed on an "AS IS" BASIS,
12
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- See the License for the specific language governing permissions and
14
- limitations under the License.
15
-
16
- */
17
-
18
- .pl-c /* comment */ {
19
- color: #969896;
20
- }
21
-
22
- .pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
23
- .pl-s .pl-v /* string variable */ {
24
- color: #0086b3;
25
- }
26
-
27
- .pl-e /* entity */,
28
- .pl-en /* entity.name */ {
29
- color: #795da3;
30
- }
31
-
32
- .pl-s .pl-s1 /* string source */,
33
- .pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
34
- color: #333;
35
- }
36
-
37
- .pl-ent /* entity.name.tag */ {
38
- color: #63a35c;
39
- }
40
-
41
- .pl-k /* keyword, storage, storage.type */ {
42
- color: #a71d5d;
43
- }
44
-
45
- .pl-pds /* punctuation.definition.string, string.regexp.character-class */,
46
- .pl-s /* string */,
47
- .pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
48
- .pl-sr /* string.regexp */,
49
- .pl-sr .pl-cce /* string.regexp constant.character.escape */,
50
- .pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
51
- .pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
52
- color: #183691;
53
- }
54
-
55
- .pl-v /* variable */ {
56
- color: #ed6a43;
57
- }
58
-
59
- .pl-id /* invalid.deprecated */ {
60
- color: #b52a1d;
61
- }
62
-
63
- .pl-ii /* invalid.illegal */ {
64
- background-color: #b52a1d;
65
- color: #f8f8f8;
66
- }
67
-
68
- .pl-sr .pl-cce /* string.regexp constant.character.escape */ {
69
- color: #63a35c;
70
- font-weight: bold;
71
- }
72
-
73
- .pl-ml /* markup.list */ {
74
- color: #693a17;
75
- }
76
-
77
- .pl-mh /* markup.heading */,
78
- .pl-mh .pl-en /* markup.heading entity.name */,
79
- .pl-ms /* meta.separator */ {
80
- color: #1d3e81;
81
- font-weight: bold;
82
- }
83
-
84
- .pl-mq /* markup.quote */ {
85
- color: #008080;
86
- }
87
-
88
- .pl-mi /* markup.italic */ {
89
- color: #333;
90
- font-style: italic;
91
- }
92
-
93
- .pl-mb /* markup.bold */ {
94
- color: #333;
95
- font-weight: bold;
96
- }
97
-
98
- .pl-md /* markup.deleted, meta.diff.header.from-file */ {
99
- background-color: #ffecec;
100
- color: #bd2c00;
101
- }
102
-
103
- .pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
104
- background-color: #eaffea;
105
- color: #55a532;
106
- }
107
-
108
- .pl-mdr /* meta.diff.range */ {
109
- color: #795da3;
110
- font-weight: bold;
111
- }
112
-
113
- .pl-mo /* meta.output */ {
114
- color: #1d3e81;
115
- }
data/docs/stylesheets/prism.css DELETED
@@ -1,140 +0,0 @@
1
- /* PrismJS 1.14.0
2
- http://prismjs.com/download.html#themes=prism&languages=clike+ruby */
3
- /**
4
- * prism.js default theme for JavaScript, CSS and HTML
5
- * Based on dabblet (http://dabblet.com)
6
- * @author Lea Verou
7
- */
8
-
9
- code[class*="language-"],
10
- pre[class*="language-"] {
11
- color: black;
12
- background: none;
13
- text-shadow: 0 1px white;
14
- font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
15
- text-align: left;
16
- white-space: pre;
17
- word-spacing: normal;
18
- word-break: normal;
19
- word-wrap: normal;
20
- line-height: 1.5;
21
-
22
- -moz-tab-size: 4;
23
- -o-tab-size: 4;
24
- tab-size: 4;
25
-
26
- -webkit-hyphens: none;
27
- -moz-hyphens: none;
28
- -ms-hyphens: none;
29
- hyphens: none;
30
- }
31
-
32
- pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
33
- code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
34
- text-shadow: none;
35
- background: #b3d4fc;
36
- }
37
-
38
- pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
39
- code[class*="language-"]::selection, code[class*="language-"] ::selection {
40
- text-shadow: none;
41
- background: #b3d4fc;
42
- }
43
-
44
- @media print {
45
- code[class*="language-"],
46
- pre[class*="language-"] {
47
- text-shadow: none;
48
- }
49
- }
50
-
51
- /* Code blocks */
52
- pre[class*="language-"] {
53
- padding: 1em;
54
- margin: .5em 0;
55
- overflow: auto;
56
- }
57
-
58
- :not(pre) > code[class*="language-"],
59
- pre[class*="language-"] {
60
- background: #f8f8f8;
61
- }
62
-
63
- /* Inline code */
64
- :not(pre) > code[class*="language-"] {
65
- padding: .1em;
66
- border-radius: .3em;
67
- white-space: normal;
68
- }
69
-
70
- .token.comment,
71
- .token.prolog,
72
- .token.doctype,
73
- .token.cdata {
74
- color: slategray;
75
- }
76
-
77
- .token.punctuation {
78
- color: #999;
79
- }
80
-
81
- .namespace {
82
- opacity: .7;
83
- }
84
-
85
- .token.property,
86
- .token.tag,
87
- .token.boolean,
88
- .token.number,
89
- .token.constant,
90
- .token.symbol,
91
- .token.deleted {
92
- color: #905;
93
- }
94
-
95
- .token.selector,
96
- .token.attr-name,
97
- .token.string,
98
- .token.char,
99
- .token.builtin,
100
- .token.inserted {
101
- color: #690;
102
- }
103
-
104
- .token.operator,
105
- .token.entity,
106
- .token.url,
107
- .language-css .token.string,
108
- .style .token.string {
109
- color: #9a6e3a;
110
- }
111
-
112
- .token.atrule,
113
- .token.attr-value,
114
- .token.keyword {
115
- color: #07a;
116
- }
117
-
118
- .token.function,
119
- .token.class-name {
120
- color: #DD4A68;
121
- }
122
-
123
- .token.regex,
124
- .token.important,
125
- .token.variable {
126
- color: #e90;
127
- }
128
-
129
- .token.important,
130
- .token.bold {
131
- font-weight: bold;
132
- }
133
- .token.italic {
134
- font-style: italic;
135
- }
136
-
137
- .token.entity {
138
- cursor: help;
139
- }
140
-