GETAGREEMENTPAYMENTREQUEST()`¶

About GetAgreementPaymentRequest¶

Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.

The calling identity must be either the acceptor or proposer of the payment request. A ResourceNotFoundException is returned if the payment request does not exist.

Method Signature¶

METHODS /AWS1/IF_MPG~GETAGREEMENTPAYMENTREQUEST
  IMPORTING
    !IV_PAYMENTREQUESTID TYPE /AWS1/MPGPAYMENTREQUESTID OPTIONAL
    !IV_AGREEMENTID TYPE /AWS1/MPGAGREEMENTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpggetagrmtpmntreqout
  RAISING
    /AWS1/CX_MPGACCESSDENIEDEX
    /AWS1/CX_MPGINTERNALSERVEREX
    /AWS1/CX_MPGRESOURCENOTFOUNDEX
    /AWS1/CX_MPGTHROTTLINGEX
    /AWS1/CX_MPGVALIDATIONEX
    /AWS1/CX_MPGCLIENTEXC
    /AWS1/CX_MPGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_paymentrequestid` `TYPE /AWS1/MPGPAYMENTREQUESTID` `/AWS1/MPGPAYMENTREQUESTID`¶

The identifier of the payment request.

`iv_agreementid` `TYPE /AWS1/MPGAGREEMENTID` `/AWS1/MPGAGREEMENTID`¶

The unique identifier of the agreement associated with the payment request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_mpggetagrmtpmntreqout` `/AWS1/CL_MPGGETAGRMTPMNTREQOUT`¶

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->getagreementpaymentrequest(
  iv_agreementid = |string|
  iv_paymentrequestid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paymentrequestid = lo_result->get_paymentrequestid( ).
  lv_agreementid = lo_result->get_agreementid( ).
  lv_paymentrequeststatus = lo_result->get_status( ).
  lv_paymentrequeststatusmes = lo_result->get_statusmessage( ).
  lv_paymentrequestname = lo_result->get_name( ).
  lv_paymentrequestdescripti = lo_result->get_description( ).
  lv_chargeid = lo_result->get_chargeid( ).
  lv_positiveamountupto8deci = lo_result->get_chargeamount( ).
  lv_currencycode = lo_result->get_currencycode( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
ENDIF.

/AWS1/IF_MPG=>GETAGREEMENTPAYMENTREQUEST()¶