PaymentConnectorSummary
Contains summary information about a payment connector.
Contents
- lastUpdatedAt
-
The timestamp when the payment connector was last updated.
Type: Timestamp
Required: Yes
- name
-
The name of the payment connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,47}Required: Yes
- paymentConnectorId
-
The unique identifier of the payment connector.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 211.
Pattern:
([0-9a-z_][-]?){1,100}-[0-9a-z]{10}Required: Yes
- status
-
The current status of the payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.Type: String
Valid Values:
CREATING | UPDATING | DELETING | READY | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED | PENDING_AUTHENTICATION | PROVISIONING | AUTHENTICATION_EXPIRED | AUTHENTICATION_FAILEDRequired: Yes
- type
-
The type of the payment connector, which determines the payment provider integration.
Type: String
Valid Values:
CoinbaseCDP | StripePrivyRequired: Yes
- 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. -
QUICK_CREATE- AgentCore provisioned the credential provider for you, so the credentials are service-managed and you can rotate them withRotatePaymentConnectorCredentials.
Type: String
Valid Values:
MANUAL | QUICK_CREATERequired: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: