Class: Aws::Payments::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Payments::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb
Overview
An API client for Payments. To construct a client, you need to configure a :region and :credentials.
client = Aws::Payments::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_financial_record(params = {}) ⇒ Types::BatchGetFinancialRecordResponse
Retrieves up to 100 financial records in one request, including the details that are specific to each record's type.
-
#get_account_balance(params = {}) ⇒ Types::GetAccountBalanceResponse
Retrieves one balance of your account, selected by balance type, as one amount for each merchant of record and currency.
-
#get_financial_record(params = {}) ⇒ Types::GetFinancialRecordResponse
Retrieves a single financial record, including the details that are specific to its type.
-
#get_payment_instrument(params = {}) ⇒ Types::GetPaymentInstrumentResponse
Retrieves a payment instrument on your account, including the details that are specific to its payment method, such as a card's last four digits.
-
#list_financial_records(params = {}) ⇒ Types::ListFinancialRecordsResponse
Lists the financial records on your account, with the newest first by default.
-
#list_payment_instruments(params = {}) ⇒ Types::ListPaymentInstrumentsResponse
Lists the payment instruments on your account.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#batch_get_financial_record(params = {}) ⇒ Types::BatchGetFinancialRecordResponse
Retrieves up to 100 financial records in one request, including the
details that are specific to each record's type. Identify each record
by its ID or by its invoice ID. Results can be partial: each key that
you request appears once in the response, either as a record in
financialRecords or as an error in errors. A key that matches no
record on your account is returned in errors and doesn't fail the
request. This operation provides strongly consistent reads.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for both
payments:BatchGetFinancialRecord and payments:GetPaymentStatus.
640 641 642 643 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 640 def batch_get_financial_record(params = {}, = {}) req = build_request(:batch_get_financial_record, params) req.send_request() end |
#get_account_balance(params = {}) ⇒ Types::GetAccountBalanceResponse
Retrieves one balance of your account, selected by balance type, as
one amount for each merchant of record and currency. Each amount is
the sum of the outstanding balances of your invoices or credit memos
that have the status OUTSTANDING. Amounts are never added together
across merchants of record or currencies. This operation is eventually
consistent. Results are paginated. Use nextToken to retrieve more
results.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for both
payments:GetAccountBalance and payments:GetPaymentStatus.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
743 744 745 746 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 743 def get_account_balance(params = {}, = {}) req = build_request(:get_account_balance, params) req.send_request() end |
#get_financial_record(params = {}) ⇒ Types::GetFinancialRecordResponse
Retrieves a single financial record, including the details that are specific to its type. Specify exactly one of the following:
The ID that Amazon Web Services Payments issued for the record, in
identifier.The invoice ID that Amazon Web Services Invoicing issued for an invoice or a credit memo, in
invoiceIdentifier.
If you specify both or neither, the request fails with
ValidationException. If no record on your account matches, the
request fails with ResourceNotFoundException.
This operation provides strongly consistent reads.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for both
payments:GetFinancialRecord and payments:GetPaymentStatus.
879 880 881 882 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 879 def get_financial_record(params = {}, = {}) req = build_request(:get_financial_record, params) req.send_request() end |
#get_payment_instrument(params = {}) ⇒ Types::GetPaymentInstrumentResponse
Retrieves a payment instrument on your account, including the details
that are specific to its payment method, such as a card's last four
digits. Identify the instrument by its Amazon Resource Name (ARN) or
by its ID. ListPaymentInstruments returns both.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for
payments:GetPaymentInstrument. You can scope this permission to the
instrument's ARN.
978 979 980 981 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 978 def get_payment_instrument(params = {}, = {}) req = build_request(:get_payment_instrument, params) req.send_request() end |
#list_financial_records(params = {}) ⇒ Types::ListFinancialRecordsResponse
Lists the financial records on your account, with the newest first by
default. A financial record is an invoice or a credit memo. You must
specify at least one record type in types. You can narrow the
results further by settlement status and issue date. This operation
returns summaries. To get the details that are specific to a record's
type, use GetFinancialRecord or BatchGetFinancialRecord. Results
are paginated. Use nextToken to retrieve more results.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for both
payments:ListFinancialRecords and payments:GetPaymentStatus.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 1145 def list_financial_records(params = {}, = {}) req = build_request(:list_financial_records, params) req.send_request() end |
#list_payment_instruments(params = {}) ⇒ Types::ListPaymentInstrumentsResponse
Lists the payment instruments on your account. This operation returns
summaries. To get the details that are specific to an instrument's
payment method, use GetPaymentInstrument. Results are paginated. Use
nextToken to retrieve more results.
To use this operation, you must have Amazon Web Services Identity and
Access Management (IAM) permission for
payments:ListPaymentInstruments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1231 1232 1233 1234 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 1231 def list_payment_instruments(params = {}, = {}) req = build_request(:list_payment_instruments, params) req.send_request() end |