get_payment_connector¶
Operation¶
async
¶
get_payment_connector(input: GetPaymentConnectorInput, plugins: list[Plugin] | None = None) -> GetPaymentConnectorOutput
Retrieves information about a specific payment connector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetPaymentConnectorInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
GetPaymentConnectorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetPaymentConnectorInput structure.
Attributes¶
class-attribute
instance-attribute
¶
payment_connector_id: str | None = None
The unique identifier of the payment connector to retrieve.
class-attribute
instance-attribute
¶
payment_manager_id: str | None = None
The unique identifier of the parent payment manager.
Output¶
dataclass
¶
Dataclass for GetPaymentConnectorOutput structure.
Attributes¶
instance-attribute
¶
created_at: datetime
The timestamp when the payment connector was created.
instance-attribute
¶
credential_provider_configurations: list[CredentialsProviderConfiguration]
The credential provider configurations for the payment connector.
class-attribute
instance-attribute
¶
description: str | None = None
The description of the payment connector.
instance-attribute
¶
last_updated_at: datetime
The timestamp when the payment connector was last updated.
instance-attribute
¶
payment_connector_id: str
The unique identifier of the payment connector.
instance-attribute
¶
status: PaymentConnectorStatus
The current status of the payment connector. Possible values include
CREATING, READY, UPDATING, DELETING, CREATE_FAILED,
UPDATE_FAILED, and DELETE_FAILED.
instance-attribute
¶
type: PaymentConnectorType
The type of the payment connector, which determines the payment provider integration.