/AWS1/IF_WA2=>LISTSETTLEMENTRECORDS()

About ListSettlementRecords

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.

Method Signature

METHODS /AWS1/IF_WA2~LISTSETTLEMENTRECORDS
  IMPORTING
    !IO_TIMEWINDOW TYPE REF TO /AWS1/CL_WA2TIMEWINDOW OPTIONAL
    !IV_SCOPE TYPE /AWS1/WA2SCOPE OPTIONAL
    !IV_CURRENCY TYPE /AWS1/WA2CURRENCY OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_WA2MONETIZATIONFILTER=>TT_MONETIZATIONFILTERLIST OPTIONAL
    !IV_SORTBY TYPE /AWS1/WA2SETTLEMENTSORTBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/WA2SORTORDER OPTIONAL
    !IV_LIMIT TYPE /AWS1/WA2SETTLEMENTRECORDLIMIT OPTIONAL
    !IV_NEXTMARKER TYPE /AWS1/WA2NEXTMARKER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wa2lstsettlementrec01
  RAISING
    /AWS1/CX_WA2WAFINTERNALERROREX
    /AWS1/CX_WA2WAFINVALIDOPEX
    /AWS1/CX_WA2WAFINVALIDPARAMEX
    /AWS1/CX_WA2WAFNONEXENTITEMEX
    /AWS1/CX_WA2CLIENTEXC
    /AWS1/CX_WA2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_timewindow TYPE REF TO /AWS1/CL_WA2TIMEWINDOW /AWS1/CL_WA2TIMEWINDOW

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

iv_scope TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE

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

iv_currency TYPE /AWS1/WA2CURRENCY /AWS1/WA2CURRENCY

The currency for the amounts in the response.

Optional arguments:

it_filters TYPE /AWS1/CL_WA2MONETIZATIONFILTER=>TT_MONETIZATIONFILTERLIST TT_MONETIZATIONFILTERLIST

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

iv_sortby TYPE /AWS1/WA2SETTLEMENTSORTBY /AWS1/WA2SETTLEMENTSORTBY

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

iv_sortorder TYPE /AWS1/WA2SORTORDER /AWS1/WA2SORTORDER

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

iv_limit TYPE /AWS1/WA2SETTLEMENTRECORDLIMIT /AWS1/WA2SETTLEMENTRECORDLIMIT

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

iv_nextmarker TYPE /AWS1/WA2NEXTMARKER /AWS1/WA2NEXTMARKER

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

RETURNING

oo_output TYPE REF TO /aws1/cl_wa2lstsettlementrec01 /AWS1/CL_WA2LSTSETTLEMENTREC01

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listsettlementrecords(
  io_timewindow = new /aws1/cl_wa2timewindow(
    iv_endtime = '20150101000000.0000000'
    iv_starttime = '20150101000000.0000000'
  )
  it_filters = VALUE /aws1/cl_wa2monetizationfilter=>tt_monetizationfilterlist(
    (
      new /aws1/cl_wa2monetizationfilter(
        it_values = VALUE /aws1/cl_wa2monetizationfltv00=>tt_monetizationfiltervaluelist(
          ( new /aws1/cl_wa2monetizationfltv00( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_currency = |string|
  iv_limit = 123
  iv_nextmarker = |string|
  iv_scope = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_settlements( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_timestamp = lo_row_1->get_timestamp( ).
      lv_settlementfilterstring = lo_row_1->get_payeraddress( ).
      lv_settlementfilterstring = lo_row_1->get_walletaddress( ).
      lv_settlementstatus = lo_row_1->get_status( ).
      lv_monetizationamountvalue = lo_row_1->get_amount( ).
      lv_currency = lo_row_1->get_currency( ).
      lv_settlementfilterstring = lo_row_1->get_network( ).
      lv_settlementidstring = lo_row_1->get_transactionid( ).
      lv_settlementfilterstring = lo_row_1->get_requestid( ).
      lv_filterstring = lo_row_1->get_sourcename( ).
      lv_filterstring = lo_row_1->get_organization( ).
      lv_filterstring = lo_row_1->get_sourcecategory( ).
      lv_filterstring = lo_row_1->get_intent( ).
      lv_verifiedstatus = lo_row_1->get_verified( ).
      lv_filterstring = lo_row_1->get_contentpath( ).
      lv_resourcearn = lo_row_1->get_webaclarn( ).
      lv_timestamp = lo_row_1->get_requesttimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nextmarker = lo_result->get_nextmarker( ).
ENDIF.