• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.orderpayments.html">orderpayments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#notifyauthapproved">notifyauthapproved(merchantId, orderId, body)</a></code></p>
79<p class="firstline">Notify about successfully authorizing user's payment method for a given amount.</p>
80<p class="toc_element">
81  <code><a href="#notifyauthdeclined">notifyauthdeclined(merchantId, orderId, body)</a></code></p>
82<p class="firstline">Notify about failure to authorize user's payment method.</p>
83<p class="toc_element">
84  <code><a href="#notifycharge">notifycharge(merchantId, orderId, body)</a></code></p>
85<p class="firstline">Notify about charge on user's selected payments method.</p>
86<p class="toc_element">
87  <code><a href="#notifyrefund">notifyrefund(merchantId, orderId, body)</a></code></p>
88<p class="firstline">Notify about refund on user's selected payments method.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="notifyauthapproved">notifyauthapproved(merchantId, orderId, body)</code>
92  <pre>Notify about successfully authorizing user's payment method for a given amount.
93
94Args:
95  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
96  orderId: string, The ID of the order for for which payment authorization is happening. (required)
97  body: object, The request body. (required)
98    The object takes the form of:
99
100{
101    "authAmountTax": { # Authorized amount for tax charge on user's credit card.
102      "currency": "A String", # The currency of the price.
103      "value": "A String", # The price represented as a number.
104    },
105    "authAmountPretax": { # Authorized amount for pre-tax charge on user's credit card.
106      "currency": "A String", # The currency of the price.
107      "value": "A String", # The price represented as a number.
108    },
109  }
110
111
112Returns:
113  An object of the form:
114
115    {
116    "kind": "content#orderpaymentsNotifyAuthApprovedResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse".
117    "executionStatus": "A String", # The status of the execution.
118  }</pre>
119</div>
120
121<div class="method">
122    <code class="details" id="notifyauthdeclined">notifyauthdeclined(merchantId, orderId, body)</code>
123  <pre>Notify about failure to authorize user's payment method.
124
125Args:
126  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
127  orderId: string, The ID of the order for which payment authorization was declined. (required)
128  body: object, The request body. (required)
129    The object takes the form of:
130
131{
132    "declineReason": "A String", # Reason why payment authorization was declined.
133  }
134
135
136Returns:
137  An object of the form:
138
139    {
140    "kind": "content#orderpaymentsNotifyAuthDeclinedResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse".
141    "executionStatus": "A String", # The status of the execution.
142  }</pre>
143</div>
144
145<div class="method">
146    <code class="details" id="notifycharge">notifycharge(merchantId, orderId, body)</code>
147  <pre>Notify about charge on user's selected payments method.
148
149Args:
150  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
151  orderId: string, The ID of the order for which charge is happening. (required)
152  body: object, The request body. (required)
153    The object takes the form of:
154
155{
156    "chargeState": "A String", # Whether charge was successful.
157    "invoiceId": "A String", # Deprecated. Please use invoiceIds instead.
158    "invoiceIds": [ # Invoice IDs from the orderinvoices service that correspond to the charge.
159      "A String",
160    ],
161  }
162
163
164Returns:
165  An object of the form:
166
167    {
168    "kind": "content#orderpaymentsNotifyChargeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse".
169    "executionStatus": "A String", # The status of the execution.
170  }</pre>
171</div>
172
173<div class="method">
174    <code class="details" id="notifyrefund">notifyrefund(merchantId, orderId, body)</code>
175  <pre>Notify about refund on user's selected payments method.
176
177Args:
178  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
179  orderId: string, The ID of the order for which charge is happening. (required)
180  body: object, The request body. (required)
181    The object takes the form of:
182
183{
184    "invoiceId": "A String", # Deprecated. Please use invoiceIds instead.
185    "refundState": "A String", # Whether refund was successful.
186    "invoiceIds": [ # Invoice IDs from the orderinvoices service that correspond to the refund.
187      "A String",
188    ],
189  }
190
191
192Returns:
193  An object of the form:
194
195    {
196    "kind": "content#orderpaymentsNotifyRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse".
197    "executionStatus": "A String", # The status of the execution.
198  }</pre>
199</div>
200
201</body></html>