Class: Aws::Payments::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes. Defaults to 3, except for DynamoDB and DynamoDB Streams, which default to 4.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "standard" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. This is the default value if no retry mode is provided.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Payments::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Payments::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



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.

Examples:

Example: Invoke BatchGetFinancialRecord


resp = client.batch_get_financial_record({
  keys: [
    {
      identifier: "INV-1234-5678-9012-3456", 
    }, 
    {
      invoice_identifier: "999999999999", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  errors: [
    {
      key: {
        invoice_identifier: "999999999999", 
      }, 
      code: "NOT_FOUND", 
      message: "The requested resource was not found", 
    }, 
  ], 
  financial_records: [
    {
      type: "INVOICE", 
      amount: {
        value: "1000.24", 
        currency: "USD", 
      }, 
      balances: {
        canceled: {
          value: "0.0", 
          currency: "USD", 
        }, 
        outstanding: {
          value: "0.0", 
          currency: "USD", 
        }, 
        processing: {
          value: "0.0", 
          currency: "USD", 
        }, 
        settled: {
          value: "1000.24", 
          currency: "USD", 
        }, 
      }, 
      business_unit: {
        line_of_business: "AWS_CLOUD_SERVICES", 
        merchant_of_record: "Amazon Web Services, Inc.", 
      }, 
      closed_at: Time.parse(1736208000), 
      details: {
        invoice_details: {
          billing_period: {
            end_date: Time.parse(1735689600), 
            start_date: Time.parse(1733011200), 
          }, 
          due_date: Time.parse(1738281600), 
          invoice_frequency: "RECURRING", 
          invoice_id: "536462537364", 
          payment_terms: "Net30", 
        }, 
      }, 
      id: "INV-1234-5678-9012-3456", 
      issued_at: Time.parse(1735689600), 
      settlement_status: "CLOSED", 
      status: "SETTLED", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.batch_get_financial_record({
  keys: [ # required
    {
      identifier: "FinancialRecordIdentifier",
      invoice_identifier: "InvoiceId",
    },
  ],
})

Response structure


resp.financial_records #=> Array
resp.financial_records[0].id #=> String
resp.financial_records[0].type #=> String, one of "INVOICE", "CREDIT_MEMO"
resp.financial_records[0].business_unit.merchant_of_record #=> String
resp.financial_records[0].business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
resp.financial_records[0].amount.value #=> String
resp.financial_records[0].amount.currency #=> String
resp.financial_records[0].balances.outstanding.value #=> String
resp.financial_records[0].balances.outstanding.currency #=> String
resp.financial_records[0].balances.processing.value #=> String
resp.financial_records[0].balances.processing.currency #=> String
resp.financial_records[0].balances.settled.value #=> String
resp.financial_records[0].balances.settled.currency #=> String
resp.financial_records[0].balances.canceled.value #=> String
resp.financial_records[0].balances.canceled.currency #=> String
resp.financial_records[0].settlement_status #=> String, one of "OPEN", "CLOSED"
resp.financial_records[0].status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
resp.financial_records[0].issued_at #=> Time
resp.financial_records[0].closed_at #=> Time
resp.financial_records[0].details.invoice_details.invoice_id #=> String
resp.financial_records[0].details.invoice_details.due_status #=> String, one of "DUE", "PAST_DUE"
resp.financial_records[0].details.invoice_details.billing_period.start_date #=> Time
resp.financial_records[0].details.invoice_details.billing_period.end_date #=> Time
resp.financial_records[0].details.invoice_details.due_date #=> Time
resp.financial_records[0].details.invoice_details.payment_terms #=> String
resp.financial_records[0].details.invoice_details.invoice_frequency #=> String, one of "ONE_TIME", "RECURRING"
resp.financial_records[0].details.credit_memo_details.invoice_id #=> String
resp.financial_records[0].details.credit_memo_details.billing_period.start_date #=> Time
resp.financial_records[0].details.credit_memo_details.billing_period.end_date #=> Time
resp.errors #=> Array
resp.errors[0].key.identifier #=> String
resp.errors[0].key.invoice_identifier #=> String
resp.errors[0].code #=> String, one of "NOT_FOUND", "INTERNAL_ERROR"
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :keys (required, Array<Types::FinancialRecordKey>) —

    The keys of the financial records to retrieve. Each key is either the record's ID or its invoice ID.

Returns:

See Also:



640
641
642
643
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 640

def batch_get_financial_record(params = {}, options = {})
  req = build_request(:batch_get_financial_record, params)
  req.send_request(options)
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.

Examples:

Example: Invoke GetAccountBalance


resp = client.({
  balance_type: "INVOICES_PAST_DUE", 
})

resp.to_h outputs the following:
{
  account_balances: [
    {
      amount: {
        value: "1250.00", 
        currency: "USD", 
      }, 
      merchant_of_record: "Amazon Web Services, Inc.", 
    }, 
    {
      amount: {
        value: "430.75", 
        currency: "INR", 
      }, 
      merchant_of_record: "Amazon Web Services India Private Limited", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.({
  balance_type: "INVOICES_DUE", # required, accepts INVOICES_DUE, INVOICES_PAST_DUE, OUTSTANDING_CREDIT_MEMOS
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp. #=> Array
resp.[0].amount.value #=> String
resp.[0].amount.currency #=> String
resp.[0].merchant_of_record #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :balance_type (required, String) —

    The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the outstanding balance of the records that have the status OUTSTANDING. A record that is PROCESSING, SETTLED, or CANCELED isn't included, even when part of its amount is outstanding. The following values are valid:

    • INVOICES_DUE – The outstanding balance of your OUTSTANDING invoices that aren't past their due date, where dueStatus is DUE.

    • INVOICES_PAST_DUE – The outstanding balance of your OUTSTANDING invoices that are past their due date, where dueStatus is PAST_DUE.

    • OUTSTANDING_CREDIT_MEMOS – The outstanding balance of your OUTSTANDING credit memos: the credit that isn't yet applied to an invoice.

  • :next_token (String) —

    The pagination token from the nextToken of the previous response. Omit it to get the first page. Tokens expire. If the token is malformed or expired, or doesn't match the original request, the request fails with ValidationException and the reason INVALID_PAGINATION_TOKEN. In that case, start again from the first page.

  • :max_results (Integer) —

    The maximum number of results to return in one page. The default is 100. A page can contain fewer results even when more remain. Use nextToken to find out whether more results are available.

Returns:

See Also:



743
744
745
746
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 743

def (params = {}, options = {})
  req = build_request(:get_account_balance, params)
  req.send_request(options)
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.

Examples:

Example: Invoke GetFinancialRecord


resp = client.get_financial_record({
  identifier: "INV-1234-5678-9012-3456", 
})

resp.to_h outputs the following:
{
  financial_record: {
    type: "INVOICE", 
    amount: {
      value: "1000.24", 
      currency: "USD", 
    }, 
    balances: {
      canceled: {
        value: "0.0", 
        currency: "USD", 
      }, 
      outstanding: {
        value: "0.0", 
        currency: "USD", 
      }, 
      processing: {
        value: "0.0", 
        currency: "USD", 
      }, 
      settled: {
        value: "1000.24", 
        currency: "USD", 
      }, 
    }, 
    business_unit: {
      line_of_business: "AWS_CLOUD_SERVICES", 
      merchant_of_record: "Amazon Web Services, Inc.", 
    }, 
    closed_at: Time.parse(1736208000), 
    details: {
      invoice_details: {
        billing_period: {
          end_date: Time.parse(1735689600), 
          start_date: Time.parse(1733011200), 
        }, 
        due_date: Time.parse(1738281600), 
        invoice_frequency: "RECURRING", 
        invoice_id: "536462537364", 
        payment_terms: "Net30", 
      }, 
    }, 
    id: "INV-1234-5678-9012-3456", 
    issued_at: Time.parse(1735689600), 
    settlement_status: "CLOSED", 
    status: "SETTLED", 
  }, 
}

Request syntax with placeholder values


resp = client.get_financial_record({
  identifier: "FinancialRecordIdentifier",
  invoice_identifier: "InvoiceId",
})

Response structure


resp.financial_record.id #=> String
resp.financial_record.type #=> String, one of "INVOICE", "CREDIT_MEMO"
resp.financial_record.business_unit.merchant_of_record #=> String
resp.financial_record.business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
resp.financial_record.amount.value #=> String
resp.financial_record.amount.currency #=> String
resp.financial_record.balances.outstanding.value #=> String
resp.financial_record.balances.outstanding.currency #=> String
resp.financial_record.balances.processing.value #=> String
resp.financial_record.balances.processing.currency #=> String
resp.financial_record.balances.settled.value #=> String
resp.financial_record.balances.settled.currency #=> String
resp.financial_record.balances.canceled.value #=> String
resp.financial_record.balances.canceled.currency #=> String
resp.financial_record.settlement_status #=> String, one of "OPEN", "CLOSED"
resp.financial_record.status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
resp.financial_record.issued_at #=> Time
resp.financial_record.closed_at #=> Time
resp.financial_record.details.invoice_details.invoice_id #=> String
resp.financial_record.details.invoice_details.due_status #=> String, one of "DUE", "PAST_DUE"
resp.financial_record.details.invoice_details.billing_period.start_date #=> Time
resp.financial_record.details.invoice_details.billing_period.end_date #=> Time
resp.financial_record.details.invoice_details.due_date #=> Time
resp.financial_record.details.invoice_details.payment_terms #=> String
resp.financial_record.details.invoice_details.invoice_frequency #=> String, one of "ONE_TIME", "RECURRING"
resp.financial_record.details.credit_memo_details.invoice_id #=> String
resp.financial_record.details.credit_memo_details.billing_period.start_date #=> Time
resp.financial_record.details.credit_memo_details.billing_period.end_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (String) —

    The ID that Amazon Web Services Payments issued for the financial record, as returned in id.

  • :invoice_identifier (String) —

    The invoice ID that Amazon Web Services Invoicing issued for an invoice or a credit memo. The operation returns the record that has this invoice ID.

Returns:

See Also:



879
880
881
882
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 879

def get_financial_record(params = {}, options = {})
  req = build_request(:get_financial_record, params)
  req.send_request(options)
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.

Examples:

Example: Invoke GetPaymentInstrument


resp = client.get_payment_instrument({
  identifier: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333", 
})

resp.to_h outputs the following:
{
  payment_instrument: {
    arn: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333", 
    created_at: Time.parse(1735689600), 
    details: {
      card: {
        brand: "VISA", 
        card_type: "CREDIT", 
        expiration_month: 7, 
        expiration_year: 2030, 
        issuer_country: "US", 
        issuing_bank: "Example Bank", 
        last4: "1111", 
      }, 
    }, 
    payment_method: "CARD", 
    status: "ACTIVE", 
    updated_at: Time.parse(1738368000), 
  }, 
}

Request syntax with placeholder values


resp = client.get_payment_instrument({
  identifier: "PaymentInstrumentIdentifier", # required
})

Response structure


resp.payment_instrument.arn #=> String
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"
resp.payment_instrument.status #=> String, one of "ACTIVE", "PENDING_SETUP", "SETUP_IN_PROGRESS", "INVALID"
resp.payment_instrument.details.card.brand #=> String, one of "VISA", "MASTERCARD", "AMEX", "DISCOVER", "JCB", "RUPAY", "CHINA_UNIONPAY"
resp.payment_instrument.details.card.last4 #=> String
resp.payment_instrument.details.card.expiration_month #=> Integer
resp.payment_instrument.details.card.expiration_year #=> Integer
resp.payment_instrument.details.card.card_type #=> String, one of "CREDIT", "DEBIT"
resp.payment_instrument.details.card.issuing_bank #=> String
resp.payment_instrument.details.card.issuer_country #=> String
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details..bank_name #=> String
resp.payment_instrument.details.. #=> String, one of "CHECKING", "SAVINGS"
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details..bank_name #=> String
resp.payment_instrument.details.. #=> String, one of "CHECKING", "SAVINGS"
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details.. #=> String
resp.payment_instrument.details..bank_name #=> String
resp.payment_instrument.details.. #=> String, one of "CHECKING", "SAVINGS"
resp.payment_instrument.details.in_net_banking.bank_code #=> String
resp.payment_instrument.details.in_net_banking.bank_name #=> String
resp.payment_instrument.details.cn_bank_redirect.bank_code #=> String
resp.payment_instrument.details.upi.app_name #=> String
resp.payment_instrument.created_at #=> Time
resp.payment_instrument.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The instrument to retrieve. Specify one of the following:

    • The Amazon Resource Name (ARN) of the instrument, as ListPaymentInstruments returns in arn. The ARN must be for an instrument on your account.

    • The ID of the instrument, as ListPaymentInstruments returns in id.

Returns:

See Also:



978
979
980
981
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 978

def get_payment_instrument(params = {}, options = {})
  req = build_request(:get_payment_instrument, params)
  req.send_request(options)
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.

Examples:

Example: Invoke ListFinancialRecords


resp = client.list_financial_records({
  max_results: 5, 
  settlement_statuses: [
    "CLOSED", 
  ], 
  sort_by: "ISSUED_AT", 
  sort_order: "DESCENDING", 
  types: [
    "INVOICE", 
  ], 
})

resp.to_h outputs the following:
{
  financial_record_summaries: [
    {
      type: "INVOICE", 
      amount: {
        value: "1000.24", 
        currency: "USD", 
      }, 
      balances: {
        canceled: {
          value: "0.0", 
          currency: "USD", 
        }, 
        outstanding: {
          value: "0.0", 
          currency: "USD", 
        }, 
        processing: {
          value: "0.0", 
          currency: "USD", 
        }, 
        settled: {
          value: "1000.24", 
          currency: "USD", 
        }, 
      }, 
      business_unit: {
        line_of_business: "AWS_CLOUD_SERVICES", 
        merchant_of_record: "Amazon Web Services, Inc.", 
      }, 
      closed_at: Time.parse(1736208000), 
      id: "INV-1234-5678-9012-3456", 
      issued_at: Time.parse(1735689600), 
      settlement_status: "CLOSED", 
      status: "SETTLED", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_financial_records({
  types: ["INVOICE"], # required, accepts INVOICE, CREDIT_MEMO
  settlement_statuses: ["OPEN"], # accepts OPEN, CLOSED
  issued_after: Time.now,
  issued_before: Time.now,
  sort_by: "ISSUED_AT", # accepts ISSUED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.financial_record_summaries #=> Array
resp.financial_record_summaries[0].id #=> String
resp.financial_record_summaries[0].type #=> String, one of "INVOICE", "CREDIT_MEMO"
resp.financial_record_summaries[0].business_unit.merchant_of_record #=> String
resp.financial_record_summaries[0].business_unit.line_of_business #=> String, one of "AWS_CLOUD_SERVICES", "PROSERVE_MARKETING_AND_TRAINING", "AWS_MARKETPLACE"
resp.financial_record_summaries[0].amount.value #=> String
resp.financial_record_summaries[0].amount.currency #=> String
resp.financial_record_summaries[0].balances.outstanding.value #=> String
resp.financial_record_summaries[0].balances.outstanding.currency #=> String
resp.financial_record_summaries[0].balances.processing.value #=> String
resp.financial_record_summaries[0].balances.processing.currency #=> String
resp.financial_record_summaries[0].balances.settled.value #=> String
resp.financial_record_summaries[0].balances.settled.currency #=> String
resp.financial_record_summaries[0].balances.canceled.value #=> String
resp.financial_record_summaries[0].balances.canceled.currency #=> String
resp.financial_record_summaries[0].settlement_status #=> String, one of "OPEN", "CLOSED"
resp.financial_record_summaries[0].status #=> String, one of "OUTSTANDING", "PROCESSING", "SETTLED", "CANCELED"
resp.financial_record_summaries[0].issued_at #=> Time
resp.financial_record_summaries[0].closed_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :types (required, Array<String>) —

    The financial record types to return. The following values are valid:

    • INVOICE – An invoice: a bill from Amazon Web Services. Payments and credit memos applied to the invoice settle it.

    • CREDIT_MEMO – A credit memo: a credit issued to your account, for example for a billing correction or a service credit. Applying it to one or more invoices settles it.

  • :settlement_statuses (Array<String>) —

    The settlement statuses to filter by. OPEN returns records whose status is OUTSTANDING or PROCESSING. CLOSED returns records whose status is SETTLED or CANCELED. When you omit this member, the operation returns records with both settlement statuses.

  • :issued_after (Time, DateTime, Date, Integer, String) —

    The earliest date and time to return records for, inclusive. The operation returns the records that were issued at or after this time.

  • :issued_before (Time, DateTime, Date, Integer, String) —

    The latest date and time to return records for, exclusive. The operation returns the records that were issued before this time. When you specify both issuedAfter and issuedBefore, issuedBefore must be later than issuedAfter.

  • :sort_by (String) —

    The field to sort the results by. The default is ISSUED_AT, the date and time when the record was issued.

  • :sort_order (String) —

    The order to sort the results in. The default is DESCENDING, which returns the newest records first. ASCENDING returns the oldest records first.

  • :next_token (String) —

    The pagination token from the nextToken of the previous response. Omit it to get the first page. Tokens expire. If the token is malformed or expired, or doesn't match the original request, the request fails with ValidationException and the reason INVALID_PAGINATION_TOKEN. In that case, start again from the first page.

  • :max_results (Integer) —

    The maximum number of results to return in one page. The default is 100. A page can contain fewer results even when more remain. Use nextToken to find out whether more results are available.

Returns:

See Also:



1145
1146
1147
1148
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 1145

def list_financial_records(params = {}, options = {})
  req = build_request(:list_financial_records, params)
  req.send_request(options)
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.

Examples:

Example: Invoke ListPaymentInstruments


resp = client.list_payment_instruments({
  max_results: 5, 
})

resp.to_h outputs the following:
{
  payment_instrument_summaries: [
    {
      arn: "arn:aws:payments::123456789012:payment-instrument:1a2b3c4d-5e6f-7a8b-9c0d-111122223333", 
      created_at: Time.parse(1735689600), 
      id: "1a2b3c4d-5e6f-7a8b-9c0d-111122223333", 
      payment_method: "CARD", 
      status: "ACTIVE", 
      updated_at: Time.parse(1738368000), 
    }, 
    {
      arn: "arn:aws:payments::123456789012:payment-instrument:2b3c4d5e-6f7a-8b9c-0d1e-444455556666", 
      created_at: Time.parse(1727740800), 
      id: "2b3c4d5e-6f7a-8b9c-0d1e-444455556666", 
      payment_method: "US_ACH_BANK_ACCOUNT", 
      status: "ACTIVE", 
      updated_at: Time.parse(1727740800), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_payment_instruments({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.payment_instrument_summaries #=> Array
resp.payment_instrument_summaries[0].id #=> String
resp.payment_instrument_summaries[0].arn #=> String
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"
resp.payment_instrument_summaries[0].status #=> String, one of "ACTIVE", "PENDING_SETUP", "SETUP_IN_PROGRESS", "INVALID"
resp.payment_instrument_summaries[0].created_at #=> Time
resp.payment_instrument_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the nextToken of the previous response. Omit it to get the first page. Tokens expire. If the token is malformed or expired, or doesn't match the original request, the request fails with ValidationException and the reason INVALID_PAGINATION_TOKEN. In that case, start again from the first page.

  • :max_results (Integer) —

    The maximum number of payment instruments to return in one page. The default is 25. A page can contain fewer payment instruments even when more remain. Use nextToken to find out whether more payment instruments are available.

Returns:

See Also:



1231
1232
1233
1234
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/client.rb', line 1231

def list_payment_instruments(params = {}, options = {})
  req = build_request(:list_payment_instruments, params)
  req.send_request(options)
end