Class: Aws::WAFV2::Types::SettlementRecord

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::SettlementRecord

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

A single settlement transaction record for AI bot monetization. Contains details about the payment including timestamp, amount, status, and the parties involved.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #amount ⇒ String

  The payment amount in the specified currency.

• #content_path ⇒ String

  The content path that was accessed.

• #currency ⇒ String

  The currency of the payment amount.

• #intent ⇒ String

  The declared intent of the AI bot request.

• #network ⇒ String

  The blockchain network on which the settlement occurred.

• #organization ⇒ String

  The organization associated with the AI bot.

• #payer_address ⇒ String

  The blockchain wallet address of the paying AI agent.

• #request_id ⇒ String

  The WAF request ID associated with this settlement.

• #request_timestamp ⇒ Time

  The timestamp of the original web request.

• #source_category ⇒ String

  The category of the AI bot source.

• #source_name ⇒ String

  The name of the AI bot that made the payment.

• #status ⇒ String

  The status of the settlement.

• #timestamp ⇒ Time

  The timestamp when the settlement was recorded.

• #transaction_id ⇒ String

  The blockchain transaction identifier.

• #verified ⇒ Boolean

  Whether the AI bot's identity was verified.

• #wallet_address ⇒ String

  Your receiving wallet address.

• #web_acl_arn ⇒ String

  The ARN of the web ACL that processed the request.

Instance Attribute Details

#amount ⇒ String

The payment amount in the specified currency.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#content_path ⇒ String

The content path that was accessed.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#currency ⇒ String

The currency of the payment amount.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#intent ⇒ String

The declared intent of the AI bot request.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#network ⇒ String

The blockchain network on which the settlement occurred.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#organization ⇒ String

The organization associated with the AI bot.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#payer_address ⇒ String

The blockchain wallet address of the paying AI agent.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ String

The WAF request ID associated with this settlement.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#request_timestamp ⇒ Time

The timestamp of the original web request.

Returns:

• (Time)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#source_category ⇒ String

The category of the AI bot source.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#source_name ⇒ String

The name of the AI bot that made the payment.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the settlement. Possible values:

• SETTLED - The payment was successfully settled on the blockchain and the transfer from the payer's wallet to the publisher's wallet is confirmed. The TransactionId field contains the on-chain transaction hash. Content is served to the client.

• PENDING - The blockchain transaction has been submitted but not yet confirmed on-chain. This is a transient state that automatically resolves to either SETTLED or FAILED. No action is required. While pending, content is not served and the API returns a 402 response. Clients can retry the request.

• FAILED - The payment settlement was attempted but failed. Possible causes include insufficient funds, an expired payment authorization, or a reverted blockchain transaction. The failureReason field contains a machine-readable error code. Content is not served.

• SERVICE_ERROR - Settlement could not be completed due to an internal service issue or an issue with the payment network. Content is not served. The client's payment authorization remains valid and the request can be retried.

• SKIPPED_ORIGIN_ERROR - The origin returned a non-2xx response, so settlement was intentionally skipped. The client is not charged.

• DUPLICATE - A prior request with the same payment payload has already been settled. This status typically appears when a previous attempt timed out but the payment was ultimately processed. The client is not charged again.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

The timestamp when the settlement was recorded.

Returns:

• (Time)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_id ⇒ String

The blockchain transaction identifier. You can use this to verify the transaction on a blockchain explorer.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#verified ⇒ Boolean

Whether the AI bot's identity was verified.

Returns:

• (Boolean)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#wallet_address ⇒ String

Your receiving wallet address.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#web_acl_arn ⇒ String

The ARN of the web ACL that processed the request.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9856

class SettlementRecord < Struct.new(
  :timestamp,
  :payer_address,
  :wallet_address,
  :status,
  :amount,
  :currency,
  :network,
  :transaction_id,
  :request_id,
  :source_name,
  :organization,
  :source_category,
  :intent,
  :verified,
  :content_path,
  :web_acl_arn,
  :request_timestamp)
  SENSITIVE = []
  include Aws::Structure
end