/AWS1/CL_BDOGETPAYMENTCNCTRRSP¶
GetPaymentConnectorResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_paymentconnectorid TYPE /AWS1/BDOPAYMENTCONNECTORID /AWS1/BDOPAYMENTCONNECTORID¶
The unique identifier of the payment connector.
iv_name TYPE /AWS1/BDOPAYMENTCONNECTORNAME /AWS1/BDOPAYMENTCONNECTORNAME¶
The name of the payment connector.
iv_type TYPE /AWS1/BDOPAYMENTCONNECTORTYPE /AWS1/BDOPAYMENTCONNECTORTYPE¶
The type of the payment connector, which determines the payment provider integration.
it_credentialproviderconfs TYPE /AWS1/CL_BDOCREDSPROVIDERCONF=>TT_CREDENTIALSPROVIDERCONFS TT_CREDENTIALSPROVIDERCONFS¶
The credential provider configurations for the payment connector.
iv_createdat TYPE /AWS1/BDODATETIMESTAMP /AWS1/BDODATETIMESTAMP¶
The timestamp when the payment connector was created.
iv_lastupdatedat TYPE /AWS1/BDODATETIMESTAMP /AWS1/BDODATETIMESTAMP¶
The timestamp when the payment connector was last updated.
iv_status TYPE /AWS1/BDOPAYMENTCNCTRSTATUS /AWS1/BDOPAYMENTCNCTRSTATUS¶
The current status of the payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
Optional arguments:¶
iv_description TYPE /AWS1/BDOPAYMENTSDESCRIPTION /AWS1/BDOPAYMENTSDESCRIPTION¶
The description of the payment connector.
iv_provisionmode TYPE /AWS1/BDOPAYMENTCNCTRPROVMODE /AWS1/BDOPAYMENTCNCTRPROVMODE¶
Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return
MANUAL.
MANUAL- You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then callUpdatePaymentCredentialProvider.
QUICK_CREATE- AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them withRotatePaymentConnectorCredentials.
iv_authorizationurl TYPE /AWS1/BDOPAYMENTCNCTRAUTHURL /AWS1/BDOPAYMENTCNCTRAUTHURL¶
The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is
PENDING_AUTHENTICATION.
iv_credentialsupdatedat TYPE /AWS1/BDODATETIMESTAMP /AWS1/BDODATETIMESTAMP¶
The timestamp when the payment connector's current service-managed credentials took effect. It is first set when the credentials are provisioned and is updated by each rotation. This field is present only for payment connectors with a
provisionModeofQUICK_CREATE.
Queryable Attributes¶
paymentConnectorId¶
The unique identifier of the payment connector.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAYMENTCONNECTORID() |
Getter for PAYMENTCONNECTORID, with configurable default |
ASK_PAYMENTCONNECTORID() |
Getter for PAYMENTCONNECTORID w/ exceptions if field has no |
HAS_PAYMENTCONNECTORID() |
Determine if PAYMENTCONNECTORID has a value |
name¶
The name of the payment connector.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
description¶
The description of the payment connector.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
type¶
The type of the payment connector, which determines the payment provider integration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
provisionMode¶
Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return
MANUAL.
MANUAL- You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then callUpdatePaymentCredentialProvider.
QUICK_CREATE- AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them withRotatePaymentConnectorCredentials.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROVISIONMODE() |
Getter for PROVISIONMODE, with configurable default |
ASK_PROVISIONMODE() |
Getter for PROVISIONMODE w/ exceptions if field has no value |
HAS_PROVISIONMODE() |
Determine if PROVISIONMODE has a value |
credentialProviderConfigurations¶
The credential provider configurations for the payment connector.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPROVIDERCONFS() |
Getter for CREDENTIALPROVIDERCONFS, with configurable defaul |
ASK_CREDENTIALPROVIDERCONFS() |
Getter for CREDENTIALPROVIDERCONFS w/ exceptions if field ha |
HAS_CREDENTIALPROVIDERCONFS() |
Determine if CREDENTIALPROVIDERCONFS has a value |
createdAt¶
The timestamp when the payment connector was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
lastUpdatedAt¶
The timestamp when the payment connector was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT, with configurable default |
ASK_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT w/ exceptions if field has no value |
HAS_LASTUPDATEDAT() |
Determine if LASTUPDATEDAT has a value |
status¶
The current status of the payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
authorizationUrl¶
The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is
PENDING_AUTHENTICATION.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHORIZATIONURL() |
Getter for AUTHORIZATIONURL, with configurable default |
ASK_AUTHORIZATIONURL() |
Getter for AUTHORIZATIONURL w/ exceptions if field has no va |
HAS_AUTHORIZATIONURL() |
Determine if AUTHORIZATIONURL has a value |
credentialsUpdatedAt¶
The timestamp when the payment connector's current service-managed credentials took effect. It is first set when the credentials are provisioned and is updated by each rotation. This field is present only for payment connectors with a
provisionModeofQUICK_CREATE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALSUPDATEDAT() |
Getter for CREDENTIALSUPDATEDAT, with configurable default |
ASK_CREDENTIALSUPDATEDAT() |
Getter for CREDENTIALSUPDATEDAT w/ exceptions if field has n |
HAS_CREDENTIALSUPDATEDAT() |
Determine if CREDENTIALSUPDATEDAT has a value |