Skip to content

get_payment_connector

Operation

get_payment_connector

get_payment_connector(request: GetPaymentConnectorInput | GetPaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentConnectorInputDict]) -> GetPaymentConnectorOutput

Retrieves information about a specific payment connector.

Parameters:

Name Type Description Default
request GetPaymentConnectorInput | GetPaymentConnectorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentConnectorOutput

An instance of GetPaymentConnectorOutput.

get_payment_connector async

get_payment_connector(request: GetPaymentConnectorInput | GetPaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentConnectorInputDict]) -> GetPaymentConnectorOutput

Retrieves information about a specific payment connector.

Parameters:

Name Type Description Default
request GetPaymentConnectorInput | GetPaymentConnectorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentConnectorOutput

An instance of GetPaymentConnectorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetPaymentConnectorInputDict

Bases: TypedDict

Dictionary form of GetPaymentConnectorInput.

Attributes

payment_connector_id instance-attribute
payment_connector_id: Required[str]

The unique identifier of the payment connector to retrieve.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the parent payment manager.

GetPaymentConnectorInput dataclass

Bases: _SerdeShape

Dataclass for GetPaymentConnectorInput structure.

Attributes

payment_connector_id class-attribute instance-attribute
payment_connector_id: str | None = ...

The unique identifier of the payment connector to retrieve.

payment_manager_id class-attribute instance-attribute
payment_manager_id: str | None = ...

The unique identifier of the parent payment manager.

Output

GetPaymentConnectorOutput dataclass

Bases: _SerdeShape

Dataclass for GetPaymentConnectorOutput structure.

Attributes

authorization_url class-attribute instance-attribute
authorization_url: str | None = ...

The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.

created_at instance-attribute
created_at: datetime

The timestamp when the payment connector was created.

credential_provider_configurations instance-attribute
credential_provider_configurations: list[CredentialsProviderConfiguration]

The credential provider configurations for the payment connector.

credentials_updated_at class-attribute instance-attribute
credentials_updated_at: datetime | None = ...

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 provisionMode of QUICK_CREATE.

description class-attribute instance-attribute
description: str | None = ...

The description of the payment connector.

last_updated_at instance-attribute
last_updated_at: datetime

The timestamp when the payment connector was last updated.

name instance-attribute
name: str

The name of the payment connector.

payment_connector_id instance-attribute
payment_connector_id: str

The unique identifier of the payment connector.

provision_mode class-attribute instance-attribute
provision_mode: str | None = ...

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 call UpdatePaymentCredentialProvider.

  • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

type instance-attribute
type: str

The type of the payment connector, which determines the payment provider integration.