aws-sdk-payments 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-payments/client.rb +1276 -0
- data/lib/aws-sdk-payments/client_api.rb +470 -0
- data/lib/aws-sdk-payments/customizations.rb +0 -0
- data/lib/aws-sdk-payments/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-payments/endpoint_provider.rb +32 -0
- data/lib/aws-sdk-payments/endpoints.rb +20 -0
- data/lib/aws-sdk-payments/errors.rb +165 -0
- data/lib/aws-sdk-payments/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-payments/resource.rb +26 -0
- data/lib/aws-sdk-payments/types.rb +1474 -0
- data/lib/aws-sdk-payments/waiters.rb +15 -0
- data/lib/aws-sdk-payments.rb +62 -0
- data/sig/client.rbs +165 -0
- data/sig/errors.rbs +38 -0
- data/sig/resource.rbs +87 -0
- data/sig/types.rbs +334 -0
- data/sig/waiters.rbs +13 -0
- metadata +97 -0
|
@@ -0,0 +1,1474 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
module Aws::Payments
|
|
11
|
+
module Types
|
|
12
|
+
|
|
13
|
+
# The request is denied because you don't have sufficient access to
|
|
14
|
+
# perform this operation. Verify that you have the required permissions
|
|
15
|
+
# and try again. This error is also returned, instead of
|
|
16
|
+
# `ResourceNotFoundException`, when you aren't authorized for the
|
|
17
|
+
# resource, so the response doesn't reveal whether the resource exists.
|
|
18
|
+
#
|
|
19
|
+
# @!attribute [rw] message
|
|
20
|
+
# @return [String]
|
|
21
|
+
#
|
|
22
|
+
# @!attribute [rw] reason
|
|
23
|
+
# The reason that access was denied. The following values are valid:
|
|
24
|
+
#
|
|
25
|
+
# * `NOT_AUTHORIZED` – Your IAM policies don't allow this action.
|
|
26
|
+
#
|
|
27
|
+
# * `INVALID_ACCOUNT_STATE` – Your Amazon Web Services account isn't
|
|
28
|
+
# in a state that allows this action, for example because
|
|
29
|
+
# registration isn't complete or the account is suspended.
|
|
30
|
+
#
|
|
31
|
+
# * `OTHER` – Access was denied for another reason.
|
|
32
|
+
# @return [String]
|
|
33
|
+
#
|
|
34
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/AccessDeniedException AWS API Documentation
|
|
35
|
+
#
|
|
36
|
+
class AccessDeniedException < Struct.new(
|
|
37
|
+
:message,
|
|
38
|
+
:reason)
|
|
39
|
+
SENSITIVE = []
|
|
40
|
+
include Aws::Structure
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# An amount of the balance that `GetAccountBalance` returns: the total
|
|
44
|
+
# for one merchant of record in one currency.
|
|
45
|
+
#
|
|
46
|
+
# @!attribute [rw] amount
|
|
47
|
+
# The amount, in the currency that the records making up this balance
|
|
48
|
+
# were issued in.
|
|
49
|
+
# @return [Types::CurrencyAmount]
|
|
50
|
+
#
|
|
51
|
+
# @!attribute [rw] merchant_of_record
|
|
52
|
+
# The merchant of record that issued the invoices or credit memos that
|
|
53
|
+
# make up this amount.
|
|
54
|
+
# @return [String]
|
|
55
|
+
#
|
|
56
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/AccountBalance AWS API Documentation
|
|
57
|
+
#
|
|
58
|
+
class AccountBalance < Struct.new(
|
|
59
|
+
:amount,
|
|
60
|
+
:merchant_of_record)
|
|
61
|
+
SENSITIVE = []
|
|
62
|
+
include Aws::Structure
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# How much of the record's `amount` is outstanding, processing,
|
|
66
|
+
# settled, and canceled. The four balances add up to `amount`. Each
|
|
67
|
+
# balance is in the currency of `amount`, and a balance with nothing in
|
|
68
|
+
# it is 0.
|
|
69
|
+
#
|
|
70
|
+
# @!attribute [rw] outstanding
|
|
71
|
+
# The part of the amount that isn't settled and has no settlement in
|
|
72
|
+
# progress. For an invoice, this is what remains to pay. For a credit
|
|
73
|
+
# memo, this is the credit that isn't yet applied. This balance
|
|
74
|
+
# doesn't include `processing`.
|
|
75
|
+
# @return [Types::CurrencyAmount]
|
|
76
|
+
#
|
|
77
|
+
# @!attribute [rw] processing
|
|
78
|
+
# The part of the amount with a settlement in progress, for example a
|
|
79
|
+
# payment that's submitted but not yet confirmed. It moves to
|
|
80
|
+
# `settled` when the settlement completes, and back to `outstanding`
|
|
81
|
+
# when the settlement fails. This balance is more than 0 only when the
|
|
82
|
+
# `status` is `PROCESSING`.
|
|
83
|
+
# @return [Types::CurrencyAmount]
|
|
84
|
+
#
|
|
85
|
+
# @!attribute [rw] settled
|
|
86
|
+
# The part of the amount that is settled. For an invoice, this is the
|
|
87
|
+
# amount paid or covered by credit memos. For a credit memo, this is
|
|
88
|
+
# the amount applied to invoices. This balance is 0 when nothing is
|
|
89
|
+
# settled yet.
|
|
90
|
+
# @return [Types::CurrencyAmount]
|
|
91
|
+
#
|
|
92
|
+
# @!attribute [rw] canceled
|
|
93
|
+
# The part of the amount that was canceled and isn't settled, for
|
|
94
|
+
# example when an invoice is voided. When a partly settled record is
|
|
95
|
+
# canceled, it keeps its `settled` balance, and the rest of the amount
|
|
96
|
+
# moves to `canceled`. This balance is more than 0 only when the
|
|
97
|
+
# `status` is `CANCELED`.
|
|
98
|
+
# @return [Types::CurrencyAmount]
|
|
99
|
+
#
|
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/Balances AWS API Documentation
|
|
101
|
+
#
|
|
102
|
+
class Balances < Struct.new(
|
|
103
|
+
:outstanding,
|
|
104
|
+
:processing,
|
|
105
|
+
:settled,
|
|
106
|
+
:canceled)
|
|
107
|
+
SENSITIVE = []
|
|
108
|
+
include Aws::Structure
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# @!attribute [rw] keys
|
|
112
|
+
# The keys of the financial records to retrieve. Each key is either
|
|
113
|
+
# the record's ID or its invoice ID.
|
|
114
|
+
# @return [Array<Types::FinancialRecordKey>]
|
|
115
|
+
#
|
|
116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/BatchGetFinancialRecordRequest AWS API Documentation
|
|
117
|
+
#
|
|
118
|
+
class BatchGetFinancialRecordRequest < Struct.new(
|
|
119
|
+
:keys)
|
|
120
|
+
SENSITIVE = []
|
|
121
|
+
include Aws::Structure
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# @!attribute [rw] financial_records
|
|
125
|
+
# The financial records that the operation retrieved, in no particular
|
|
126
|
+
# order. This list contains fewer records than you requested when
|
|
127
|
+
# `errors` names one or more keys.
|
|
128
|
+
# @return [Array<Types::FinancialRecord>]
|
|
129
|
+
#
|
|
130
|
+
# @!attribute [rw] errors
|
|
131
|
+
# The errors for the records that the operation couldn't retrieve,
|
|
132
|
+
# one for each record, with the key as you requested it and the
|
|
133
|
+
# reason. This list is empty when the operation retrieved every
|
|
134
|
+
# record.
|
|
135
|
+
# @return [Array<Types::FinancialRecordError>]
|
|
136
|
+
#
|
|
137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/BatchGetFinancialRecordResponse AWS API Documentation
|
|
138
|
+
#
|
|
139
|
+
class BatchGetFinancialRecordResponse < Struct.new(
|
|
140
|
+
:financial_records,
|
|
141
|
+
:errors)
|
|
142
|
+
SENSITIVE = []
|
|
143
|
+
include Aws::Structure
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# A billing period, as a half-open date range: `startDate` is inclusive
|
|
147
|
+
# and `endDate` is exclusive. Both members are calendar dates, carried
|
|
148
|
+
# as the timestamp of 00:00:00 UTC on that day.
|
|
149
|
+
#
|
|
150
|
+
# @!attribute [rw] start_date
|
|
151
|
+
# The first day of the billing period, inclusive, as the timestamp of
|
|
152
|
+
# 00:00:00 UTC on that day.
|
|
153
|
+
# @return [Time]
|
|
154
|
+
#
|
|
155
|
+
# @!attribute [rw] end_date
|
|
156
|
+
# The day after the last day of the billing period, exclusive, as the
|
|
157
|
+
# timestamp of 00:00:00 UTC on that day. A calendar month runs from
|
|
158
|
+
# the first of the month to the first of the next month.
|
|
159
|
+
# @return [Time]
|
|
160
|
+
#
|
|
161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/BillingPeriod AWS API Documentation
|
|
162
|
+
#
|
|
163
|
+
class BillingPeriod < Struct.new(
|
|
164
|
+
:start_date,
|
|
165
|
+
:end_date)
|
|
166
|
+
SENSITIVE = []
|
|
167
|
+
include Aws::Structure
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# The Amazon Web Services business unit that issued a financial record.
|
|
171
|
+
# A business unit has two parts: the merchant of record, which is the
|
|
172
|
+
# Amazon Web Services entity that issued the record, and the line of
|
|
173
|
+
# business within that entity.
|
|
174
|
+
#
|
|
175
|
+
# @!attribute [rw] merchant_of_record
|
|
176
|
+
# The Amazon Web Services entity that issued the invoice and collects
|
|
177
|
+
# payment for it, such as `Amazon Web Services, Inc.` or `Amazon Web
|
|
178
|
+
# Services EMEA SARL`. This is the invoicing entity shown in the
|
|
179
|
+
# Amazon Web Services Billing and Cost Management console. For Amazon
|
|
180
|
+
# Web Services Marketplace purchases, it can differ from the seller of
|
|
181
|
+
# record.
|
|
182
|
+
# @return [String]
|
|
183
|
+
#
|
|
184
|
+
# @!attribute [rw] line_of_business
|
|
185
|
+
# The line of business within the merchant of record that issued the
|
|
186
|
+
# record. This member is absent when the line of business isn't known
|
|
187
|
+
# for the record. The following values are valid:
|
|
188
|
+
#
|
|
189
|
+
# * `AWS_CLOUD_SERVICES` – Your usage of Amazon Web Services services.
|
|
190
|
+
#
|
|
191
|
+
# * `PROSERVE_MARKETING_AND_TRAINING` – Amazon Web Services
|
|
192
|
+
# Professional Services, marketing, and training: consulting,
|
|
193
|
+
# events, and training that Amazon Web Services sells.
|
|
194
|
+
#
|
|
195
|
+
# * `AWS_MARKETPLACE` – Products that you bought from sellers in
|
|
196
|
+
# Amazon Web Services Marketplace.
|
|
197
|
+
# @return [String]
|
|
198
|
+
#
|
|
199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/BusinessUnit AWS API Documentation
|
|
200
|
+
#
|
|
201
|
+
class BusinessUnit < Struct.new(
|
|
202
|
+
:merchant_of_record,
|
|
203
|
+
:line_of_business)
|
|
204
|
+
SENSITIVE = []
|
|
205
|
+
include Aws::Structure
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# The details of a card payment instrument.
|
|
209
|
+
#
|
|
210
|
+
# @!attribute [rw] brand
|
|
211
|
+
# The network the card runs on.
|
|
212
|
+
# @return [String]
|
|
213
|
+
#
|
|
214
|
+
# @!attribute [rw] last4
|
|
215
|
+
# The last four digits of the card number.
|
|
216
|
+
# @return [String]
|
|
217
|
+
#
|
|
218
|
+
# @!attribute [rw] expiration_month
|
|
219
|
+
# The calendar month that the card expires in.
|
|
220
|
+
# @return [Integer]
|
|
221
|
+
#
|
|
222
|
+
# @!attribute [rw] expiration_year
|
|
223
|
+
# The calendar year that the card expires in.
|
|
224
|
+
# @return [Integer]
|
|
225
|
+
#
|
|
226
|
+
# @!attribute [rw] card_type
|
|
227
|
+
# Whether the card is a credit card or a debit card.
|
|
228
|
+
# @return [String]
|
|
229
|
+
#
|
|
230
|
+
# @!attribute [rw] issuing_bank
|
|
231
|
+
# The bank that issued the card.
|
|
232
|
+
# @return [String]
|
|
233
|
+
#
|
|
234
|
+
# @!attribute [rw] issuer_country
|
|
235
|
+
# The country of the bank that issued the card.
|
|
236
|
+
# @return [String]
|
|
237
|
+
#
|
|
238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/Card AWS API Documentation
|
|
239
|
+
#
|
|
240
|
+
class Card < Struct.new(
|
|
241
|
+
:brand,
|
|
242
|
+
:last4,
|
|
243
|
+
:expiration_month,
|
|
244
|
+
:expiration_year,
|
|
245
|
+
:card_type,
|
|
246
|
+
:issuing_bank,
|
|
247
|
+
:issuer_country)
|
|
248
|
+
SENSITIVE = [:last4, :expiration_month, :expiration_year]
|
|
249
|
+
include Aws::Structure
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
# The details of a China bank redirect instrument. A retail instrument
|
|
253
|
+
# is registered with one bank and carries that bank's code. A corporate
|
|
254
|
+
# instrument isn't registered with a bank.
|
|
255
|
+
#
|
|
256
|
+
# @!attribute [rw] bank_code
|
|
257
|
+
# The code of the bank that the instrument is registered with. This
|
|
258
|
+
# member is present only for retail instruments.
|
|
259
|
+
# @return [String]
|
|
260
|
+
#
|
|
261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/CnBankRedirect AWS API Documentation
|
|
262
|
+
#
|
|
263
|
+
class CnBankRedirect < Struct.new(
|
|
264
|
+
:bank_code)
|
|
265
|
+
SENSITIVE = []
|
|
266
|
+
include Aws::Structure
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
# The details of a credit memo: the invoice ID that Amazon Web Services
|
|
270
|
+
# Invoicing issued for it and the billing period that it applies to.
|
|
271
|
+
#
|
|
272
|
+
# @!attribute [rw] invoice_id
|
|
273
|
+
# The invoice ID that Amazon Web Services Invoicing issued for the
|
|
274
|
+
# credit memo: the document number printed on it, shown in the Amazon
|
|
275
|
+
# Web Services Billing and Cost Management console and returned by the
|
|
276
|
+
# Amazon Web Services Invoicing API as `InvoiceId`.
|
|
277
|
+
# `GetFinancialRecord` and `BatchGetFinancialRecord` also accept it,
|
|
278
|
+
# as `invoiceIdentifier`.
|
|
279
|
+
# @return [String]
|
|
280
|
+
#
|
|
281
|
+
# @!attribute [rw] billing_period
|
|
282
|
+
# The billing period the credit memo applies to: the period of the
|
|
283
|
+
# usage it credits.
|
|
284
|
+
# @return [Types::BillingPeriod]
|
|
285
|
+
#
|
|
286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/CreditMemoDetails AWS API Documentation
|
|
287
|
+
#
|
|
288
|
+
class CreditMemoDetails < Struct.new(
|
|
289
|
+
:invoice_id,
|
|
290
|
+
:billing_period)
|
|
291
|
+
SENSITIVE = []
|
|
292
|
+
include Aws::Structure
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
# A monetary amount expressed as a decimal string in the currency's
|
|
296
|
+
# standard unit.
|
|
297
|
+
#
|
|
298
|
+
# @!attribute [rw] value
|
|
299
|
+
# The amount, as a decimal string, such as `10.99`. The number of
|
|
300
|
+
# decimal places can differ between amounts, for example `0.0` and
|
|
301
|
+
# `1000.24`.
|
|
302
|
+
# @return [String]
|
|
303
|
+
#
|
|
304
|
+
# @!attribute [rw] currency
|
|
305
|
+
# The ISO 4217 currency code for the amount (for example, `USD`).
|
|
306
|
+
# @return [String]
|
|
307
|
+
#
|
|
308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/CurrencyAmount AWS API Documentation
|
|
309
|
+
#
|
|
310
|
+
class CurrencyAmount < Struct.new(
|
|
311
|
+
:value,
|
|
312
|
+
:currency)
|
|
313
|
+
SENSITIVE = []
|
|
314
|
+
include Aws::Structure
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
# An invoice or a credit memo on your account, with the details that are
|
|
318
|
+
# specific to its type.
|
|
319
|
+
#
|
|
320
|
+
# @!attribute [rw] id
|
|
321
|
+
# The ID that Amazon Web Services Payments issued for the record, such
|
|
322
|
+
# as `INV-5364-6253-7364-1342`. To retrieve the record again, pass
|
|
323
|
+
# this value to `GetFinancialRecord` or `BatchGetFinancialRecord` as
|
|
324
|
+
# `identifier`.
|
|
325
|
+
# @return [String]
|
|
326
|
+
#
|
|
327
|
+
# @!attribute [rw] type
|
|
328
|
+
# The type of the financial record. The populated member of `details`
|
|
329
|
+
# matches this type. The following values are valid:
|
|
330
|
+
#
|
|
331
|
+
# * `INVOICE` – An invoice: a bill from Amazon Web Services. Payments
|
|
332
|
+
# and credit memos applied to the invoice settle it.
|
|
333
|
+
#
|
|
334
|
+
# * `CREDIT_MEMO` – A credit memo: a credit issued to your account,
|
|
335
|
+
# for example for a billing correction or a service credit. Applying
|
|
336
|
+
# it to one or more invoices settles it.
|
|
337
|
+
# @return [String]
|
|
338
|
+
#
|
|
339
|
+
# @!attribute [rw] business_unit
|
|
340
|
+
# The Amazon Web Services business unit that issued the record: its
|
|
341
|
+
# merchant of record and its line of business.
|
|
342
|
+
# @return [Types::BusinessUnit]
|
|
343
|
+
#
|
|
344
|
+
# @!attribute [rw] amount
|
|
345
|
+
# The total amount of the financial record, in the currency that the
|
|
346
|
+
# record was issued in. The amount doesn't change as the record is
|
|
347
|
+
# settled. `balances` shows how much of it is in each settlement
|
|
348
|
+
# state.
|
|
349
|
+
# @return [Types::CurrencyAmount]
|
|
350
|
+
#
|
|
351
|
+
# @!attribute [rw] balances
|
|
352
|
+
# How much of `amount` is outstanding, processing, settled, and
|
|
353
|
+
# canceled.
|
|
354
|
+
# @return [Types::Balances]
|
|
355
|
+
#
|
|
356
|
+
# @!attribute [rw] settlement_status
|
|
357
|
+
# Whether the record is open or closed. If you receive a `status`
|
|
358
|
+
# value that you don't recognize, use this member to tell open
|
|
359
|
+
# records from closed ones. The following values are valid:
|
|
360
|
+
#
|
|
361
|
+
# * `OPEN` – Part of the amount is outstanding or processing. The
|
|
362
|
+
# `status` is `OUTSTANDING` or `PROCESSING`.
|
|
363
|
+
#
|
|
364
|
+
# * `CLOSED` – The whole amount is settled or canceled. The `status`
|
|
365
|
+
# is `SETTLED` or `CANCELED`.
|
|
366
|
+
#
|
|
367
|
+
# A `CLOSED` record becomes `OPEN` again if a payment or credit
|
|
368
|
+
# applied to it is reversed. Its `closedAt` is then absent until the
|
|
369
|
+
# record closes again.
|
|
370
|
+
# @return [String]
|
|
371
|
+
#
|
|
372
|
+
# @!attribute [rw] status
|
|
373
|
+
# The settlement stage of the record. The following values are valid:
|
|
374
|
+
#
|
|
375
|
+
# * `OUTSTANDING` – Part of the amount isn't settled, and no
|
|
376
|
+
# settlement is in progress on the record. For an invoice,
|
|
377
|
+
# `dueStatus` shows whether it's due or past due. The
|
|
378
|
+
# `settlementStatus` is `OPEN`.
|
|
379
|
+
#
|
|
380
|
+
# * `PROCESSING` – A settlement of part or all of the amount is in
|
|
381
|
+
# progress, for example a payment that's submitted but not yet
|
|
382
|
+
# confirmed. `PROCESSING` takes precedence over `OUTSTANDING`: while
|
|
383
|
+
# any part of the amount is processing, the status is `PROCESSING`,
|
|
384
|
+
# even if another part is still outstanding. The `settlementStatus`
|
|
385
|
+
# is `OPEN`.
|
|
386
|
+
#
|
|
387
|
+
# * `SETTLED` – The whole amount is settled. The `settlementStatus` is
|
|
388
|
+
# `CLOSED`.
|
|
389
|
+
#
|
|
390
|
+
# * `CANCELED` – The record is canceled. The part of the amount that
|
|
391
|
+
# wasn't settled isn't collected or applied. The
|
|
392
|
+
# `settlementStatus` is `CLOSED`.
|
|
393
|
+
# @return [String]
|
|
394
|
+
#
|
|
395
|
+
# @!attribute [rw] issued_at
|
|
396
|
+
# The date and time, in UTC, when this record was issued.
|
|
397
|
+
# @return [Time]
|
|
398
|
+
#
|
|
399
|
+
# @!attribute [rw] closed_at
|
|
400
|
+
# The date and time, in UTC, when the record was last closed, that is,
|
|
401
|
+
# when its `status` last became `SETTLED` or `CANCELED`. This member
|
|
402
|
+
# is absent while the `settlementStatus` is `OPEN`, including after a
|
|
403
|
+
# closed record reopens.
|
|
404
|
+
# @return [Time]
|
|
405
|
+
#
|
|
406
|
+
# @!attribute [rw] details
|
|
407
|
+
# The attributes that exist only for the record's type. The populated
|
|
408
|
+
# member matches `type`: `invoiceDetails` for an `INVOICE`,
|
|
409
|
+
# `creditMemoDetails` for a `CREDIT_MEMO`.
|
|
410
|
+
# @return [Types::FinancialRecordDetails]
|
|
411
|
+
#
|
|
412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/FinancialRecord AWS API Documentation
|
|
413
|
+
#
|
|
414
|
+
class FinancialRecord < Struct.new(
|
|
415
|
+
:id,
|
|
416
|
+
:type,
|
|
417
|
+
:business_unit,
|
|
418
|
+
:amount,
|
|
419
|
+
:balances,
|
|
420
|
+
:settlement_status,
|
|
421
|
+
:status,
|
|
422
|
+
:issued_at,
|
|
423
|
+
:closed_at,
|
|
424
|
+
:details)
|
|
425
|
+
SENSITIVE = []
|
|
426
|
+
include Aws::Structure
|
|
427
|
+
end
|
|
428
|
+
|
|
429
|
+
# The attributes that exist only for one type of financial record. The
|
|
430
|
+
# populated member matches the record's `type`.
|
|
431
|
+
#
|
|
432
|
+
# @note FinancialRecordDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FinancialRecordDetails corresponding to the set member.
|
|
433
|
+
#
|
|
434
|
+
# @!attribute [rw] invoice_details
|
|
435
|
+
# The details of an invoice. Populated when `type` is `INVOICE`.
|
|
436
|
+
# @return [Types::InvoiceDetails]
|
|
437
|
+
#
|
|
438
|
+
# @!attribute [rw] credit_memo_details
|
|
439
|
+
# The details of a credit memo. Populated when `type` is
|
|
440
|
+
# `CREDIT_MEMO`.
|
|
441
|
+
# @return [Types::CreditMemoDetails]
|
|
442
|
+
#
|
|
443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/FinancialRecordDetails AWS API Documentation
|
|
444
|
+
#
|
|
445
|
+
class FinancialRecordDetails < Struct.new(
|
|
446
|
+
:invoice_details,
|
|
447
|
+
:credit_memo_details,
|
|
448
|
+
:unknown)
|
|
449
|
+
SENSITIVE = []
|
|
450
|
+
include Aws::Structure
|
|
451
|
+
include Aws::Structure::Union
|
|
452
|
+
|
|
453
|
+
class InvoiceDetails < FinancialRecordDetails; end
|
|
454
|
+
class CreditMemoDetails < FinancialRecordDetails; end
|
|
455
|
+
class Unknown < FinancialRecordDetails; end
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
# The reason that one of the records requested from
|
|
459
|
+
# `BatchGetFinancialRecord` couldn't be returned. The other records in
|
|
460
|
+
# the request are unaffected.
|
|
461
|
+
#
|
|
462
|
+
# @!attribute [rw] key
|
|
463
|
+
# The key of the record that couldn't be retrieved, as you requested
|
|
464
|
+
# it.
|
|
465
|
+
# @return [Types::FinancialRecordKey]
|
|
466
|
+
#
|
|
467
|
+
# @!attribute [rw] code
|
|
468
|
+
# The error code that indicates why the retrieval failed. The
|
|
469
|
+
# following values are valid:
|
|
470
|
+
#
|
|
471
|
+
# * `NOT_FOUND` – No financial record on your account matches the key.
|
|
472
|
+
#
|
|
473
|
+
# * `INTERNAL_ERROR` – An internal error occurred while processing
|
|
474
|
+
# this record. The other records in the request are unaffected. You
|
|
475
|
+
# can retry this record.
|
|
476
|
+
# @return [String]
|
|
477
|
+
#
|
|
478
|
+
# @!attribute [rw] message
|
|
479
|
+
# A description of why the operation couldn't retrieve this record.
|
|
480
|
+
# The wording can change at any time and isn't localized, so don't
|
|
481
|
+
# parse this value. To handle the error in your code, use `code`
|
|
482
|
+
# instead.
|
|
483
|
+
# @return [String]
|
|
484
|
+
#
|
|
485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/FinancialRecordError AWS API Documentation
|
|
486
|
+
#
|
|
487
|
+
class FinancialRecordError < Struct.new(
|
|
488
|
+
:key,
|
|
489
|
+
:code,
|
|
490
|
+
:message)
|
|
491
|
+
SENSITIVE = []
|
|
492
|
+
include Aws::Structure
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
# A way to identify a financial record. Specify exactly one member: the
|
|
496
|
+
# ID that Amazon Web Services Payments issued, in `identifier`, or the
|
|
497
|
+
# invoice ID that Amazon Web Services Invoicing issued, in
|
|
498
|
+
# `invoiceIdentifier`. If you specify both or neither, the request fails
|
|
499
|
+
# with `ValidationException`.
|
|
500
|
+
#
|
|
501
|
+
# @note FinancialRecordKey is a union - when making an API calls you must set exactly one of the members.
|
|
502
|
+
#
|
|
503
|
+
# @note FinancialRecordKey is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FinancialRecordKey corresponding to the set member.
|
|
504
|
+
#
|
|
505
|
+
# @!attribute [rw] identifier
|
|
506
|
+
# The ID that Amazon Web Services Payments issued for the record.
|
|
507
|
+
# @return [String]
|
|
508
|
+
#
|
|
509
|
+
# @!attribute [rw] invoice_identifier
|
|
510
|
+
# The invoice ID that Amazon Web Services Invoicing issued for an
|
|
511
|
+
# invoice or a credit memo.
|
|
512
|
+
# @return [String]
|
|
513
|
+
#
|
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/FinancialRecordKey AWS API Documentation
|
|
515
|
+
#
|
|
516
|
+
class FinancialRecordKey < Struct.new(
|
|
517
|
+
:identifier,
|
|
518
|
+
:invoice_identifier,
|
|
519
|
+
:unknown)
|
|
520
|
+
SENSITIVE = []
|
|
521
|
+
include Aws::Structure
|
|
522
|
+
include Aws::Structure::Union
|
|
523
|
+
|
|
524
|
+
class Identifier < FinancialRecordKey; end
|
|
525
|
+
class InvoiceIdentifier < FinancialRecordKey; end
|
|
526
|
+
class Unknown < FinancialRecordKey; end
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
# A financial record as `ListFinancialRecords` returns it, without the
|
|
530
|
+
# details that are specific to its type. To get the full record, use
|
|
531
|
+
# `GetFinancialRecord` or `BatchGetFinancialRecord`.
|
|
532
|
+
#
|
|
533
|
+
# @!attribute [rw] id
|
|
534
|
+
# The ID that Amazon Web Services Payments issued for the record. To
|
|
535
|
+
# retrieve the full record, pass this value to `GetFinancialRecord` or
|
|
536
|
+
# `BatchGetFinancialRecord` as `identifier`.
|
|
537
|
+
# @return [String]
|
|
538
|
+
#
|
|
539
|
+
# @!attribute [rw] type
|
|
540
|
+
# The type of the financial record. On the full record, the populated
|
|
541
|
+
# member of `details` matches this type. The following values are
|
|
542
|
+
# valid:
|
|
543
|
+
#
|
|
544
|
+
# * `INVOICE` – An invoice: a bill from Amazon Web Services. Payments
|
|
545
|
+
# and credit memos applied to the invoice settle it.
|
|
546
|
+
#
|
|
547
|
+
# * `CREDIT_MEMO` – A credit memo: a credit issued to your account,
|
|
548
|
+
# for example for a billing correction or a service credit. Applying
|
|
549
|
+
# it to one or more invoices settles it.
|
|
550
|
+
# @return [String]
|
|
551
|
+
#
|
|
552
|
+
# @!attribute [rw] business_unit
|
|
553
|
+
# The Amazon Web Services business unit that issued the record: its
|
|
554
|
+
# merchant of record and its line of business.
|
|
555
|
+
# @return [Types::BusinessUnit]
|
|
556
|
+
#
|
|
557
|
+
# @!attribute [rw] amount
|
|
558
|
+
# The total amount of the financial record, in the currency that the
|
|
559
|
+
# record was issued in. The amount doesn't change as the record is
|
|
560
|
+
# settled. `balances` shows how much of it is in each settlement
|
|
561
|
+
# state.
|
|
562
|
+
# @return [Types::CurrencyAmount]
|
|
563
|
+
#
|
|
564
|
+
# @!attribute [rw] balances
|
|
565
|
+
# How much of `amount` is outstanding, processing, settled, and
|
|
566
|
+
# canceled.
|
|
567
|
+
# @return [Types::Balances]
|
|
568
|
+
#
|
|
569
|
+
# @!attribute [rw] settlement_status
|
|
570
|
+
# Whether the record is open or closed. If you receive a `status`
|
|
571
|
+
# value that you don't recognize, use this member to tell open
|
|
572
|
+
# records from closed ones. The following values are valid:
|
|
573
|
+
#
|
|
574
|
+
# * `OPEN` – Part of the amount is outstanding or processing. The
|
|
575
|
+
# `status` is `OUTSTANDING` or `PROCESSING`.
|
|
576
|
+
#
|
|
577
|
+
# * `CLOSED` – The whole amount is settled or canceled. The `status`
|
|
578
|
+
# is `SETTLED` or `CANCELED`.
|
|
579
|
+
#
|
|
580
|
+
# A `CLOSED` record becomes `OPEN` again if a payment or credit
|
|
581
|
+
# applied to it is reversed. Its `closedAt` is then absent until the
|
|
582
|
+
# record closes again.
|
|
583
|
+
# @return [String]
|
|
584
|
+
#
|
|
585
|
+
# @!attribute [rw] status
|
|
586
|
+
# The settlement stage of the record. The following values are valid:
|
|
587
|
+
#
|
|
588
|
+
# * `OUTSTANDING` – Part of the amount isn't settled, and no
|
|
589
|
+
# settlement is in progress on the record. For an invoice,
|
|
590
|
+
# `dueStatus` shows whether it's due or past due. The
|
|
591
|
+
# `settlementStatus` is `OPEN`.
|
|
592
|
+
#
|
|
593
|
+
# * `PROCESSING` – A settlement of part or all of the amount is in
|
|
594
|
+
# progress, for example a payment that's submitted but not yet
|
|
595
|
+
# confirmed. `PROCESSING` takes precedence over `OUTSTANDING`: while
|
|
596
|
+
# any part of the amount is processing, the status is `PROCESSING`,
|
|
597
|
+
# even if another part is still outstanding. The `settlementStatus`
|
|
598
|
+
# is `OPEN`.
|
|
599
|
+
#
|
|
600
|
+
# * `SETTLED` – The whole amount is settled. The `settlementStatus` is
|
|
601
|
+
# `CLOSED`.
|
|
602
|
+
#
|
|
603
|
+
# * `CANCELED` – The record is canceled. The part of the amount that
|
|
604
|
+
# wasn't settled isn't collected or applied. The
|
|
605
|
+
# `settlementStatus` is `CLOSED`.
|
|
606
|
+
# @return [String]
|
|
607
|
+
#
|
|
608
|
+
# @!attribute [rw] issued_at
|
|
609
|
+
# The date and time, in UTC, when this record was issued.
|
|
610
|
+
# @return [Time]
|
|
611
|
+
#
|
|
612
|
+
# @!attribute [rw] closed_at
|
|
613
|
+
# The date and time, in UTC, when the record was last closed, that is,
|
|
614
|
+
# when its `status` last became `SETTLED` or `CANCELED`. This member
|
|
615
|
+
# is absent while the `settlementStatus` is `OPEN`, including after a
|
|
616
|
+
# closed record reopens.
|
|
617
|
+
# @return [Time]
|
|
618
|
+
#
|
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/FinancialRecordSummary AWS API Documentation
|
|
620
|
+
#
|
|
621
|
+
class FinancialRecordSummary < Struct.new(
|
|
622
|
+
:id,
|
|
623
|
+
:type,
|
|
624
|
+
:business_unit,
|
|
625
|
+
:amount,
|
|
626
|
+
:balances,
|
|
627
|
+
:settlement_status,
|
|
628
|
+
:status,
|
|
629
|
+
:issued_at,
|
|
630
|
+
:closed_at)
|
|
631
|
+
SENSITIVE = []
|
|
632
|
+
include Aws::Structure
|
|
633
|
+
end
|
|
634
|
+
|
|
635
|
+
# @!attribute [rw] balance_type
|
|
636
|
+
# The balance to retrieve. You can specify only one balance type in a
|
|
637
|
+
# single request. Each balance adds up the `outstanding` balance of
|
|
638
|
+
# the records that have the status `OUTSTANDING`. A record that is
|
|
639
|
+
# `PROCESSING`, `SETTLED`, or `CANCELED` isn't included, even when
|
|
640
|
+
# part of its amount is outstanding. The following values are valid:
|
|
641
|
+
#
|
|
642
|
+
# * `INVOICES_DUE` – The outstanding balance of your `OUTSTANDING`
|
|
643
|
+
# invoices that aren't past their due date, where `dueStatus` is
|
|
644
|
+
# `DUE`.
|
|
645
|
+
#
|
|
646
|
+
# * `INVOICES_PAST_DUE` – The outstanding balance of your
|
|
647
|
+
# `OUTSTANDING` invoices that are past their due date, where
|
|
648
|
+
# `dueStatus` is `PAST_DUE`.
|
|
649
|
+
#
|
|
650
|
+
# * `OUTSTANDING_CREDIT_MEMOS` – The outstanding balance of your
|
|
651
|
+
# `OUTSTANDING` credit memos: the credit that isn't yet applied to
|
|
652
|
+
# an invoice.
|
|
653
|
+
# @return [String]
|
|
654
|
+
#
|
|
655
|
+
# @!attribute [rw] next_token
|
|
656
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
657
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
658
|
+
# malformed or expired, or doesn't match the original request, the
|
|
659
|
+
# request fails with `ValidationException` and the reason
|
|
660
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
661
|
+
# page.
|
|
662
|
+
# @return [String]
|
|
663
|
+
#
|
|
664
|
+
# @!attribute [rw] max_results
|
|
665
|
+
# The maximum number of results to return in one page. The default is
|
|
666
|
+
# 100. A page can contain fewer results even when more remain. Use
|
|
667
|
+
# `nextToken` to find out whether more results are available.
|
|
668
|
+
# @return [Integer]
|
|
669
|
+
#
|
|
670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetAccountBalanceRequest AWS API Documentation
|
|
671
|
+
#
|
|
672
|
+
class GetAccountBalanceRequest < Struct.new(
|
|
673
|
+
:balance_type,
|
|
674
|
+
:next_token,
|
|
675
|
+
:max_results)
|
|
676
|
+
SENSITIVE = []
|
|
677
|
+
include Aws::Structure
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
# @!attribute [rw] account_balances
|
|
681
|
+
# The balance, as one amount for each merchant of record and currency.
|
|
682
|
+
# This list is empty when your account has nothing in the requested
|
|
683
|
+
# balance.
|
|
684
|
+
# @return [Array<Types::AccountBalance>]
|
|
685
|
+
#
|
|
686
|
+
# @!attribute [rw] next_token
|
|
687
|
+
# The pagination token that indicates the next set of results to
|
|
688
|
+
# retrieve. This value is absent when there are no more results.
|
|
689
|
+
# @return [String]
|
|
690
|
+
#
|
|
691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetAccountBalanceResponse AWS API Documentation
|
|
692
|
+
#
|
|
693
|
+
class GetAccountBalanceResponse < Struct.new(
|
|
694
|
+
:account_balances,
|
|
695
|
+
:next_token)
|
|
696
|
+
SENSITIVE = []
|
|
697
|
+
include Aws::Structure
|
|
698
|
+
end
|
|
699
|
+
|
|
700
|
+
# @!attribute [rw] identifier
|
|
701
|
+
# The ID that Amazon Web Services Payments issued for the financial
|
|
702
|
+
# record, as returned in `id`.
|
|
703
|
+
# @return [String]
|
|
704
|
+
#
|
|
705
|
+
# @!attribute [rw] invoice_identifier
|
|
706
|
+
# The invoice ID that Amazon Web Services Invoicing issued for an
|
|
707
|
+
# invoice or a credit memo. The operation returns the record that has
|
|
708
|
+
# this invoice ID.
|
|
709
|
+
# @return [String]
|
|
710
|
+
#
|
|
711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetFinancialRecordRequest AWS API Documentation
|
|
712
|
+
#
|
|
713
|
+
class GetFinancialRecordRequest < Struct.new(
|
|
714
|
+
:identifier,
|
|
715
|
+
:invoice_identifier)
|
|
716
|
+
SENSITIVE = []
|
|
717
|
+
include Aws::Structure
|
|
718
|
+
end
|
|
719
|
+
|
|
720
|
+
# @!attribute [rw] financial_record
|
|
721
|
+
# The requested financial record.
|
|
722
|
+
# @return [Types::FinancialRecord]
|
|
723
|
+
#
|
|
724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetFinancialRecordResponse AWS API Documentation
|
|
725
|
+
#
|
|
726
|
+
class GetFinancialRecordResponse < Struct.new(
|
|
727
|
+
:financial_record)
|
|
728
|
+
SENSITIVE = []
|
|
729
|
+
include Aws::Structure
|
|
730
|
+
end
|
|
731
|
+
|
|
732
|
+
# @!attribute [rw] identifier
|
|
733
|
+
# The instrument to retrieve. Specify one of the following:
|
|
734
|
+
#
|
|
735
|
+
# * The Amazon Resource Name (ARN) of the instrument, as
|
|
736
|
+
# `ListPaymentInstruments` returns in `arn`. The ARN must be for an
|
|
737
|
+
# instrument on your account.
|
|
738
|
+
#
|
|
739
|
+
# * The ID of the instrument, as `ListPaymentInstruments` returns in
|
|
740
|
+
# `id`.
|
|
741
|
+
# @return [String]
|
|
742
|
+
#
|
|
743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetPaymentInstrumentRequest AWS API Documentation
|
|
744
|
+
#
|
|
745
|
+
class GetPaymentInstrumentRequest < Struct.new(
|
|
746
|
+
:identifier)
|
|
747
|
+
SENSITIVE = []
|
|
748
|
+
include Aws::Structure
|
|
749
|
+
end
|
|
750
|
+
|
|
751
|
+
# @!attribute [rw] payment_instrument
|
|
752
|
+
# The payment instrument, including the details that are specific to
|
|
753
|
+
# its payment method.
|
|
754
|
+
# @return [Types::PaymentInstrument]
|
|
755
|
+
#
|
|
756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetPaymentInstrumentResponse AWS API Documentation
|
|
757
|
+
#
|
|
758
|
+
class GetPaymentInstrumentResponse < Struct.new(
|
|
759
|
+
:payment_instrument)
|
|
760
|
+
SENSITIVE = []
|
|
761
|
+
include Aws::Structure
|
|
762
|
+
end
|
|
763
|
+
|
|
764
|
+
# The details of an India net banking instrument. The instrument is
|
|
765
|
+
# registered with one bank.
|
|
766
|
+
#
|
|
767
|
+
# @!attribute [rw] bank_code
|
|
768
|
+
# The code of the bank that the instrument is registered with.
|
|
769
|
+
# @return [String]
|
|
770
|
+
#
|
|
771
|
+
# @!attribute [rw] bank_name
|
|
772
|
+
# The name of the bank that the instrument is registered with.
|
|
773
|
+
# @return [String]
|
|
774
|
+
#
|
|
775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/InNetBanking AWS API Documentation
|
|
776
|
+
#
|
|
777
|
+
class InNetBanking < Struct.new(
|
|
778
|
+
:bank_code,
|
|
779
|
+
:bank_name)
|
|
780
|
+
SENSITIVE = []
|
|
781
|
+
include Aws::Structure
|
|
782
|
+
end
|
|
783
|
+
|
|
784
|
+
# The request processing failed because of an unknown error, exception,
|
|
785
|
+
# or failure. Retry your request.
|
|
786
|
+
#
|
|
787
|
+
# @!attribute [rw] message
|
|
788
|
+
# @return [String]
|
|
789
|
+
#
|
|
790
|
+
# @!attribute [rw] retry_after_seconds
|
|
791
|
+
# The suggested number of seconds to wait before retrying the request.
|
|
792
|
+
# @return [Integer]
|
|
793
|
+
#
|
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/InternalServerException AWS API Documentation
|
|
795
|
+
#
|
|
796
|
+
class InternalServerException < Struct.new(
|
|
797
|
+
:message,
|
|
798
|
+
:retry_after_seconds)
|
|
799
|
+
SENSITIVE = []
|
|
800
|
+
include Aws::Structure
|
|
801
|
+
end
|
|
802
|
+
|
|
803
|
+
# The details of an invoice: the invoice ID that Amazon Web Services
|
|
804
|
+
# Invoicing issued, the billing period that the invoice covers, its due
|
|
805
|
+
# date and due status, its payment terms, and its frequency.
|
|
806
|
+
#
|
|
807
|
+
# @!attribute [rw] invoice_id
|
|
808
|
+
# The invoice ID that Amazon Web Services Invoicing issued for the
|
|
809
|
+
# invoice: the document number printed on it, shown in the Amazon Web
|
|
810
|
+
# Services Billing and Cost Management console and returned by the
|
|
811
|
+
# Amazon Web Services Invoicing API as `InvoiceId`.
|
|
812
|
+
# `GetFinancialRecord` and `BatchGetFinancialRecord` also accept it,
|
|
813
|
+
# as `invoiceIdentifier`.
|
|
814
|
+
# @return [String]
|
|
815
|
+
#
|
|
816
|
+
# @!attribute [rw] due_status
|
|
817
|
+
# Whether the invoice is due or past its due date. This member is
|
|
818
|
+
# present only while the invoice's `status` is `OUTSTANDING`. It's
|
|
819
|
+
# absent when the `status` is `PROCESSING`, `SETTLED`, or `CANCELED`.
|
|
820
|
+
# The following values are valid:
|
|
821
|
+
#
|
|
822
|
+
# * `DUE` – The due date hasn't passed.
|
|
823
|
+
#
|
|
824
|
+
# * `PAST_DUE` – The due date has passed, and the invoice is still
|
|
825
|
+
# outstanding.
|
|
826
|
+
# @return [String]
|
|
827
|
+
#
|
|
828
|
+
# @!attribute [rw] billing_period
|
|
829
|
+
# The billing period the invoice covers: the period of the usage it
|
|
830
|
+
# bills.
|
|
831
|
+
# @return [Types::BillingPeriod]
|
|
832
|
+
#
|
|
833
|
+
# @!attribute [rw] due_date
|
|
834
|
+
# The calendar date by which the invoice must be paid, as the
|
|
835
|
+
# timestamp of 00:00:00 UTC on that day. The invoice is past due from
|
|
836
|
+
# the following day.
|
|
837
|
+
# @return [Time]
|
|
838
|
+
#
|
|
839
|
+
# @!attribute [rw] payment_terms
|
|
840
|
+
# The payment terms for the invoice, as Amazon Web Services Invoicing
|
|
841
|
+
# issued them, such as `Net30`. The due date follows from these terms.
|
|
842
|
+
# This member is absent when Amazon Web Services Invoicing didn't
|
|
843
|
+
# issue payment terms for the invoice.
|
|
844
|
+
# @return [String]
|
|
845
|
+
#
|
|
846
|
+
# @!attribute [rw] invoice_frequency
|
|
847
|
+
# Whether the invoice was issued once or as part of a billing cycle.
|
|
848
|
+
# The following values are valid:
|
|
849
|
+
#
|
|
850
|
+
# * `ONE_TIME` – A single invoice that isn't part of a billing cycle.
|
|
851
|
+
#
|
|
852
|
+
# * `RECURRING` – One invoice of a billing cycle, such as your monthly
|
|
853
|
+
# invoice.
|
|
854
|
+
# @return [String]
|
|
855
|
+
#
|
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/InvoiceDetails AWS API Documentation
|
|
857
|
+
#
|
|
858
|
+
class InvoiceDetails < Struct.new(
|
|
859
|
+
:invoice_id,
|
|
860
|
+
:due_status,
|
|
861
|
+
:billing_period,
|
|
862
|
+
:due_date,
|
|
863
|
+
:payment_terms,
|
|
864
|
+
:invoice_frequency)
|
|
865
|
+
SENSITIVE = []
|
|
866
|
+
include Aws::Structure
|
|
867
|
+
end
|
|
868
|
+
|
|
869
|
+
# @!attribute [rw] types
|
|
870
|
+
# The financial record types to return. The following values are
|
|
871
|
+
# valid:
|
|
872
|
+
#
|
|
873
|
+
# * `INVOICE` – An invoice: a bill from Amazon Web Services. Payments
|
|
874
|
+
# and credit memos applied to the invoice settle it.
|
|
875
|
+
#
|
|
876
|
+
# * `CREDIT_MEMO` – A credit memo: a credit issued to your account,
|
|
877
|
+
# for example for a billing correction or a service credit. Applying
|
|
878
|
+
# it to one or more invoices settles it.
|
|
879
|
+
# @return [Array<String>]
|
|
880
|
+
#
|
|
881
|
+
# @!attribute [rw] settlement_statuses
|
|
882
|
+
# The settlement statuses to filter by. `OPEN` returns records whose
|
|
883
|
+
# `status` is `OUTSTANDING` or `PROCESSING`. `CLOSED` returns records
|
|
884
|
+
# whose `status` is `SETTLED` or `CANCELED`. When you omit this
|
|
885
|
+
# member, the operation returns records with both settlement statuses.
|
|
886
|
+
# @return [Array<String>]
|
|
887
|
+
#
|
|
888
|
+
# @!attribute [rw] issued_after
|
|
889
|
+
# The earliest date and time to return records for, inclusive. The
|
|
890
|
+
# operation returns the records that were issued at or after this
|
|
891
|
+
# time.
|
|
892
|
+
# @return [Time]
|
|
893
|
+
#
|
|
894
|
+
# @!attribute [rw] issued_before
|
|
895
|
+
# The latest date and time to return records for, exclusive. The
|
|
896
|
+
# operation returns the records that were issued before this time.
|
|
897
|
+
# When you specify both `issuedAfter` and `issuedBefore`,
|
|
898
|
+
# `issuedBefore` must be later than `issuedAfter`.
|
|
899
|
+
# @return [Time]
|
|
900
|
+
#
|
|
901
|
+
# @!attribute [rw] sort_by
|
|
902
|
+
# The field to sort the results by. The default is `ISSUED_AT`, the
|
|
903
|
+
# date and time when the record was issued.
|
|
904
|
+
# @return [String]
|
|
905
|
+
#
|
|
906
|
+
# @!attribute [rw] sort_order
|
|
907
|
+
# The order to sort the results in. The default is `DESCENDING`, which
|
|
908
|
+
# returns the newest records first. `ASCENDING` returns the oldest
|
|
909
|
+
# records first.
|
|
910
|
+
# @return [String]
|
|
911
|
+
#
|
|
912
|
+
# @!attribute [rw] next_token
|
|
913
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
914
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
915
|
+
# malformed or expired, or doesn't match the original request, the
|
|
916
|
+
# request fails with `ValidationException` and the reason
|
|
917
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
918
|
+
# page.
|
|
919
|
+
# @return [String]
|
|
920
|
+
#
|
|
921
|
+
# @!attribute [rw] max_results
|
|
922
|
+
# The maximum number of results to return in one page. The default is
|
|
923
|
+
# 100. A page can contain fewer results even when more remain. Use
|
|
924
|
+
# `nextToken` to find out whether more results are available.
|
|
925
|
+
# @return [Integer]
|
|
926
|
+
#
|
|
927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListFinancialRecordsRequest AWS API Documentation
|
|
928
|
+
#
|
|
929
|
+
class ListFinancialRecordsRequest < Struct.new(
|
|
930
|
+
:types,
|
|
931
|
+
:settlement_statuses,
|
|
932
|
+
:issued_after,
|
|
933
|
+
:issued_before,
|
|
934
|
+
:sort_by,
|
|
935
|
+
:sort_order,
|
|
936
|
+
:next_token,
|
|
937
|
+
:max_results)
|
|
938
|
+
SENSITIVE = []
|
|
939
|
+
include Aws::Structure
|
|
940
|
+
end
|
|
941
|
+
|
|
942
|
+
# @!attribute [rw] financial_record_summaries
|
|
943
|
+
# The financial record summaries that match your filters, in the
|
|
944
|
+
# requested order. This list is empty when no record matches.
|
|
945
|
+
# @return [Array<Types::FinancialRecordSummary>]
|
|
946
|
+
#
|
|
947
|
+
# @!attribute [rw] next_token
|
|
948
|
+
# The pagination token that indicates the next set of results to
|
|
949
|
+
# retrieve. This value is absent when there are no more results.
|
|
950
|
+
# @return [String]
|
|
951
|
+
#
|
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListFinancialRecordsResponse AWS API Documentation
|
|
953
|
+
#
|
|
954
|
+
class ListFinancialRecordsResponse < Struct.new(
|
|
955
|
+
:financial_record_summaries,
|
|
956
|
+
:next_token)
|
|
957
|
+
SENSITIVE = []
|
|
958
|
+
include Aws::Structure
|
|
959
|
+
end
|
|
960
|
+
|
|
961
|
+
# @!attribute [rw] next_token
|
|
962
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
963
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
964
|
+
# malformed or expired, or doesn't match the original request, the
|
|
965
|
+
# request fails with `ValidationException` and the reason
|
|
966
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
967
|
+
# page.
|
|
968
|
+
# @return [String]
|
|
969
|
+
#
|
|
970
|
+
# @!attribute [rw] max_results
|
|
971
|
+
# The maximum number of payment instruments to return in one page. The
|
|
972
|
+
# default is 25. A page can contain fewer payment instruments even
|
|
973
|
+
# when more remain. Use `nextToken` to find out whether more payment
|
|
974
|
+
# instruments are available.
|
|
975
|
+
# @return [Integer]
|
|
976
|
+
#
|
|
977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListPaymentInstrumentsRequest AWS API Documentation
|
|
978
|
+
#
|
|
979
|
+
class ListPaymentInstrumentsRequest < Struct.new(
|
|
980
|
+
:next_token,
|
|
981
|
+
:max_results)
|
|
982
|
+
SENSITIVE = []
|
|
983
|
+
include Aws::Structure
|
|
984
|
+
end
|
|
985
|
+
|
|
986
|
+
# @!attribute [rw] payment_instrument_summaries
|
|
987
|
+
# The payment instruments on your account, one summary for each
|
|
988
|
+
# instrument. This list is empty when your account has no payment
|
|
989
|
+
# instruments.
|
|
990
|
+
# @return [Array<Types::PaymentInstrumentSummary>]
|
|
991
|
+
#
|
|
992
|
+
# @!attribute [rw] next_token
|
|
993
|
+
# The pagination token that indicates the next set of results to
|
|
994
|
+
# retrieve. This value is absent when there are no more results.
|
|
995
|
+
# @return [String]
|
|
996
|
+
#
|
|
997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListPaymentInstrumentsResponse AWS API Documentation
|
|
998
|
+
#
|
|
999
|
+
class ListPaymentInstrumentsResponse < Struct.new(
|
|
1000
|
+
:payment_instrument_summaries,
|
|
1001
|
+
:next_token)
|
|
1002
|
+
SENSITIVE = []
|
|
1003
|
+
include Aws::Structure
|
|
1004
|
+
end
|
|
1005
|
+
|
|
1006
|
+
# A payment instrument on your account, such as a card or a bank
|
|
1007
|
+
# account.
|
|
1008
|
+
#
|
|
1009
|
+
# @!attribute [rw] arn
|
|
1010
|
+
# The Amazon Resource Name (ARN) of the instrument. To allow or deny
|
|
1011
|
+
# `GetPaymentInstrument` for this instrument, use the ARN in the
|
|
1012
|
+
# `Resource` element of an Amazon Web Services Identity and Access
|
|
1013
|
+
# Management (IAM) policy.
|
|
1014
|
+
# @return [String]
|
|
1015
|
+
#
|
|
1016
|
+
# @!attribute [rw] payment_method
|
|
1017
|
+
# The payment method of the instrument. The following values are
|
|
1018
|
+
# valid:
|
|
1019
|
+
#
|
|
1020
|
+
# * `CARD` – A credit or debit card.
|
|
1021
|
+
#
|
|
1022
|
+
# * `US_ACH_BANK_ACCOUNT` – A US bank account debited over Automated
|
|
1023
|
+
# Clearing House (ACH).
|
|
1024
|
+
#
|
|
1025
|
+
# * `SEPA_BANK_ACCOUNT` – A bank account debited over Single Euro
|
|
1026
|
+
# Payments Area (SEPA) Direct Debit.
|
|
1027
|
+
#
|
|
1028
|
+
# * `UK_BACS_BANK_ACCOUNT` – A UK bank account debited over Bacs
|
|
1029
|
+
# Direct Debit.
|
|
1030
|
+
#
|
|
1031
|
+
# * `IN_NET_BANKING` – India net banking. You authorize each payment
|
|
1032
|
+
# on your bank's website.
|
|
1033
|
+
#
|
|
1034
|
+
# * `CN_BANK_REDIRECT` – China bank redirect. You authorize each
|
|
1035
|
+
# payment on your bank's website.
|
|
1036
|
+
#
|
|
1037
|
+
# * `UPI` – Unified Payments Interface, the India real-time payment
|
|
1038
|
+
# system.
|
|
1039
|
+
#
|
|
1040
|
+
# * `PIX` – Pix, the Brazilian Central Bank instant payment system.
|
|
1041
|
+
#
|
|
1042
|
+
# * `PAY_BY_INVOICE` – Pay by invoice. You pay each invoice yourself,
|
|
1043
|
+
# for example by bank transfer, instead of Amazon Web Services
|
|
1044
|
+
# collecting payment from a card or a bank account.
|
|
1045
|
+
# @return [String]
|
|
1046
|
+
#
|
|
1047
|
+
# @!attribute [rw] status
|
|
1048
|
+
# The current status of the instrument. The following values are
|
|
1049
|
+
# valid:
|
|
1050
|
+
#
|
|
1051
|
+
# * `ACTIVE` – The instrument is set up, and Amazon Web Services can
|
|
1052
|
+
# use it for payments. `ACTIVE` doesn't confirm that the instrument
|
|
1053
|
+
# is verified or that a payment with it will succeed. You don't
|
|
1054
|
+
# need to take action.
|
|
1055
|
+
#
|
|
1056
|
+
# * `INVALID` – Amazon Web Services can't use the instrument for
|
|
1057
|
+
# payments, for example because its Direct Debit or UPI mandate is
|
|
1058
|
+
# no longer valid. This status is permanent. The instrument doesn't
|
|
1059
|
+
# return to `ACTIVE`. To pay with this payment method again, add a
|
|
1060
|
+
# new payment instrument.
|
|
1061
|
+
#
|
|
1062
|
+
# * `PENDING_SETUP` – The instrument needs an action from you before
|
|
1063
|
+
# Amazon Web Services can use it, such as resuming a paused UPI
|
|
1064
|
+
# mandate in your UPI app. Amazon Web Services doesn't use the
|
|
1065
|
+
# instrument for payments until you complete that action.
|
|
1066
|
+
#
|
|
1067
|
+
# * `SETUP_IN_PROGRESS` – You completed the setup steps, and setup of
|
|
1068
|
+
# the instrument is in progress, for example while a Direct Debit or
|
|
1069
|
+
# UPI mandate waits for confirmation. Amazon Web Services doesn't
|
|
1070
|
+
# use the instrument for payments until setup is complete. You
|
|
1071
|
+
# don't need to take action.
|
|
1072
|
+
# @return [String]
|
|
1073
|
+
#
|
|
1074
|
+
# @!attribute [rw] details
|
|
1075
|
+
# The details that are specific to the instrument's payment method.
|
|
1076
|
+
# This member is absent for a payment method that has no additional
|
|
1077
|
+
# details.
|
|
1078
|
+
# @return [Types::PaymentInstrumentDetails]
|
|
1079
|
+
#
|
|
1080
|
+
# @!attribute [rw] created_at
|
|
1081
|
+
# The date and time, in UTC, when the instrument was registered.
|
|
1082
|
+
# @return [Time]
|
|
1083
|
+
#
|
|
1084
|
+
# @!attribute [rw] updated_at
|
|
1085
|
+
# The date and time, in UTC, when the instrument was last changed.
|
|
1086
|
+
# @return [Time]
|
|
1087
|
+
#
|
|
1088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/PaymentInstrument AWS API Documentation
|
|
1089
|
+
#
|
|
1090
|
+
class PaymentInstrument < Struct.new(
|
|
1091
|
+
:arn,
|
|
1092
|
+
:payment_method,
|
|
1093
|
+
:status,
|
|
1094
|
+
:details,
|
|
1095
|
+
:created_at,
|
|
1096
|
+
:updated_at)
|
|
1097
|
+
SENSITIVE = []
|
|
1098
|
+
include Aws::Structure
|
|
1099
|
+
end
|
|
1100
|
+
|
|
1101
|
+
# The details that are specific to a payment instrument's payment
|
|
1102
|
+
# method.
|
|
1103
|
+
#
|
|
1104
|
+
# @note PaymentInstrumentDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PaymentInstrumentDetails corresponding to the set member.
|
|
1105
|
+
#
|
|
1106
|
+
# @!attribute [rw] card
|
|
1107
|
+
# The details of a card payment instrument.
|
|
1108
|
+
# @return [Types::Card]
|
|
1109
|
+
#
|
|
1110
|
+
# @!attribute [rw] us_ach_bank_account
|
|
1111
|
+
# The details of a bank account that is debited over Automated
|
|
1112
|
+
# Clearing House (ACH).
|
|
1113
|
+
# @return [Types::UsAchBankAccount]
|
|
1114
|
+
#
|
|
1115
|
+
# @!attribute [rw] sepa_bank_account
|
|
1116
|
+
# The details of a bank account that is debited over Single Euro
|
|
1117
|
+
# Payments Area (SEPA) Direct Debit.
|
|
1118
|
+
# @return [Types::SepaBankAccount]
|
|
1119
|
+
#
|
|
1120
|
+
# @!attribute [rw] uk_bacs_bank_account
|
|
1121
|
+
# The details of a bank account that is debited over Bacs Direct
|
|
1122
|
+
# Debit.
|
|
1123
|
+
# @return [Types::UkBacsBankAccount]
|
|
1124
|
+
#
|
|
1125
|
+
# @!attribute [rw] in_net_banking
|
|
1126
|
+
# The details of an India net banking instrument.
|
|
1127
|
+
# @return [Types::InNetBanking]
|
|
1128
|
+
#
|
|
1129
|
+
# @!attribute [rw] cn_bank_redirect
|
|
1130
|
+
# The details of a China bank redirect instrument.
|
|
1131
|
+
# @return [Types::CnBankRedirect]
|
|
1132
|
+
#
|
|
1133
|
+
# @!attribute [rw] upi
|
|
1134
|
+
# The details of a Unified Payments Interface (UPI) instrument.
|
|
1135
|
+
# @return [Types::Upi]
|
|
1136
|
+
#
|
|
1137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/PaymentInstrumentDetails AWS API Documentation
|
|
1138
|
+
#
|
|
1139
|
+
class PaymentInstrumentDetails < Struct.new(
|
|
1140
|
+
:card,
|
|
1141
|
+
:us_ach_bank_account,
|
|
1142
|
+
:sepa_bank_account,
|
|
1143
|
+
:uk_bacs_bank_account,
|
|
1144
|
+
:in_net_banking,
|
|
1145
|
+
:cn_bank_redirect,
|
|
1146
|
+
:upi,
|
|
1147
|
+
:unknown)
|
|
1148
|
+
SENSITIVE = []
|
|
1149
|
+
include Aws::Structure
|
|
1150
|
+
include Aws::Structure::Union
|
|
1151
|
+
|
|
1152
|
+
class Card < PaymentInstrumentDetails; end
|
|
1153
|
+
class UsAchBankAccount < PaymentInstrumentDetails; end
|
|
1154
|
+
class SepaBankAccount < PaymentInstrumentDetails; end
|
|
1155
|
+
class UkBacsBankAccount < PaymentInstrumentDetails; end
|
|
1156
|
+
class InNetBanking < PaymentInstrumentDetails; end
|
|
1157
|
+
class CnBankRedirect < PaymentInstrumentDetails; end
|
|
1158
|
+
class Upi < PaymentInstrumentDetails; end
|
|
1159
|
+
class Unknown < PaymentInstrumentDetails; end
|
|
1160
|
+
end
|
|
1161
|
+
|
|
1162
|
+
# A payment instrument as it appears in `ListPaymentInstruments`. Call
|
|
1163
|
+
# `GetPaymentInstrument` for the full instrument, including the details
|
|
1164
|
+
# specific to its payment method such as a card's last four digits and
|
|
1165
|
+
# expiration.
|
|
1166
|
+
#
|
|
1167
|
+
# @!attribute [rw] id
|
|
1168
|
+
# The ID of the instrument, unique within your account. It's the last
|
|
1169
|
+
# segment of the instrument's ARN.
|
|
1170
|
+
# @return [String]
|
|
1171
|
+
#
|
|
1172
|
+
# @!attribute [rw] arn
|
|
1173
|
+
# The Amazon Resource Name (ARN) of the instrument. To allow or deny
|
|
1174
|
+
# `GetPaymentInstrument` for this instrument, use the ARN in the
|
|
1175
|
+
# `Resource` element of an Amazon Web Services Identity and Access
|
|
1176
|
+
# Management (IAM) policy.
|
|
1177
|
+
# @return [String]
|
|
1178
|
+
#
|
|
1179
|
+
# @!attribute [rw] payment_method
|
|
1180
|
+
# The payment method of the instrument. The following values are
|
|
1181
|
+
# valid:
|
|
1182
|
+
#
|
|
1183
|
+
# * `CARD` – A credit or debit card.
|
|
1184
|
+
#
|
|
1185
|
+
# * `US_ACH_BANK_ACCOUNT` – A US bank account debited over Automated
|
|
1186
|
+
# Clearing House (ACH).
|
|
1187
|
+
#
|
|
1188
|
+
# * `SEPA_BANK_ACCOUNT` – A bank account debited over Single Euro
|
|
1189
|
+
# Payments Area (SEPA) Direct Debit.
|
|
1190
|
+
#
|
|
1191
|
+
# * `UK_BACS_BANK_ACCOUNT` – A UK bank account debited over Bacs
|
|
1192
|
+
# Direct Debit.
|
|
1193
|
+
#
|
|
1194
|
+
# * `IN_NET_BANKING` – India net banking. You authorize each payment
|
|
1195
|
+
# on your bank's website.
|
|
1196
|
+
#
|
|
1197
|
+
# * `CN_BANK_REDIRECT` – China bank redirect. You authorize each
|
|
1198
|
+
# payment on your bank's website.
|
|
1199
|
+
#
|
|
1200
|
+
# * `UPI` – Unified Payments Interface, the India real-time payment
|
|
1201
|
+
# system.
|
|
1202
|
+
#
|
|
1203
|
+
# * `PIX` – Pix, the Brazilian Central Bank instant payment system.
|
|
1204
|
+
#
|
|
1205
|
+
# * `PAY_BY_INVOICE` – Pay by invoice. You pay each invoice yourself,
|
|
1206
|
+
# for example by bank transfer, instead of Amazon Web Services
|
|
1207
|
+
# collecting payment from a card or a bank account.
|
|
1208
|
+
# @return [String]
|
|
1209
|
+
#
|
|
1210
|
+
# @!attribute [rw] status
|
|
1211
|
+
# The current status of the instrument. The following values are
|
|
1212
|
+
# valid:
|
|
1213
|
+
#
|
|
1214
|
+
# * `ACTIVE` – The instrument is set up, and Amazon Web Services can
|
|
1215
|
+
# use it for payments. `ACTIVE` doesn't confirm that the instrument
|
|
1216
|
+
# is verified or that a payment with it will succeed. You don't
|
|
1217
|
+
# need to take action.
|
|
1218
|
+
#
|
|
1219
|
+
# * `INVALID` – Amazon Web Services can't use the instrument for
|
|
1220
|
+
# payments, for example because its Direct Debit or UPI mandate is
|
|
1221
|
+
# no longer valid. This status is permanent. The instrument doesn't
|
|
1222
|
+
# return to `ACTIVE`. To pay with this payment method again, add a
|
|
1223
|
+
# new payment instrument.
|
|
1224
|
+
#
|
|
1225
|
+
# * `PENDING_SETUP` – The instrument needs an action from you before
|
|
1226
|
+
# Amazon Web Services can use it, such as resuming a paused UPI
|
|
1227
|
+
# mandate in your UPI app. Amazon Web Services doesn't use the
|
|
1228
|
+
# instrument for payments until you complete that action.
|
|
1229
|
+
#
|
|
1230
|
+
# * `SETUP_IN_PROGRESS` – You completed the setup steps, and setup of
|
|
1231
|
+
# the instrument is in progress, for example while a Direct Debit or
|
|
1232
|
+
# UPI mandate waits for confirmation. Amazon Web Services doesn't
|
|
1233
|
+
# use the instrument for payments until setup is complete. You
|
|
1234
|
+
# don't need to take action.
|
|
1235
|
+
# @return [String]
|
|
1236
|
+
#
|
|
1237
|
+
# @!attribute [rw] created_at
|
|
1238
|
+
# The date and time, in UTC, when the instrument was registered.
|
|
1239
|
+
# @return [Time]
|
|
1240
|
+
#
|
|
1241
|
+
# @!attribute [rw] updated_at
|
|
1242
|
+
# The date and time, in UTC, when the instrument was last changed.
|
|
1243
|
+
# @return [Time]
|
|
1244
|
+
#
|
|
1245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/PaymentInstrumentSummary AWS API Documentation
|
|
1246
|
+
#
|
|
1247
|
+
class PaymentInstrumentSummary < Struct.new(
|
|
1248
|
+
:id,
|
|
1249
|
+
:arn,
|
|
1250
|
+
:payment_method,
|
|
1251
|
+
:status,
|
|
1252
|
+
:created_at,
|
|
1253
|
+
:updated_at)
|
|
1254
|
+
SENSITIVE = []
|
|
1255
|
+
include Aws::Structure
|
|
1256
|
+
end
|
|
1257
|
+
|
|
1258
|
+
# The requested resource couldn't be found. Verify that the resource ID
|
|
1259
|
+
# is correct. This error is returned only when you're authorized for
|
|
1260
|
+
# the resource.
|
|
1261
|
+
#
|
|
1262
|
+
# @!attribute [rw] message
|
|
1263
|
+
# @return [String]
|
|
1264
|
+
#
|
|
1265
|
+
# @!attribute [rw] resource_id
|
|
1266
|
+
# The ID of the resource that wasn't found.
|
|
1267
|
+
# @return [String]
|
|
1268
|
+
#
|
|
1269
|
+
# @!attribute [rw] resource_type
|
|
1270
|
+
# The type of the resource that wasn't found.
|
|
1271
|
+
# @return [String]
|
|
1272
|
+
#
|
|
1273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ResourceNotFoundException AWS API Documentation
|
|
1274
|
+
#
|
|
1275
|
+
class ResourceNotFoundException < Struct.new(
|
|
1276
|
+
:message,
|
|
1277
|
+
:resource_id,
|
|
1278
|
+
:resource_type)
|
|
1279
|
+
SENSITIVE = []
|
|
1280
|
+
include Aws::Structure
|
|
1281
|
+
end
|
|
1282
|
+
|
|
1283
|
+
# The details of a bank account that is debited over Single Euro
|
|
1284
|
+
# Payments Area (SEPA) Direct Debit.
|
|
1285
|
+
#
|
|
1286
|
+
# @!attribute [rw] account_number_tail
|
|
1287
|
+
# The last one to four characters of the account number. This member
|
|
1288
|
+
# is absent until your bank provides the account details, for example
|
|
1289
|
+
# before you complete authentication with your bank.
|
|
1290
|
+
# @return [String]
|
|
1291
|
+
#
|
|
1292
|
+
# @!attribute [rw] account_holder_name
|
|
1293
|
+
# The name on the account.
|
|
1294
|
+
# @return [String]
|
|
1295
|
+
#
|
|
1296
|
+
# @!attribute [rw] bank_name
|
|
1297
|
+
# The bank holding the account.
|
|
1298
|
+
# @return [String]
|
|
1299
|
+
#
|
|
1300
|
+
# @!attribute [rw] account_type
|
|
1301
|
+
# Whether the account is a checking account or a savings account.
|
|
1302
|
+
# @return [String]
|
|
1303
|
+
#
|
|
1304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/SepaBankAccount AWS API Documentation
|
|
1305
|
+
#
|
|
1306
|
+
class SepaBankAccount < Struct.new(
|
|
1307
|
+
:account_number_tail,
|
|
1308
|
+
:account_holder_name,
|
|
1309
|
+
:bank_name,
|
|
1310
|
+
:account_type)
|
|
1311
|
+
SENSITIVE = [:account_number_tail, :account_holder_name]
|
|
1312
|
+
include Aws::Structure
|
|
1313
|
+
end
|
|
1314
|
+
|
|
1315
|
+
# The request was denied due to request throttling. Reduce the frequency
|
|
1316
|
+
# of your requests and try again.
|
|
1317
|
+
#
|
|
1318
|
+
# @!attribute [rw] message
|
|
1319
|
+
# @return [String]
|
|
1320
|
+
#
|
|
1321
|
+
# @!attribute [rw] retry_after_seconds
|
|
1322
|
+
# The suggested number of seconds to wait before retrying the request.
|
|
1323
|
+
# @return [Integer]
|
|
1324
|
+
#
|
|
1325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ThrottlingException AWS API Documentation
|
|
1326
|
+
#
|
|
1327
|
+
class ThrottlingException < Struct.new(
|
|
1328
|
+
:message,
|
|
1329
|
+
:retry_after_seconds)
|
|
1330
|
+
SENSITIVE = []
|
|
1331
|
+
include Aws::Structure
|
|
1332
|
+
end
|
|
1333
|
+
|
|
1334
|
+
# The details of a bank account that is debited over Bacs Direct Debit.
|
|
1335
|
+
#
|
|
1336
|
+
# @!attribute [rw] account_number_tail
|
|
1337
|
+
# The last one to four characters of the account number. This member
|
|
1338
|
+
# is absent until your bank provides the account details, for example
|
|
1339
|
+
# before you complete authentication with your bank.
|
|
1340
|
+
# @return [String]
|
|
1341
|
+
#
|
|
1342
|
+
# @!attribute [rw] account_holder_name
|
|
1343
|
+
# The name on the account.
|
|
1344
|
+
# @return [String]
|
|
1345
|
+
#
|
|
1346
|
+
# @!attribute [rw] bank_name
|
|
1347
|
+
# The bank holding the account.
|
|
1348
|
+
# @return [String]
|
|
1349
|
+
#
|
|
1350
|
+
# @!attribute [rw] account_type
|
|
1351
|
+
# Whether the account is a checking account or a savings account.
|
|
1352
|
+
# @return [String]
|
|
1353
|
+
#
|
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/UkBacsBankAccount AWS API Documentation
|
|
1355
|
+
#
|
|
1356
|
+
class UkBacsBankAccount < Struct.new(
|
|
1357
|
+
:account_number_tail,
|
|
1358
|
+
:account_holder_name,
|
|
1359
|
+
:bank_name,
|
|
1360
|
+
:account_type)
|
|
1361
|
+
SENSITIVE = [:account_number_tail, :account_holder_name]
|
|
1362
|
+
include Aws::Structure
|
|
1363
|
+
end
|
|
1364
|
+
|
|
1365
|
+
# The details of a Unified Payments Interface (UPI) instrument.
|
|
1366
|
+
#
|
|
1367
|
+
# @!attribute [rw] app_name
|
|
1368
|
+
# The name of the UPI app that the instrument is registered with.
|
|
1369
|
+
# @return [String]
|
|
1370
|
+
#
|
|
1371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/Upi AWS API Documentation
|
|
1372
|
+
#
|
|
1373
|
+
class Upi < Struct.new(
|
|
1374
|
+
:app_name)
|
|
1375
|
+
SENSITIVE = []
|
|
1376
|
+
include Aws::Structure
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1379
|
+
# The details of a bank account that is debited over Automated Clearing
|
|
1380
|
+
# House (ACH).
|
|
1381
|
+
#
|
|
1382
|
+
# @!attribute [rw] account_number_tail
|
|
1383
|
+
# The last one to four characters of the account number. This member
|
|
1384
|
+
# is absent until your bank provides the account details, for example
|
|
1385
|
+
# before you complete authentication with your bank.
|
|
1386
|
+
# @return [String]
|
|
1387
|
+
#
|
|
1388
|
+
# @!attribute [rw] account_holder_name
|
|
1389
|
+
# The name on the account.
|
|
1390
|
+
# @return [String]
|
|
1391
|
+
#
|
|
1392
|
+
# @!attribute [rw] bank_name
|
|
1393
|
+
# The bank holding the account.
|
|
1394
|
+
# @return [String]
|
|
1395
|
+
#
|
|
1396
|
+
# @!attribute [rw] account_type
|
|
1397
|
+
# Whether the account is a checking account or a savings account.
|
|
1398
|
+
# @return [String]
|
|
1399
|
+
#
|
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/UsAchBankAccount AWS API Documentation
|
|
1401
|
+
#
|
|
1402
|
+
class UsAchBankAccount < Struct.new(
|
|
1403
|
+
:account_number_tail,
|
|
1404
|
+
:account_holder_name,
|
|
1405
|
+
:bank_name,
|
|
1406
|
+
:account_type)
|
|
1407
|
+
SENSITIVE = [:account_number_tail, :account_holder_name]
|
|
1408
|
+
include Aws::Structure
|
|
1409
|
+
end
|
|
1410
|
+
|
|
1411
|
+
# The request isn't valid. Check `reason` and `fieldList` for the
|
|
1412
|
+
# cause, correct the request, and try again.
|
|
1413
|
+
#
|
|
1414
|
+
# @!attribute [rw] message
|
|
1415
|
+
# @return [String]
|
|
1416
|
+
#
|
|
1417
|
+
# @!attribute [rw] reason
|
|
1418
|
+
# The reason that validation failed. The following values are valid:
|
|
1419
|
+
#
|
|
1420
|
+
# * `CANNOT_PARSE` – The request body couldn't be parsed, or a value
|
|
1421
|
+
# isn't of the expected type.
|
|
1422
|
+
#
|
|
1423
|
+
# * `FIELD_VALIDATION_FAILED` – One or more members failed validation.
|
|
1424
|
+
# `fieldList` names them.
|
|
1425
|
+
#
|
|
1426
|
+
# * `INVALID_PAGINATION_TOKEN` – The `nextToken` is malformed or
|
|
1427
|
+
# expired, or doesn't match the original request. Start again from
|
|
1428
|
+
# the first page.
|
|
1429
|
+
#
|
|
1430
|
+
# * `UNSUPPORTED_ACTION` – The request is well formed, but the action
|
|
1431
|
+
# isn't supported for your account, Region, or resource.
|
|
1432
|
+
#
|
|
1433
|
+
# * `OTHER` – The request isn't valid for another reason.
|
|
1434
|
+
# @return [String]
|
|
1435
|
+
#
|
|
1436
|
+
# @!attribute [rw] field_list
|
|
1437
|
+
# The request members that failed validation. This member is populated
|
|
1438
|
+
# when `reason` is `FIELD_VALIDATION_FAILED`.
|
|
1439
|
+
# @return [Array<Types::ValidationExceptionField>]
|
|
1440
|
+
#
|
|
1441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ValidationException AWS API Documentation
|
|
1442
|
+
#
|
|
1443
|
+
class ValidationException < Struct.new(
|
|
1444
|
+
:message,
|
|
1445
|
+
:reason,
|
|
1446
|
+
:field_list)
|
|
1447
|
+
SENSITIVE = []
|
|
1448
|
+
include Aws::Structure
|
|
1449
|
+
end
|
|
1450
|
+
|
|
1451
|
+
# A request member that failed validation.
|
|
1452
|
+
#
|
|
1453
|
+
# @!attribute [rw] name
|
|
1454
|
+
# The name of the request member that failed validation. For a member
|
|
1455
|
+
# nested inside another member, the name is a path from the request
|
|
1456
|
+
# root, with the segments separated by periods.
|
|
1457
|
+
# @return [String]
|
|
1458
|
+
#
|
|
1459
|
+
# @!attribute [rw] message
|
|
1460
|
+
# A description of why this member failed validation.
|
|
1461
|
+
# @return [String]
|
|
1462
|
+
#
|
|
1463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ValidationExceptionField AWS API Documentation
|
|
1464
|
+
#
|
|
1465
|
+
class ValidationExceptionField < Struct.new(
|
|
1466
|
+
:name,
|
|
1467
|
+
:message)
|
|
1468
|
+
SENSITIVE = []
|
|
1469
|
+
include Aws::Structure
|
|
1470
|
+
end
|
|
1471
|
+
|
|
1472
|
+
end
|
|
1473
|
+
end
|
|
1474
|
+
|