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,1276 @@
|
|
|
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
|
+
require 'seahorse/client/plugins/content_length'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
|
37
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc'
|
|
38
|
+
|
|
39
|
+
module Aws::Payments
|
|
40
|
+
# An API client for Payments. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
41
|
+
#
|
|
42
|
+
# client = Aws::Payments::Client.new(
|
|
43
|
+
# region: region_name,
|
|
44
|
+
# credentials: credentials,
|
|
45
|
+
# # ...
|
|
46
|
+
# )
|
|
47
|
+
#
|
|
48
|
+
# For details on configuring region and credentials see
|
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
|
50
|
+
#
|
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
|
52
|
+
class Client < Seahorse::Client::Base
|
|
53
|
+
|
|
54
|
+
include Aws::ClientStubs
|
|
55
|
+
|
|
56
|
+
@identifier = :payments
|
|
57
|
+
|
|
58
|
+
set_api(ClientApi::API)
|
|
59
|
+
|
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
|
76
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
78
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
79
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
|
80
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
86
|
+
add_plugin(Aws::Plugins::Sign)
|
|
87
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
88
|
+
add_plugin(Aws::Payments::Plugins::Endpoints)
|
|
89
|
+
|
|
90
|
+
# @overload initialize(options)
|
|
91
|
+
# @param [Hash] options
|
|
92
|
+
#
|
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
|
95
|
+
# class name or an instance of a plugin class.
|
|
96
|
+
#
|
|
97
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
100
|
+
#
|
|
101
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
102
|
+
# credentials.
|
|
103
|
+
#
|
|
104
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
|
105
|
+
# shared file, such as `~/.aws/config`.
|
|
106
|
+
#
|
|
107
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
108
|
+
#
|
|
109
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
|
110
|
+
# assume a role after providing credentials via the web.
|
|
111
|
+
#
|
|
112
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
|
113
|
+
# access token generated from `aws login`.
|
|
114
|
+
#
|
|
115
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
|
116
|
+
# process that outputs to stdout.
|
|
117
|
+
#
|
|
118
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
119
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
120
|
+
#
|
|
121
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
|
122
|
+
# instances running in ECS.
|
|
123
|
+
#
|
|
124
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
125
|
+
# from the Cognito Identity service.
|
|
126
|
+
#
|
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
128
|
+
#
|
|
129
|
+
# * `Aws.config[:credentials]`
|
|
130
|
+
#
|
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
|
+
# `:account_id` options.
|
|
133
|
+
#
|
|
134
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
135
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
136
|
+
#
|
|
137
|
+
# * `~/.aws/credentials`
|
|
138
|
+
#
|
|
139
|
+
# * `~/.aws/config`
|
|
140
|
+
#
|
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
145
|
+
#
|
|
146
|
+
# @option options [required, String] :region
|
|
147
|
+
# The AWS region to connect to. The configured `:region` is
|
|
148
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
149
|
+
# a default `:region` is searched for in the following locations:
|
|
150
|
+
#
|
|
151
|
+
# * `Aws.config[:region]`
|
|
152
|
+
# * `ENV['AWS_REGION']`
|
|
153
|
+
# * `ENV['AMAZON_REGION']`
|
|
154
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
155
|
+
# * `~/.aws/credentials`
|
|
156
|
+
# * `~/.aws/config`
|
|
157
|
+
#
|
|
158
|
+
# @option options [String] :access_key_id
|
|
159
|
+
#
|
|
160
|
+
# @option options [String] :account_id
|
|
161
|
+
#
|
|
162
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
|
163
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
|
164
|
+
# the background every 60 secs (default). Defaults to `false`.
|
|
165
|
+
#
|
|
166
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
167
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
168
|
+
# until there is sufficent client side capacity to retry the request.
|
|
169
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
170
|
+
# not retry instead of sleeping.
|
|
171
|
+
#
|
|
172
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
173
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
174
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
175
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
176
|
+
#
|
|
177
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
|
178
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
|
179
|
+
# this client.
|
|
180
|
+
#
|
|
181
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
|
182
|
+
# Allows you to provide an identifier for this client which will be attached to
|
|
183
|
+
# all generated client side metrics. Defaults to an empty string.
|
|
184
|
+
#
|
|
185
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
|
186
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
|
187
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
|
188
|
+
#
|
|
189
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
|
190
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
|
191
|
+
# agent is running on, where client metrics will be published via UDP.
|
|
192
|
+
#
|
|
193
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
|
194
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
|
195
|
+
# will use the Client Side Monitoring Agent Publisher.
|
|
196
|
+
#
|
|
197
|
+
# @option options [Boolean] :convert_params (true)
|
|
198
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
199
|
+
# the required types.
|
|
200
|
+
#
|
|
201
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether
|
|
203
|
+
# to apply a clock skew correction and retry requests with skewed client
|
|
204
|
+
# clocks. Takes effect only when `disable_clock_skew_correction` is not set.
|
|
205
|
+
#
|
|
206
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
207
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
208
|
+
# accepted modes and the configuration defaults that are included.
|
|
209
|
+
#
|
|
210
|
+
# @option options [Boolean] :disable_clock_skew_correction
|
|
211
|
+
# Used only in `standard` and `adaptive` retry modes. When `true`, the
|
|
212
|
+
# SDK does not apply a clock skew correction, does not update its stored
|
|
213
|
+
# skew from responses, and does not retry clock skew errors. Clock skew
|
|
214
|
+
# correction is enabled by default.
|
|
215
|
+
#
|
|
216
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
217
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
218
|
+
#
|
|
219
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
220
|
+
# When set to 'true' the request body will not be compressed
|
|
221
|
+
# for supported operations.
|
|
222
|
+
#
|
|
223
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
224
|
+
# Normally you should not configure the `:endpoint` option
|
|
225
|
+
# directly. This is normally constructed from the `:region`
|
|
226
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
227
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
228
|
+
# be a URI formatted like:
|
|
229
|
+
#
|
|
230
|
+
# 'http://example.com'
|
|
231
|
+
# 'https://example.com'
|
|
232
|
+
# 'http://example.com:123'
|
|
233
|
+
#
|
|
234
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
235
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
236
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
|
237
|
+
#
|
|
238
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
|
239
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
|
240
|
+
#
|
|
241
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
|
242
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
|
243
|
+
# Use this option to config the time interval in seconds for making
|
|
244
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
|
245
|
+
#
|
|
246
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
|
247
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
248
|
+
#
|
|
249
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
250
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
251
|
+
# variables and the shared configuration file.
|
|
252
|
+
#
|
|
253
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
254
|
+
# The log formatter.
|
|
255
|
+
#
|
|
256
|
+
# @option options [Symbol] :log_level (:info)
|
|
257
|
+
# The log level to send messages to the `:logger` at.
|
|
258
|
+
#
|
|
259
|
+
# @option options [Logger] :logger
|
|
260
|
+
# The Logger instance to send log messages to. If this option
|
|
261
|
+
# is not set, logging will be disabled.
|
|
262
|
+
#
|
|
263
|
+
# @option options [Integer] :max_attempts (3)
|
|
264
|
+
# An integer representing the maximum number attempts that will be made for
|
|
265
|
+
# a single request, including the initial attempt. For example,
|
|
266
|
+
# setting this value to 5 will result in a request being retried up to
|
|
267
|
+
# 4 times. Used in `standard` and `adaptive` retry modes. Defaults to 3,
|
|
268
|
+
# except for DynamoDB and DynamoDB Streams, which default to 4.
|
|
269
|
+
#
|
|
270
|
+
# @option options [String] :profile ("default")
|
|
271
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
272
|
+
# When not specified, 'default' is used.
|
|
273
|
+
#
|
|
274
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
275
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
276
|
+
#
|
|
277
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
278
|
+
# calculated for all request payloads of operations modeled with the
|
|
279
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
280
|
+
# `requestAlgorithmMember` is modeled.
|
|
281
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
282
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
283
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
284
|
+
# is modeled and supplied.
|
|
285
|
+
#
|
|
286
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
287
|
+
# The minimum size in bytes that triggers compression for request
|
|
288
|
+
# bodies. The value must be non-negative integer value between 0
|
|
289
|
+
# and 10485780 bytes inclusive.
|
|
290
|
+
#
|
|
291
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
292
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
293
|
+
#
|
|
294
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
295
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
296
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
297
|
+
# are supported.
|
|
298
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
299
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
300
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
301
|
+
#
|
|
302
|
+
# @option options [Proc] :retry_backoff
|
|
303
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
304
|
+
# This option is only used in the `legacy` retry mode.
|
|
305
|
+
#
|
|
306
|
+
# @option options [Float] :retry_base_delay (0.3)
|
|
307
|
+
# The base delay in seconds used by the default backoff function. This option
|
|
308
|
+
# is only used in the `legacy` retry mode.
|
|
309
|
+
#
|
|
310
|
+
# @option options [Symbol] :retry_jitter (:none)
|
|
311
|
+
# A delay randomiser function used by the default backoff function.
|
|
312
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
|
313
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
|
314
|
+
# in the `legacy` retry mode.
|
|
315
|
+
#
|
|
316
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
317
|
+
#
|
|
318
|
+
# @option options [Integer] :retry_limit (3)
|
|
319
|
+
# The maximum number of times to retry failed requests. Only
|
|
320
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
321
|
+
# are retried. Generally, these are throttling errors, data
|
|
322
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
|
323
|
+
# endpoint discovery, and errors from expired credentials.
|
|
324
|
+
# This option is only used in the `legacy` retry mode.
|
|
325
|
+
#
|
|
326
|
+
# @option options [Integer] :retry_max_delay (0)
|
|
327
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
328
|
+
# used by the default backoff function. This option is only used in the
|
|
329
|
+
# `legacy` retry mode.
|
|
330
|
+
#
|
|
331
|
+
# @option options [String] :retry_mode ("standard")
|
|
332
|
+
# Specifies which retry algorithm to use. Values are:
|
|
333
|
+
#
|
|
334
|
+
# * `legacy` - The pre-existing retry behavior.
|
|
335
|
+
#
|
|
336
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
337
|
+
# This includes support for retry quotas, which limit the number of
|
|
338
|
+
# unsuccessful retries a client can make. This is the default value
|
|
339
|
+
# if no retry mode is provided.
|
|
340
|
+
#
|
|
341
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
342
|
+
# `standard` mode along with automatic client side throttling.
|
|
343
|
+
#
|
|
344
|
+
# @option options [String] :sdk_ua_app_id
|
|
345
|
+
# A unique and opaque application ID that is appended to the
|
|
346
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
347
|
+
# maximum length of 50. This variable is sourced from environment
|
|
348
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
349
|
+
#
|
|
350
|
+
# @option options [String] :secret_access_key
|
|
351
|
+
#
|
|
352
|
+
# @option options [String] :session_token
|
|
353
|
+
#
|
|
354
|
+
# @option options [Array] :sigv4a_signing_region_set
|
|
355
|
+
# A list of regions that should be signed with SigV4a signing. When
|
|
356
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
|
357
|
+
# in the following locations:
|
|
358
|
+
#
|
|
359
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
|
360
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
|
361
|
+
# * `~/.aws/config`
|
|
362
|
+
#
|
|
363
|
+
# @option options [Boolean] :simple_json (false)
|
|
364
|
+
# Disables request parameter conversion, validation, and formatting.
|
|
365
|
+
# Also disables response data type conversions. The request parameters
|
|
366
|
+
# hash must be formatted exactly as the API expects.This option is useful
|
|
367
|
+
# when you want to ensure the highest level of performance by avoiding
|
|
368
|
+
# overhead of walking request parameters and response data structures.
|
|
369
|
+
#
|
|
370
|
+
# @option options [Boolean] :stub_responses (false)
|
|
371
|
+
# Causes the client to return stubbed responses. By default
|
|
372
|
+
# fake responses are generated and returned. You can specify
|
|
373
|
+
# the response data to return or errors to raise by calling
|
|
374
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
375
|
+
#
|
|
376
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
377
|
+
# requests are made, and retries are disabled.
|
|
378
|
+
#
|
|
379
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
380
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
381
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
382
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
383
|
+
# following telemetry providers:
|
|
384
|
+
#
|
|
385
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
386
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
387
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
388
|
+
#
|
|
389
|
+
# @option options [Aws::TokenProvider] :token_provider
|
|
390
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
391
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
392
|
+
#
|
|
393
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
394
|
+
# tokens.
|
|
395
|
+
#
|
|
396
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
|
397
|
+
# access token generated from `aws login`.
|
|
398
|
+
#
|
|
399
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
|
400
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
|
401
|
+
#
|
|
402
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
403
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
404
|
+
# will be used if available.
|
|
405
|
+
#
|
|
406
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
407
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
408
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
409
|
+
# is set to `true`.
|
|
410
|
+
#
|
|
411
|
+
# @option options [Boolean] :validate_params (true)
|
|
412
|
+
# When `true`, request parameters are validated before
|
|
413
|
+
# sending the request.
|
|
414
|
+
#
|
|
415
|
+
# @option options [Aws::Payments::EndpointProvider] :endpoint_provider
|
|
416
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
417
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
|
418
|
+
# `Aws::Payments::EndpointParameters`.
|
|
419
|
+
#
|
|
420
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
421
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
422
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
423
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
424
|
+
# behaviour. This value can safely be set per request on the session.
|
|
425
|
+
#
|
|
426
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
427
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
428
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
429
|
+
# pool before making a request.
|
|
430
|
+
#
|
|
431
|
+
# @option options [Float] :http_open_timeout (15)
|
|
432
|
+
# The default number of seconds to wait for response data.
|
|
433
|
+
# This value can safely be set per-request on the session.
|
|
434
|
+
#
|
|
435
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
436
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
437
|
+
#
|
|
438
|
+
# @option options [Float] :http_read_timeout (60)
|
|
439
|
+
# The default number of seconds to wait for response data.
|
|
440
|
+
# This value can safely be set per-request on the session.
|
|
441
|
+
#
|
|
442
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
443
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
444
|
+
#
|
|
445
|
+
# @option options [Proc] :on_chunk_received
|
|
446
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
447
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
448
|
+
# the number of bytes received, and the total number of
|
|
449
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
450
|
+
#
|
|
451
|
+
# @option options [Proc] :on_chunk_sent
|
|
452
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
453
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
454
|
+
# the number of bytes read from the body, and the total number of
|
|
455
|
+
# bytes in the body.
|
|
456
|
+
#
|
|
457
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
458
|
+
# When `true`, response errors are raised.
|
|
459
|
+
#
|
|
460
|
+
# @option options [String] :ssl_ca_bundle
|
|
461
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
462
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
463
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
464
|
+
#
|
|
465
|
+
# @option options [String] :ssl_ca_directory
|
|
466
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
467
|
+
# authority files for verifying peer certificates. If you do
|
|
468
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
469
|
+
# default will be used if available.
|
|
470
|
+
#
|
|
471
|
+
# @option options [String] :ssl_ca_store
|
|
472
|
+
# Sets the X509::Store to verify peer certificate.
|
|
473
|
+
#
|
|
474
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
475
|
+
# Sets a client certificate when creating http connections.
|
|
476
|
+
#
|
|
477
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
478
|
+
# Sets a client key when creating http connections.
|
|
479
|
+
#
|
|
480
|
+
# @option options [Float] :ssl_timeout
|
|
481
|
+
# Sets the SSL timeout in seconds
|
|
482
|
+
#
|
|
483
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
484
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
485
|
+
#
|
|
486
|
+
def initialize(*args)
|
|
487
|
+
super
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
# @!group API Operations
|
|
491
|
+
|
|
492
|
+
# Retrieves up to 100 financial records in one request, including the
|
|
493
|
+
# details that are specific to each record's type. Identify each record
|
|
494
|
+
# by its ID or by its invoice ID. Results can be partial: each key that
|
|
495
|
+
# you request appears once in the response, either as a record in
|
|
496
|
+
# `financialRecords` or as an error in `errors`. A key that matches no
|
|
497
|
+
# record on your account is returned in `errors` and doesn't fail the
|
|
498
|
+
# request. This operation provides strongly consistent reads.
|
|
499
|
+
#
|
|
500
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
501
|
+
# Access Management (IAM) permission for both
|
|
502
|
+
# `payments:BatchGetFinancialRecord` and `payments:GetPaymentStatus`.
|
|
503
|
+
#
|
|
504
|
+
# @option params [required, Array<Types::FinancialRecordKey>] :keys
|
|
505
|
+
# The keys of the financial records to retrieve. Each key is either the
|
|
506
|
+
# record's ID or its invoice ID.
|
|
507
|
+
#
|
|
508
|
+
# @return [Types::BatchGetFinancialRecordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
509
|
+
#
|
|
510
|
+
# * {Types::BatchGetFinancialRecordResponse#financial_records #financial_records} => Array<Types::FinancialRecord>
|
|
511
|
+
# * {Types::BatchGetFinancialRecordResponse#errors #errors} => Array<Types::FinancialRecordError>
|
|
512
|
+
#
|
|
513
|
+
#
|
|
514
|
+
# @example Example: Invoke BatchGetFinancialRecord
|
|
515
|
+
#
|
|
516
|
+
# resp = client.batch_get_financial_record({
|
|
517
|
+
# keys: [
|
|
518
|
+
# {
|
|
519
|
+
# identifier: "INV-1234-5678-9012-3456",
|
|
520
|
+
# },
|
|
521
|
+
# {
|
|
522
|
+
# invoice_identifier: "999999999999",
|
|
523
|
+
# },
|
|
524
|
+
# ],
|
|
525
|
+
# })
|
|
526
|
+
#
|
|
527
|
+
# resp.to_h outputs the following:
|
|
528
|
+
# {
|
|
529
|
+
# errors: [
|
|
530
|
+
# {
|
|
531
|
+
# key: {
|
|
532
|
+
# invoice_identifier: "999999999999",
|
|
533
|
+
# },
|
|
534
|
+
# code: "NOT_FOUND",
|
|
535
|
+
# message: "The requested resource was not found",
|
|
536
|
+
# },
|
|
537
|
+
# ],
|
|
538
|
+
# financial_records: [
|
|
539
|
+
# {
|
|
540
|
+
# type: "INVOICE",
|
|
541
|
+
# amount: {
|
|
542
|
+
# value: "1000.24",
|
|
543
|
+
# currency: "USD",
|
|
544
|
+
# },
|
|
545
|
+
# balances: {
|
|
546
|
+
# canceled: {
|
|
547
|
+
# value: "0.0",
|
|
548
|
+
# currency: "USD",
|
|
549
|
+
# },
|
|
550
|
+
# outstanding: {
|
|
551
|
+
# value: "0.0",
|
|
552
|
+
# currency: "USD",
|
|
553
|
+
# },
|
|
554
|
+
# processing: {
|
|
555
|
+
# value: "0.0",
|
|
556
|
+
# currency: "USD",
|
|
557
|
+
# },
|
|
558
|
+
# settled: {
|
|
559
|
+
# value: "1000.24",
|
|
560
|
+
# currency: "USD",
|
|
561
|
+
# },
|
|
562
|
+
# },
|
|
563
|
+
# business_unit: {
|
|
564
|
+
# line_of_business: "AWS_CLOUD_SERVICES",
|
|
565
|
+
# merchant_of_record: "Amazon Web Services, Inc.",
|
|
566
|
+
# },
|
|
567
|
+
# closed_at: Time.parse(1736208000),
|
|
568
|
+
# details: {
|
|
569
|
+
# invoice_details: {
|
|
570
|
+
# billing_period: {
|
|
571
|
+
# end_date: Time.parse(1735689600),
|
|
572
|
+
# start_date: Time.parse(1733011200),
|
|
573
|
+
# },
|
|
574
|
+
# due_date: Time.parse(1738281600),
|
|
575
|
+
# invoice_frequency: "RECURRING",
|
|
576
|
+
# invoice_id: "536462537364",
|
|
577
|
+
# payment_terms: "Net30",
|
|
578
|
+
# },
|
|
579
|
+
# },
|
|
580
|
+
# id: "INV-1234-5678-9012-3456",
|
|
581
|
+
# issued_at: Time.parse(1735689600),
|
|
582
|
+
# settlement_status: "CLOSED",
|
|
583
|
+
# status: "SETTLED",
|
|
584
|
+
# },
|
|
585
|
+
# ],
|
|
586
|
+
# }
|
|
587
|
+
#
|
|
588
|
+
# @example Request syntax with placeholder values
|
|
589
|
+
#
|
|
590
|
+
# resp = client.batch_get_financial_record({
|
|
591
|
+
# keys: [ # required
|
|
592
|
+
# {
|
|
593
|
+
# identifier: "FinancialRecordIdentifier",
|
|
594
|
+
# invoice_identifier: "InvoiceId",
|
|
595
|
+
# },
|
|
596
|
+
# ],
|
|
597
|
+
# })
|
|
598
|
+
#
|
|
599
|
+
# @example Response structure
|
|
600
|
+
#
|
|
601
|
+
# resp.financial_records #=> Array
|
|
602
|
+
# resp.financial_records[0].id #=> String
|
|
603
|
+
# resp.financial_records[0].type #=> String, one of "INVOICE", "CREDIT_MEMO"
|
|
604
|
+
# resp.financial_records[0].business_unit.merchant_of_record #=> String
|
|
605
|
+
# resp.financial_records[0].business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
|
|
606
|
+
# resp.financial_records[0].amount.value #=> String
|
|
607
|
+
# resp.financial_records[0].amount.currency #=> String
|
|
608
|
+
# resp.financial_records[0].balances.outstanding.value #=> String
|
|
609
|
+
# resp.financial_records[0].balances.outstanding.currency #=> String
|
|
610
|
+
# resp.financial_records[0].balances.processing.value #=> String
|
|
611
|
+
# resp.financial_records[0].balances.processing.currency #=> String
|
|
612
|
+
# resp.financial_records[0].balances.settled.value #=> String
|
|
613
|
+
# resp.financial_records[0].balances.settled.currency #=> String
|
|
614
|
+
# resp.financial_records[0].balances.canceled.value #=> String
|
|
615
|
+
# resp.financial_records[0].balances.canceled.currency #=> String
|
|
616
|
+
# resp.financial_records[0].settlement_status #=> String, one of "OPEN", "CLOSED"
|
|
617
|
+
# resp.financial_records[0].status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
|
|
618
|
+
# resp.financial_records[0].issued_at #=> Time
|
|
619
|
+
# resp.financial_records[0].closed_at #=> Time
|
|
620
|
+
# resp.financial_records[0].details.invoice_details.invoice_id #=> String
|
|
621
|
+
# resp.financial_records[0].details.invoice_details.due_status #=> String, one of "DUE", "PAST_DUE"
|
|
622
|
+
# resp.financial_records[0].details.invoice_details.billing_period.start_date #=> Time
|
|
623
|
+
# resp.financial_records[0].details.invoice_details.billing_period.end_date #=> Time
|
|
624
|
+
# resp.financial_records[0].details.invoice_details.due_date #=> Time
|
|
625
|
+
# resp.financial_records[0].details.invoice_details.payment_terms #=> String
|
|
626
|
+
# resp.financial_records[0].details.invoice_details.invoice_frequency #=> String, one of "ONE_TIME", "RECURRING"
|
|
627
|
+
# resp.financial_records[0].details.credit_memo_details.invoice_id #=> String
|
|
628
|
+
# resp.financial_records[0].details.credit_memo_details.billing_period.start_date #=> Time
|
|
629
|
+
# resp.financial_records[0].details.credit_memo_details.billing_period.end_date #=> Time
|
|
630
|
+
# resp.errors #=> Array
|
|
631
|
+
# resp.errors[0].key.identifier #=> String
|
|
632
|
+
# resp.errors[0].key.invoice_identifier #=> String
|
|
633
|
+
# resp.errors[0].code #=> String, one of "NOT_FOUND", "INTERNAL_ERROR"
|
|
634
|
+
# resp.errors[0].message #=> String
|
|
635
|
+
#
|
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/BatchGetFinancialRecord AWS API Documentation
|
|
637
|
+
#
|
|
638
|
+
# @overload batch_get_financial_record(params = {})
|
|
639
|
+
# @param [Hash] params ({})
|
|
640
|
+
def batch_get_financial_record(params = {}, options = {})
|
|
641
|
+
req = build_request(:batch_get_financial_record, params)
|
|
642
|
+
req.send_request(options)
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# Retrieves one balance of your account, selected by balance type, as
|
|
646
|
+
# one amount for each merchant of record and currency. Each amount is
|
|
647
|
+
# the sum of the outstanding balances of your invoices or credit memos
|
|
648
|
+
# that have the status `OUTSTANDING`. Amounts are never added together
|
|
649
|
+
# across merchants of record or currencies. This operation is eventually
|
|
650
|
+
# consistent. Results are paginated. Use `nextToken` to retrieve more
|
|
651
|
+
# results.
|
|
652
|
+
#
|
|
653
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
654
|
+
# Access Management (IAM) permission for both
|
|
655
|
+
# `payments:GetAccountBalance` and `payments:GetPaymentStatus`.
|
|
656
|
+
#
|
|
657
|
+
# @option params [required, String] :balance_type
|
|
658
|
+
# The balance to retrieve. You can specify only one balance type in a
|
|
659
|
+
# single request. Each balance adds up the `outstanding` balance of the
|
|
660
|
+
# records that have the status `OUTSTANDING`. A record that is
|
|
661
|
+
# `PROCESSING`, `SETTLED`, or `CANCELED` isn't included, even when part
|
|
662
|
+
# of its amount is outstanding. The following values are valid:
|
|
663
|
+
#
|
|
664
|
+
# * `INVOICES_DUE` – The outstanding balance of your `OUTSTANDING`
|
|
665
|
+
# invoices that aren't past their due date, where `dueStatus` is
|
|
666
|
+
# `DUE`.
|
|
667
|
+
#
|
|
668
|
+
# * `INVOICES_PAST_DUE` – The outstanding balance of your `OUTSTANDING`
|
|
669
|
+
# invoices that are past their due date, where `dueStatus` is
|
|
670
|
+
# `PAST_DUE`.
|
|
671
|
+
#
|
|
672
|
+
# * `OUTSTANDING_CREDIT_MEMOS` – The outstanding balance of your
|
|
673
|
+
# `OUTSTANDING` credit memos: the credit that isn't yet applied to an
|
|
674
|
+
# invoice.
|
|
675
|
+
#
|
|
676
|
+
# @option params [String] :next_token
|
|
677
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
678
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
679
|
+
# malformed or expired, or doesn't match the original request, the
|
|
680
|
+
# request fails with `ValidationException` and the reason
|
|
681
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
682
|
+
# page.
|
|
683
|
+
#
|
|
684
|
+
# @option params [Integer] :max_results
|
|
685
|
+
# The maximum number of results to return in one page. The default is
|
|
686
|
+
# 100. A page can contain fewer results even when more remain. Use
|
|
687
|
+
# `nextToken` to find out whether more results are available.
|
|
688
|
+
#
|
|
689
|
+
# @return [Types::GetAccountBalanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
690
|
+
#
|
|
691
|
+
# * {Types::GetAccountBalanceResponse#account_balances #account_balances} => Array<Types::AccountBalance>
|
|
692
|
+
# * {Types::GetAccountBalanceResponse#next_token #next_token} => String
|
|
693
|
+
#
|
|
694
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
695
|
+
#
|
|
696
|
+
#
|
|
697
|
+
# @example Example: Invoke GetAccountBalance
|
|
698
|
+
#
|
|
699
|
+
# resp = client.get_account_balance({
|
|
700
|
+
# balance_type: "INVOICES_PAST_DUE",
|
|
701
|
+
# })
|
|
702
|
+
#
|
|
703
|
+
# resp.to_h outputs the following:
|
|
704
|
+
# {
|
|
705
|
+
# account_balances: [
|
|
706
|
+
# {
|
|
707
|
+
# amount: {
|
|
708
|
+
# value: "1250.00",
|
|
709
|
+
# currency: "USD",
|
|
710
|
+
# },
|
|
711
|
+
# merchant_of_record: "Amazon Web Services, Inc.",
|
|
712
|
+
# },
|
|
713
|
+
# {
|
|
714
|
+
# amount: {
|
|
715
|
+
# value: "430.75",
|
|
716
|
+
# currency: "INR",
|
|
717
|
+
# },
|
|
718
|
+
# merchant_of_record: "Amazon Web Services India Private Limited",
|
|
719
|
+
# },
|
|
720
|
+
# ],
|
|
721
|
+
# }
|
|
722
|
+
#
|
|
723
|
+
# @example Request syntax with placeholder values
|
|
724
|
+
#
|
|
725
|
+
# resp = client.get_account_balance({
|
|
726
|
+
# balance_type: "INVOICES_DUE", # required, accepts INVOICES_DUE, INVOICES_PAST_DUE, OUTSTANDING_CREDIT_MEMOS
|
|
727
|
+
# next_token: "PaginationToken",
|
|
728
|
+
# max_results: 1,
|
|
729
|
+
# })
|
|
730
|
+
#
|
|
731
|
+
# @example Response structure
|
|
732
|
+
#
|
|
733
|
+
# resp.account_balances #=> Array
|
|
734
|
+
# resp.account_balances[0].amount.value #=> String
|
|
735
|
+
# resp.account_balances[0].amount.currency #=> String
|
|
736
|
+
# resp.account_balances[0].merchant_of_record #=> String
|
|
737
|
+
# resp.next_token #=> String
|
|
738
|
+
#
|
|
739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetAccountBalance AWS API Documentation
|
|
740
|
+
#
|
|
741
|
+
# @overload get_account_balance(params = {})
|
|
742
|
+
# @param [Hash] params ({})
|
|
743
|
+
def get_account_balance(params = {}, options = {})
|
|
744
|
+
req = build_request(:get_account_balance, params)
|
|
745
|
+
req.send_request(options)
|
|
746
|
+
end
|
|
747
|
+
|
|
748
|
+
# Retrieves a single financial record, including the details that are
|
|
749
|
+
# specific to its type. Specify exactly one of the following:
|
|
750
|
+
#
|
|
751
|
+
# * The ID that Amazon Web Services Payments issued for the record, in
|
|
752
|
+
# `identifier`.
|
|
753
|
+
#
|
|
754
|
+
# * The invoice ID that Amazon Web Services Invoicing issued for an
|
|
755
|
+
# invoice or a credit memo, in `invoiceIdentifier`.
|
|
756
|
+
#
|
|
757
|
+
# If you specify both or neither, the request fails with
|
|
758
|
+
# `ValidationException`. If no record on your account matches, the
|
|
759
|
+
# request fails with `ResourceNotFoundException`.
|
|
760
|
+
#
|
|
761
|
+
# This operation provides strongly consistent reads.
|
|
762
|
+
#
|
|
763
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
764
|
+
# Access Management (IAM) permission for both
|
|
765
|
+
# `payments:GetFinancialRecord` and `payments:GetPaymentStatus`.
|
|
766
|
+
#
|
|
767
|
+
# @option params [String] :identifier
|
|
768
|
+
# The ID that Amazon Web Services Payments issued for the financial
|
|
769
|
+
# record, as returned in `id`.
|
|
770
|
+
#
|
|
771
|
+
# @option params [String] :invoice_identifier
|
|
772
|
+
# The invoice ID that Amazon Web Services Invoicing issued for an
|
|
773
|
+
# invoice or a credit memo. The operation returns the record that has
|
|
774
|
+
# this invoice ID.
|
|
775
|
+
#
|
|
776
|
+
# @return [Types::GetFinancialRecordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
777
|
+
#
|
|
778
|
+
# * {Types::GetFinancialRecordResponse#financial_record #financial_record} => Types::FinancialRecord
|
|
779
|
+
#
|
|
780
|
+
#
|
|
781
|
+
# @example Example: Invoke GetFinancialRecord
|
|
782
|
+
#
|
|
783
|
+
# resp = client.get_financial_record({
|
|
784
|
+
# identifier: "INV-1234-5678-9012-3456",
|
|
785
|
+
# })
|
|
786
|
+
#
|
|
787
|
+
# resp.to_h outputs the following:
|
|
788
|
+
# {
|
|
789
|
+
# financial_record: {
|
|
790
|
+
# type: "INVOICE",
|
|
791
|
+
# amount: {
|
|
792
|
+
# value: "1000.24",
|
|
793
|
+
# currency: "USD",
|
|
794
|
+
# },
|
|
795
|
+
# balances: {
|
|
796
|
+
# canceled: {
|
|
797
|
+
# value: "0.0",
|
|
798
|
+
# currency: "USD",
|
|
799
|
+
# },
|
|
800
|
+
# outstanding: {
|
|
801
|
+
# value: "0.0",
|
|
802
|
+
# currency: "USD",
|
|
803
|
+
# },
|
|
804
|
+
# processing: {
|
|
805
|
+
# value: "0.0",
|
|
806
|
+
# currency: "USD",
|
|
807
|
+
# },
|
|
808
|
+
# settled: {
|
|
809
|
+
# value: "1000.24",
|
|
810
|
+
# currency: "USD",
|
|
811
|
+
# },
|
|
812
|
+
# },
|
|
813
|
+
# business_unit: {
|
|
814
|
+
# line_of_business: "AWS_CLOUD_SERVICES",
|
|
815
|
+
# merchant_of_record: "Amazon Web Services, Inc.",
|
|
816
|
+
# },
|
|
817
|
+
# closed_at: Time.parse(1736208000),
|
|
818
|
+
# details: {
|
|
819
|
+
# invoice_details: {
|
|
820
|
+
# billing_period: {
|
|
821
|
+
# end_date: Time.parse(1735689600),
|
|
822
|
+
# start_date: Time.parse(1733011200),
|
|
823
|
+
# },
|
|
824
|
+
# due_date: Time.parse(1738281600),
|
|
825
|
+
# invoice_frequency: "RECURRING",
|
|
826
|
+
# invoice_id: "536462537364",
|
|
827
|
+
# payment_terms: "Net30",
|
|
828
|
+
# },
|
|
829
|
+
# },
|
|
830
|
+
# id: "INV-1234-5678-9012-3456",
|
|
831
|
+
# issued_at: Time.parse(1735689600),
|
|
832
|
+
# settlement_status: "CLOSED",
|
|
833
|
+
# status: "SETTLED",
|
|
834
|
+
# },
|
|
835
|
+
# }
|
|
836
|
+
#
|
|
837
|
+
# @example Request syntax with placeholder values
|
|
838
|
+
#
|
|
839
|
+
# resp = client.get_financial_record({
|
|
840
|
+
# identifier: "FinancialRecordIdentifier",
|
|
841
|
+
# invoice_identifier: "InvoiceId",
|
|
842
|
+
# })
|
|
843
|
+
#
|
|
844
|
+
# @example Response structure
|
|
845
|
+
#
|
|
846
|
+
# resp.financial_record.id #=> String
|
|
847
|
+
# resp.financial_record.type #=> String, one of "INVOICE", "CREDIT_MEMO"
|
|
848
|
+
# resp.financial_record.business_unit.merchant_of_record #=> String
|
|
849
|
+
# resp.financial_record.business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
|
|
850
|
+
# resp.financial_record.amount.value #=> String
|
|
851
|
+
# resp.financial_record.amount.currency #=> String
|
|
852
|
+
# resp.financial_record.balances.outstanding.value #=> String
|
|
853
|
+
# resp.financial_record.balances.outstanding.currency #=> String
|
|
854
|
+
# resp.financial_record.balances.processing.value #=> String
|
|
855
|
+
# resp.financial_record.balances.processing.currency #=> String
|
|
856
|
+
# resp.financial_record.balances.settled.value #=> String
|
|
857
|
+
# resp.financial_record.balances.settled.currency #=> String
|
|
858
|
+
# resp.financial_record.balances.canceled.value #=> String
|
|
859
|
+
# resp.financial_record.balances.canceled.currency #=> String
|
|
860
|
+
# resp.financial_record.settlement_status #=> String, one of "OPEN", "CLOSED"
|
|
861
|
+
# resp.financial_record.status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
|
|
862
|
+
# resp.financial_record.issued_at #=> Time
|
|
863
|
+
# resp.financial_record.closed_at #=> Time
|
|
864
|
+
# resp.financial_record.details.invoice_details.invoice_id #=> String
|
|
865
|
+
# resp.financial_record.details.invoice_details.due_status #=> String, one of "DUE", "PAST_DUE"
|
|
866
|
+
# resp.financial_record.details.invoice_details.billing_period.start_date #=> Time
|
|
867
|
+
# resp.financial_record.details.invoice_details.billing_period.end_date #=> Time
|
|
868
|
+
# resp.financial_record.details.invoice_details.due_date #=> Time
|
|
869
|
+
# resp.financial_record.details.invoice_details.payment_terms #=> String
|
|
870
|
+
# resp.financial_record.details.invoice_details.invoice_frequency #=> String, one of "ONE_TIME", "RECURRING"
|
|
871
|
+
# resp.financial_record.details.credit_memo_details.invoice_id #=> String
|
|
872
|
+
# resp.financial_record.details.credit_memo_details.billing_period.start_date #=> Time
|
|
873
|
+
# resp.financial_record.details.credit_memo_details.billing_period.end_date #=> Time
|
|
874
|
+
#
|
|
875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetFinancialRecord AWS API Documentation
|
|
876
|
+
#
|
|
877
|
+
# @overload get_financial_record(params = {})
|
|
878
|
+
# @param [Hash] params ({})
|
|
879
|
+
def get_financial_record(params = {}, options = {})
|
|
880
|
+
req = build_request(:get_financial_record, params)
|
|
881
|
+
req.send_request(options)
|
|
882
|
+
end
|
|
883
|
+
|
|
884
|
+
# Retrieves a payment instrument on your account, including the details
|
|
885
|
+
# that are specific to its payment method, such as a card's last four
|
|
886
|
+
# digits. Identify the instrument by its Amazon Resource Name (ARN) or
|
|
887
|
+
# by its ID. `ListPaymentInstruments` returns both.
|
|
888
|
+
#
|
|
889
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
890
|
+
# Access Management (IAM) permission for
|
|
891
|
+
# `payments:GetPaymentInstrument`. You can scope this permission to the
|
|
892
|
+
# instrument's ARN.
|
|
893
|
+
#
|
|
894
|
+
# @option params [required, String] :identifier
|
|
895
|
+
# The instrument to retrieve. Specify one of the following:
|
|
896
|
+
#
|
|
897
|
+
# * The Amazon Resource Name (ARN) of the instrument, as
|
|
898
|
+
# `ListPaymentInstruments` returns in `arn`. The ARN must be for an
|
|
899
|
+
# instrument on your account.
|
|
900
|
+
#
|
|
901
|
+
# * The ID of the instrument, as `ListPaymentInstruments` returns in
|
|
902
|
+
# `id`.
|
|
903
|
+
#
|
|
904
|
+
# @return [Types::GetPaymentInstrumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
905
|
+
#
|
|
906
|
+
# * {Types::GetPaymentInstrumentResponse#payment_instrument #payment_instrument} => Types::PaymentInstrument
|
|
907
|
+
#
|
|
908
|
+
#
|
|
909
|
+
# @example Example: Invoke GetPaymentInstrument
|
|
910
|
+
#
|
|
911
|
+
# resp = client.get_payment_instrument({
|
|
912
|
+
# identifier: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
913
|
+
# })
|
|
914
|
+
#
|
|
915
|
+
# resp.to_h outputs the following:
|
|
916
|
+
# {
|
|
917
|
+
# payment_instrument: {
|
|
918
|
+
# arn: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
919
|
+
# created_at: Time.parse(1735689600),
|
|
920
|
+
# details: {
|
|
921
|
+
# card: {
|
|
922
|
+
# brand: "VISA",
|
|
923
|
+
# card_type: "CREDIT",
|
|
924
|
+
# expiration_month: 7,
|
|
925
|
+
# expiration_year: 2030,
|
|
926
|
+
# issuer_country: "US",
|
|
927
|
+
# issuing_bank: "Example Bank",
|
|
928
|
+
# last4: "1111",
|
|
929
|
+
# },
|
|
930
|
+
# },
|
|
931
|
+
# payment_method: "CARD",
|
|
932
|
+
# status: "ACTIVE",
|
|
933
|
+
# updated_at: Time.parse(1738368000),
|
|
934
|
+
# },
|
|
935
|
+
# }
|
|
936
|
+
#
|
|
937
|
+
# @example Request syntax with placeholder values
|
|
938
|
+
#
|
|
939
|
+
# resp = client.get_payment_instrument({
|
|
940
|
+
# identifier: "PaymentInstrumentIdentifier", # required
|
|
941
|
+
# })
|
|
942
|
+
#
|
|
943
|
+
# @example Response structure
|
|
944
|
+
#
|
|
945
|
+
# resp.payment_instrument.arn #=> String
|
|
946
|
+
# resp.payment_instrument.payment_method #=> String, one of "CARD", "US_ACH_BANK_ACCOUNT", "SEPA_BANK_ACCOUNT", "UK_BACS_BANK_ACCOUNT", "IN_NET_BANKING", "CN_BANK_REDIRECT", "UPI", "PIX", "PAY_BY_INVOICE"
|
|
947
|
+
# resp.payment_instrument.status #=> String, one of "ACTIVE", "PENDING_SETUP", "SETUP_IN_PROGRESS", "INVALID"
|
|
948
|
+
# resp.payment_instrument.details.card.brand #=> String, one of "VISA", "MASTERCARD", "AMEX", "DISCOVER", "JCB", "RUPAY", "CHINA_UNIONPAY"
|
|
949
|
+
# resp.payment_instrument.details.card.last4 #=> String
|
|
950
|
+
# resp.payment_instrument.details.card.expiration_month #=> Integer
|
|
951
|
+
# resp.payment_instrument.details.card.expiration_year #=> Integer
|
|
952
|
+
# resp.payment_instrument.details.card.card_type #=> String, one of "CREDIT", "DEBIT"
|
|
953
|
+
# resp.payment_instrument.details.card.issuing_bank #=> String
|
|
954
|
+
# resp.payment_instrument.details.card.issuer_country #=> String
|
|
955
|
+
# resp.payment_instrument.details.us_ach_bank_account.account_number_tail #=> String
|
|
956
|
+
# resp.payment_instrument.details.us_ach_bank_account.account_holder_name #=> String
|
|
957
|
+
# resp.payment_instrument.details.us_ach_bank_account.bank_name #=> String
|
|
958
|
+
# resp.payment_instrument.details.us_ach_bank_account.account_type #=> String, one of "CHECKING", "SAVINGS"
|
|
959
|
+
# resp.payment_instrument.details.sepa_bank_account.account_number_tail #=> String
|
|
960
|
+
# resp.payment_instrument.details.sepa_bank_account.account_holder_name #=> String
|
|
961
|
+
# resp.payment_instrument.details.sepa_bank_account.bank_name #=> String
|
|
962
|
+
# resp.payment_instrument.details.sepa_bank_account.account_type #=> String, one of "CHECKING", "SAVINGS"
|
|
963
|
+
# resp.payment_instrument.details.uk_bacs_bank_account.account_number_tail #=> String
|
|
964
|
+
# resp.payment_instrument.details.uk_bacs_bank_account.account_holder_name #=> String
|
|
965
|
+
# resp.payment_instrument.details.uk_bacs_bank_account.bank_name #=> String
|
|
966
|
+
# resp.payment_instrument.details.uk_bacs_bank_account.account_type #=> String, one of "CHECKING", "SAVINGS"
|
|
967
|
+
# resp.payment_instrument.details.in_net_banking.bank_code #=> String
|
|
968
|
+
# resp.payment_instrument.details.in_net_banking.bank_name #=> String
|
|
969
|
+
# resp.payment_instrument.details.cn_bank_redirect.bank_code #=> String
|
|
970
|
+
# resp.payment_instrument.details.upi.app_name #=> String
|
|
971
|
+
# resp.payment_instrument.created_at #=> Time
|
|
972
|
+
# resp.payment_instrument.updated_at #=> Time
|
|
973
|
+
#
|
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/GetPaymentInstrument AWS API Documentation
|
|
975
|
+
#
|
|
976
|
+
# @overload get_payment_instrument(params = {})
|
|
977
|
+
# @param [Hash] params ({})
|
|
978
|
+
def get_payment_instrument(params = {}, options = {})
|
|
979
|
+
req = build_request(:get_payment_instrument, params)
|
|
980
|
+
req.send_request(options)
|
|
981
|
+
end
|
|
982
|
+
|
|
983
|
+
# Lists the financial records on your account, with the newest first by
|
|
984
|
+
# default. A financial record is an invoice or a credit memo. You must
|
|
985
|
+
# specify at least one record type in `types`. You can narrow the
|
|
986
|
+
# results further by settlement status and issue date. This operation
|
|
987
|
+
# returns summaries. To get the details that are specific to a record's
|
|
988
|
+
# type, use `GetFinancialRecord` or `BatchGetFinancialRecord`. Results
|
|
989
|
+
# are paginated. Use `nextToken` to retrieve more results.
|
|
990
|
+
#
|
|
991
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
992
|
+
# Access Management (IAM) permission for both
|
|
993
|
+
# `payments:ListFinancialRecords` and `payments:GetPaymentStatus`.
|
|
994
|
+
#
|
|
995
|
+
# @option params [required, Array<String>] :types
|
|
996
|
+
# The financial record types to return. The following values are valid:
|
|
997
|
+
#
|
|
998
|
+
# * `INVOICE` – An invoice: a bill from Amazon Web Services. Payments
|
|
999
|
+
# and credit memos applied to the invoice settle it.
|
|
1000
|
+
#
|
|
1001
|
+
# * `CREDIT_MEMO` – A credit memo: a credit issued to your account, for
|
|
1002
|
+
# example for a billing correction or a service credit. Applying it to
|
|
1003
|
+
# one or more invoices settles it.
|
|
1004
|
+
#
|
|
1005
|
+
# @option params [Array<String>] :settlement_statuses
|
|
1006
|
+
# The settlement statuses to filter by. `OPEN` returns records whose
|
|
1007
|
+
# `status` is `OUTSTANDING` or `PROCESSING`. `CLOSED` returns records
|
|
1008
|
+
# whose `status` is `SETTLED` or `CANCELED`. When you omit this member,
|
|
1009
|
+
# the operation returns records with both settlement statuses.
|
|
1010
|
+
#
|
|
1011
|
+
# @option params [Time,DateTime,Date,Integer,String] :issued_after
|
|
1012
|
+
# The earliest date and time to return records for, inclusive. The
|
|
1013
|
+
# operation returns the records that were issued at or after this time.
|
|
1014
|
+
#
|
|
1015
|
+
# @option params [Time,DateTime,Date,Integer,String] :issued_before
|
|
1016
|
+
# The latest date and time to return records for, exclusive. The
|
|
1017
|
+
# operation returns the records that were issued before this time. When
|
|
1018
|
+
# you specify both `issuedAfter` and `issuedBefore`, `issuedBefore` must
|
|
1019
|
+
# be later than `issuedAfter`.
|
|
1020
|
+
#
|
|
1021
|
+
# @option params [String] :sort_by
|
|
1022
|
+
# The field to sort the results by. The default is `ISSUED_AT`, the date
|
|
1023
|
+
# and time when the record was issued.
|
|
1024
|
+
#
|
|
1025
|
+
# @option params [String] :sort_order
|
|
1026
|
+
# The order to sort the results in. The default is `DESCENDING`, which
|
|
1027
|
+
# returns the newest records first. `ASCENDING` returns the oldest
|
|
1028
|
+
# records first.
|
|
1029
|
+
#
|
|
1030
|
+
# @option params [String] :next_token
|
|
1031
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
1032
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
1033
|
+
# malformed or expired, or doesn't match the original request, the
|
|
1034
|
+
# request fails with `ValidationException` and the reason
|
|
1035
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
1036
|
+
# page.
|
|
1037
|
+
#
|
|
1038
|
+
# @option params [Integer] :max_results
|
|
1039
|
+
# The maximum number of results to return in one page. The default is
|
|
1040
|
+
# 100. A page can contain fewer results even when more remain. Use
|
|
1041
|
+
# `nextToken` to find out whether more results are available.
|
|
1042
|
+
#
|
|
1043
|
+
# @return [Types::ListFinancialRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1044
|
+
#
|
|
1045
|
+
# * {Types::ListFinancialRecordsResponse#financial_record_summaries #financial_record_summaries} => Array<Types::FinancialRecordSummary>
|
|
1046
|
+
# * {Types::ListFinancialRecordsResponse#next_token #next_token} => String
|
|
1047
|
+
#
|
|
1048
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1049
|
+
#
|
|
1050
|
+
#
|
|
1051
|
+
# @example Example: Invoke ListFinancialRecords
|
|
1052
|
+
#
|
|
1053
|
+
# resp = client.list_financial_records({
|
|
1054
|
+
# max_results: 5,
|
|
1055
|
+
# settlement_statuses: [
|
|
1056
|
+
# "CLOSED",
|
|
1057
|
+
# ],
|
|
1058
|
+
# sort_by: "ISSUED_AT",
|
|
1059
|
+
# sort_order: "DESCENDING",
|
|
1060
|
+
# types: [
|
|
1061
|
+
# "INVOICE",
|
|
1062
|
+
# ],
|
|
1063
|
+
# })
|
|
1064
|
+
#
|
|
1065
|
+
# resp.to_h outputs the following:
|
|
1066
|
+
# {
|
|
1067
|
+
# financial_record_summaries: [
|
|
1068
|
+
# {
|
|
1069
|
+
# type: "INVOICE",
|
|
1070
|
+
# amount: {
|
|
1071
|
+
# value: "1000.24",
|
|
1072
|
+
# currency: "USD",
|
|
1073
|
+
# },
|
|
1074
|
+
# balances: {
|
|
1075
|
+
# canceled: {
|
|
1076
|
+
# value: "0.0",
|
|
1077
|
+
# currency: "USD",
|
|
1078
|
+
# },
|
|
1079
|
+
# outstanding: {
|
|
1080
|
+
# value: "0.0",
|
|
1081
|
+
# currency: "USD",
|
|
1082
|
+
# },
|
|
1083
|
+
# processing: {
|
|
1084
|
+
# value: "0.0",
|
|
1085
|
+
# currency: "USD",
|
|
1086
|
+
# },
|
|
1087
|
+
# settled: {
|
|
1088
|
+
# value: "1000.24",
|
|
1089
|
+
# currency: "USD",
|
|
1090
|
+
# },
|
|
1091
|
+
# },
|
|
1092
|
+
# business_unit: {
|
|
1093
|
+
# line_of_business: "AWS_CLOUD_SERVICES",
|
|
1094
|
+
# merchant_of_record: "Amazon Web Services, Inc.",
|
|
1095
|
+
# },
|
|
1096
|
+
# closed_at: Time.parse(1736208000),
|
|
1097
|
+
# id: "INV-1234-5678-9012-3456",
|
|
1098
|
+
# issued_at: Time.parse(1735689600),
|
|
1099
|
+
# settlement_status: "CLOSED",
|
|
1100
|
+
# status: "SETTLED",
|
|
1101
|
+
# },
|
|
1102
|
+
# ],
|
|
1103
|
+
# }
|
|
1104
|
+
#
|
|
1105
|
+
# @example Request syntax with placeholder values
|
|
1106
|
+
#
|
|
1107
|
+
# resp = client.list_financial_records({
|
|
1108
|
+
# types: ["INVOICE"], # required, accepts INVOICE, CREDIT_MEMO
|
|
1109
|
+
# settlement_statuses: ["OPEN"], # accepts OPEN, CLOSED
|
|
1110
|
+
# issued_after: Time.now,
|
|
1111
|
+
# issued_before: Time.now,
|
|
1112
|
+
# sort_by: "ISSUED_AT", # accepts ISSUED_AT
|
|
1113
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
|
1114
|
+
# next_token: "PaginationToken",
|
|
1115
|
+
# max_results: 1,
|
|
1116
|
+
# })
|
|
1117
|
+
#
|
|
1118
|
+
# @example Response structure
|
|
1119
|
+
#
|
|
1120
|
+
# resp.financial_record_summaries #=> Array
|
|
1121
|
+
# resp.financial_record_summaries[0].id #=> String
|
|
1122
|
+
# resp.financial_record_summaries[0].type #=> String, one of "INVOICE", "CREDIT_MEMO"
|
|
1123
|
+
# resp.financial_record_summaries[0].business_unit.merchant_of_record #=> String
|
|
1124
|
+
# resp.financial_record_summaries[0].business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
|
|
1125
|
+
# resp.financial_record_summaries[0].amount.value #=> String
|
|
1126
|
+
# resp.financial_record_summaries[0].amount.currency #=> String
|
|
1127
|
+
# resp.financial_record_summaries[0].balances.outstanding.value #=> String
|
|
1128
|
+
# resp.financial_record_summaries[0].balances.outstanding.currency #=> String
|
|
1129
|
+
# resp.financial_record_summaries[0].balances.processing.value #=> String
|
|
1130
|
+
# resp.financial_record_summaries[0].balances.processing.currency #=> String
|
|
1131
|
+
# resp.financial_record_summaries[0].balances.settled.value #=> String
|
|
1132
|
+
# resp.financial_record_summaries[0].balances.settled.currency #=> String
|
|
1133
|
+
# resp.financial_record_summaries[0].balances.canceled.value #=> String
|
|
1134
|
+
# resp.financial_record_summaries[0].balances.canceled.currency #=> String
|
|
1135
|
+
# resp.financial_record_summaries[0].settlement_status #=> String, one of "OPEN", "CLOSED"
|
|
1136
|
+
# resp.financial_record_summaries[0].status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
|
|
1137
|
+
# resp.financial_record_summaries[0].issued_at #=> Time
|
|
1138
|
+
# resp.financial_record_summaries[0].closed_at #=> Time
|
|
1139
|
+
# resp.next_token #=> String
|
|
1140
|
+
#
|
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListFinancialRecords AWS API Documentation
|
|
1142
|
+
#
|
|
1143
|
+
# @overload list_financial_records(params = {})
|
|
1144
|
+
# @param [Hash] params ({})
|
|
1145
|
+
def list_financial_records(params = {}, options = {})
|
|
1146
|
+
req = build_request(:list_financial_records, params)
|
|
1147
|
+
req.send_request(options)
|
|
1148
|
+
end
|
|
1149
|
+
|
|
1150
|
+
# Lists the payment instruments on your account. This operation returns
|
|
1151
|
+
# summaries. To get the details that are specific to an instrument's
|
|
1152
|
+
# payment method, use `GetPaymentInstrument`. Results are paginated. Use
|
|
1153
|
+
# `nextToken` to retrieve more results.
|
|
1154
|
+
#
|
|
1155
|
+
# To use this operation, you must have Amazon Web Services Identity and
|
|
1156
|
+
# Access Management (IAM) permission for
|
|
1157
|
+
# `payments:ListPaymentInstruments`.
|
|
1158
|
+
#
|
|
1159
|
+
# @option params [String] :next_token
|
|
1160
|
+
# The pagination token from the `nextToken` of the previous response.
|
|
1161
|
+
# Omit it to get the first page. Tokens expire. If the token is
|
|
1162
|
+
# malformed or expired, or doesn't match the original request, the
|
|
1163
|
+
# request fails with `ValidationException` and the reason
|
|
1164
|
+
# `INVALID_PAGINATION_TOKEN`. In that case, start again from the first
|
|
1165
|
+
# page.
|
|
1166
|
+
#
|
|
1167
|
+
# @option params [Integer] :max_results
|
|
1168
|
+
# The maximum number of payment instruments to return in one page. The
|
|
1169
|
+
# default is 25. A page can contain fewer payment instruments even when
|
|
1170
|
+
# more remain. Use `nextToken` to find out whether more payment
|
|
1171
|
+
# instruments are available.
|
|
1172
|
+
#
|
|
1173
|
+
# @return [Types::ListPaymentInstrumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1174
|
+
#
|
|
1175
|
+
# * {Types::ListPaymentInstrumentsResponse#payment_instrument_summaries #payment_instrument_summaries} => Array<Types::PaymentInstrumentSummary>
|
|
1176
|
+
# * {Types::ListPaymentInstrumentsResponse#next_token #next_token} => String
|
|
1177
|
+
#
|
|
1178
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1179
|
+
#
|
|
1180
|
+
#
|
|
1181
|
+
# @example Example: Invoke ListPaymentInstruments
|
|
1182
|
+
#
|
|
1183
|
+
# resp = client.list_payment_instruments({
|
|
1184
|
+
# max_results: 5,
|
|
1185
|
+
# })
|
|
1186
|
+
#
|
|
1187
|
+
# resp.to_h outputs the following:
|
|
1188
|
+
# {
|
|
1189
|
+
# payment_instrument_summaries: [
|
|
1190
|
+
# {
|
|
1191
|
+
# arn: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
1192
|
+
# created_at: Time.parse(1735689600),
|
|
1193
|
+
# id: "1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
1194
|
+
# payment_method: "CARD",
|
|
1195
|
+
# status: "ACTIVE",
|
|
1196
|
+
# updated_at: Time.parse(1738368000),
|
|
1197
|
+
# },
|
|
1198
|
+
# {
|
|
1199
|
+
# arn: "arn:aws:payments::123456789012:payment-instrument:2b3c4d5e-6f7a-8b9c-0d1e-444455556666",
|
|
1200
|
+
# created_at: Time.parse(1727740800),
|
|
1201
|
+
# id: "2b3c4d5e-6f7a-8b9c-0d1e-444455556666",
|
|
1202
|
+
# payment_method: "US_ACH_BANK_ACCOUNT",
|
|
1203
|
+
# status: "ACTIVE",
|
|
1204
|
+
# updated_at: Time.parse(1727740800),
|
|
1205
|
+
# },
|
|
1206
|
+
# ],
|
|
1207
|
+
# }
|
|
1208
|
+
#
|
|
1209
|
+
# @example Request syntax with placeholder values
|
|
1210
|
+
#
|
|
1211
|
+
# resp = client.list_payment_instruments({
|
|
1212
|
+
# next_token: "PaginationToken",
|
|
1213
|
+
# max_results: 1,
|
|
1214
|
+
# })
|
|
1215
|
+
#
|
|
1216
|
+
# @example Response structure
|
|
1217
|
+
#
|
|
1218
|
+
# resp.payment_instrument_summaries #=> Array
|
|
1219
|
+
# resp.payment_instrument_summaries[0].id #=> String
|
|
1220
|
+
# resp.payment_instrument_summaries[0].arn #=> String
|
|
1221
|
+
# resp.payment_instrument_summaries[0].payment_method #=> String, one of "CARD", "US_ACH_BANK_ACCOUNT", "SEPA_BANK_ACCOUNT", "UK_BACS_BANK_ACCOUNT", "IN_NET_BANKING", "CN_BANK_REDIRECT", "UPI", "PIX", "PAY_BY_INVOICE"
|
|
1222
|
+
# resp.payment_instrument_summaries[0].status #=> String, one of "ACTIVE", "PENDING_SETUP", "SETUP_IN_PROGRESS", "INVALID"
|
|
1223
|
+
# resp.payment_instrument_summaries[0].created_at #=> Time
|
|
1224
|
+
# resp.payment_instrument_summaries[0].updated_at #=> Time
|
|
1225
|
+
# resp.next_token #=> String
|
|
1226
|
+
#
|
|
1227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListPaymentInstruments AWS API Documentation
|
|
1228
|
+
#
|
|
1229
|
+
# @overload list_payment_instruments(params = {})
|
|
1230
|
+
# @param [Hash] params ({})
|
|
1231
|
+
def list_payment_instruments(params = {}, options = {})
|
|
1232
|
+
req = build_request(:list_payment_instruments, params)
|
|
1233
|
+
req.send_request(options)
|
|
1234
|
+
end
|
|
1235
|
+
|
|
1236
|
+
# @!endgroup
|
|
1237
|
+
|
|
1238
|
+
# @param params ({})
|
|
1239
|
+
# @api private
|
|
1240
|
+
def build_request(operation_name, params = {})
|
|
1241
|
+
handlers = @handlers.for(operation_name)
|
|
1242
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
1243
|
+
Aws::Telemetry.module_to_tracer_name('Aws::Payments')
|
|
1244
|
+
)
|
|
1245
|
+
context = Seahorse::Client::RequestContext.new(
|
|
1246
|
+
operation_name: operation_name,
|
|
1247
|
+
operation: config.api.operation(operation_name),
|
|
1248
|
+
client: self,
|
|
1249
|
+
params: params,
|
|
1250
|
+
config: config,
|
|
1251
|
+
tracer: tracer
|
|
1252
|
+
)
|
|
1253
|
+
context[:gem_name] = 'aws-sdk-payments'
|
|
1254
|
+
context[:gem_version] = '1.0.0'
|
|
1255
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
1256
|
+
end
|
|
1257
|
+
|
|
1258
|
+
# @api private
|
|
1259
|
+
# @deprecated
|
|
1260
|
+
def waiter_names
|
|
1261
|
+
[]
|
|
1262
|
+
end
|
|
1263
|
+
|
|
1264
|
+
class << self
|
|
1265
|
+
|
|
1266
|
+
# @api private
|
|
1267
|
+
attr_reader :identifier
|
|
1268
|
+
|
|
1269
|
+
# @api private
|
|
1270
|
+
def errors_module
|
|
1271
|
+
Errors
|
|
1272
|
+
end
|
|
1273
|
+
|
|
1274
|
+
end
|
|
1275
|
+
end
|
|
1276
|
+
end
|