/AWS1/IF_BDC=>CREATEPAYMENTSESSION()

About CreatePaymentSession

Create a new payment session.

Method Signature

METHODS /AWS1/IF_BDC~CREATEPAYMENTSESSION
  IMPORTING
    !IV_USERID TYPE /AWS1/BDCUSERID OPTIONAL
    !IV_AGENTNAME TYPE /AWS1/BDCPAYMENTAGENTNAME OPTIONAL
    !IV_PAYMENTMANAGERARN TYPE /AWS1/BDCPAYMENTMANAGERARN OPTIONAL
    !IO_LIMITS TYPE REF TO /AWS1/CL_BDCSESSIONLIMITS OPTIONAL
    !IV_EXPIRYTIMEINMINUTES TYPE /AWS1/BDCINTEGER OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDCCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdccreatepmntsessrsp
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCCONFLICTEXCEPTION
    /AWS1/CX_BDCINTERNALSERVEREX
    /AWS1/CX_BDCSERVICEQUOTAEXCDEX
    /AWS1/CX_BDCTHROTTLINGEX
    /AWS1/CX_BDCVALIDATIONEX
    /AWS1/CX_BDCCLIENTEXC
    /AWS1/CX_BDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_paymentmanagerarn TYPE /AWS1/BDCPAYMENTMANAGERARN /AWS1/BDCPAYMENTMANAGERARN

The ARN of the payment manager that owns this session.

iv_expirytimeinminutes TYPE /AWS1/BDCINTEGER /AWS1/BDCINTEGER

The session expiry time in minutes. Must be between 15 and 480 minutes.

Optional arguments:

iv_userid TYPE /AWS1/BDCUSERID /AWS1/BDCUSERID

The user ID associated with this payment session.

iv_agentname TYPE /AWS1/BDCPAYMENTAGENTNAME /AWS1/BDCPAYMENTAGENTNAME

The agent name associated with this request, used for observability.

io_limits TYPE REF TO /AWS1/CL_BDCSESSIONLIMITS /AWS1/CL_BDCSESSIONLIMITS

The spending limits for this payment session.

iv_clienttoken TYPE /AWS1/BDCCLIENTTOKEN /AWS1/BDCCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdccreatepmntsessrsp /AWS1/CL_BDCCREATEPMNTSESSRSP

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->createpaymentsession(
  io_limits = new /aws1/cl_bdcsessionlimits(
    io_maxspendamount = new /aws1/cl_bdcamount(
      iv_currency = |string|
      iv_value = |string|
    )
  )
  iv_agentname = |string|
  iv_clienttoken = |string|
  iv_expirytimeinminutes = 123
  iv_paymentmanagerarn = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_paymentsession = lo_result->get_paymentsession( ).
  IF lo_paymentsession IS NOT INITIAL.
    lv_paymentsessionid = lo_paymentsession->get_paymentsessionid( ).
    lv_paymentmanagerarn = lo_paymentsession->get_paymentmanagerarn( ).
    lo_sessionlimits = lo_paymentsession->get_limits( ).
    IF lo_sessionlimits IS NOT INITIAL.
      lo_amount = lo_sessionlimits->get_maxspendamount( ).
      IF lo_amount IS NOT INITIAL.
        lv_string = lo_amount->get_value( ).
        lv_currency = lo_amount->get_currency( ).
      ENDIF.
    ENDIF.
    lv_userid = lo_paymentsession->get_userid( ).
    lv_integer = lo_paymentsession->get_expirytimeinminutes( ).
    lv_datetimestamp = lo_paymentsession->get_createdat( ).
    lo_availablelimits = lo_paymentsession->get_availablelimits( ).
    IF lo_availablelimits IS NOT INITIAL.
      lo_amount = lo_availablelimits->get_availablespendamount( ).
      IF lo_amount IS NOT INITIAL.
        lv_string = lo_amount->get_value( ).
        lv_currency = lo_amount->get_currency( ).
      ENDIF.
      lv_datetimestamp = lo_availablelimits->get_updatedat( ).
    ENDIF.
    lv_datetimestamp = lo_paymentsession->get_updatedat( ).
  ENDIF.
ENDIF.