ROTATEPAYMENTCONNECTORCREDS()`¶

About RotatePaymentConnectorCredentials¶

Replaces the service-managed credentials of a payment connector with newly issued credentials.

Use this operation only for payment connectors with a provisionMode of QUICK_CREATE. For payment connectors with a provisionMode of MANUAL, call UpdatePaymentCredentialProvider instead after rotating credentials with the payment provider directly.

The rotation finishes before the response is returned, and only one rotation runs at a time for a given payment connector. When it succeeds, the new credential is in effect and the payment connector stays in the READY state. When it fails, an error is returned, the payment connector and its existing credential are left unchanged, and you can retry the request.

Rotation replaces the credential on the connector's credential provider, so every payment connector that uses that provider is affected. Replace any copy of the previous credential that you use outside AgentCore.

Method Signature¶

METHODS /AWS1/IF_BDO~ROTATEPAYMENTCONNECTORCREDS
  IMPORTING
    !IV_PAYMENTMANAGERID TYPE /AWS1/BDOPAYMENTMANAGERID OPTIONAL
    !IV_PAYMENTCONNECTORID TYPE /AWS1/BDOPAYMENTCONNECTORID OPTIONAL
    !IO_CREDENTIALSTOROTATE TYPE REF TO /AWS1/CL_BDOCREDROTATIONCONFIG OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDOCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdorotpmntcnrcredsrsp
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOCONFLICTEXCEPTION
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_paymentmanagerid` `TYPE /AWS1/BDOPAYMENTMANAGERID` `/AWS1/BDOPAYMENTMANAGERID`¶

The unique identifier of the parent payment manager.

`iv_paymentconnectorid` `TYPE /AWS1/BDOPAYMENTCONNECTORID` `/AWS1/BDOPAYMENTCONNECTORID`¶

The unique identifier of the payment connector whose credentials you want to rotate.

`io_credentialstorotate` `TYPE REF TO /AWS1/CL_BDOCREDROTATIONCONFIG` `/AWS1/CL_BDOCREDROTATIONCONFIG`¶

The credentials to rotate. Specify the member that matches the payment connector's type. Each credential that you select is rotated independently.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/BDOCLIENTTOKEN` `/AWS1/BDOCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdorotpmntcnrcredsrsp` `/AWS1/CL_BDOROTPMNTCNRCREDSRSP`¶

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->rotatepaymentconnectorcreds(
  io_credentialstorotate = new /aws1/cl_bdocredrotationconfig(
    io_coinbasecdp = new /aws1/cl_bdocnbscdprotationtgt(
      it_secrets = VALUE /aws1/cl_bdocnbscdpsecrets_w=>tt_coinbasecdpsecrets(
        ( new /aws1/cl_bdocnbscdpsecrets_w( |string| ) )
      )
    )
  )
  iv_clienttoken = |string|
  iv_paymentconnectorid = |string|
  iv_paymentmanagerid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paymentconnectorid = lo_result->get_paymentconnectorid( ).
  lv_paymentmanagerid = lo_result->get_paymentmanagerid( ).
  lv_datetimestamp = lo_result->get_lastupdatedat( ).
  lv_paymentconnectorstatus = lo_result->get_status( ).
ENDIF.

/AWS1/IF_BDO=>ROTATEPAYMENTCONNECTORCREDS()¶