Skip to content

Retrieves individual settlement transaction records for monetization

Description

Retrieves individual settlement transaction records for monetization. Each record represents a single payment transaction between a client and your protected resource. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST.

Usage

wafv2_list_settlement_records(TimeWindow, Scope, Currency, Filters,
  SortBy, SortOrder, Limit, NextMarker)

Arguments

  • TimeWindow

    [required] The time range for the query. Specify start and end timestamps.

  • Scope

    [required] Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

  • Currency

    [required] The currency for the amounts in the response.

  • Filters

    Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

  • SortBy

    The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.

  • SortOrder

    The sort order: ASC for ascending or DESC for descending.

  • Limit

    The maximum number of settlement records to return. Minimum: 1. Maximum: 100.

  • NextMarker

    When you get a paginated response, this marker indicates that additional results are available.

Value

A list with the following syntax:

list(
  Settlements = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      PayerAddress = "string",
      WalletAddress = "string",
      Status = "SETTLED"|"PENDING"|"FAILED"|"SERVICE_ERROR"|"SKIPPED_ORIGIN_ERROR"|"DUPLICATE",
      Amount = "string",
      Currency = "USDC",
      Network = "string",
      TransactionId = "string",
      RequestId = "string",
      SourceName = "string",
      Organization = "string",
      SourceCategory = "string",
      Intent = "string",
      Verified = TRUE|FALSE,
      ContentPath = "string",
      WebAclArn = "string",
      RequestTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextMarker = "string"
)

Request syntax

svc$list_settlement_records(
  TimeWindow = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  Scope = "CLOUDFRONT"|"REGIONAL",
  Currency = "USDC",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  SortBy = "TIMESTAMP"|"AMOUNT"|"NAME"|"STATUS",
  SortOrder = "ASC"|"DESC",
  Limit = 123,
  NextMarker = "string"
)