update_payment_connector¶
Operation¶
async
¶
update_payment_connector(input: UpdatePaymentConnectorInput, plugins: list[Plugin] | None = None) -> UpdatePaymentConnectorOutput
Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdatePaymentConnectorInput
|
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 |
|---|---|
UpdatePaymentConnectorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdatePaymentConnectorInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
class-attribute
instance-attribute
¶
credential_provider_configurations: list[CredentialsProviderConfiguration] | None = None
The updated credential provider configurations for the payment connector.
class-attribute
instance-attribute
¶
description: str | None = None
The updated description of the payment connector.
class-attribute
instance-attribute
¶
payment_connector_id: str | None = None
The unique identifier of the payment connector to update.
class-attribute
instance-attribute
¶
payment_manager_id: str | None = None
The unique identifier of the parent payment manager.
class-attribute
instance-attribute
¶
type: PaymentConnectorType | None = None
The updated type of the payment connector.
Output¶
dataclass
¶
Dataclass for UpdatePaymentConnectorOutput structure.
Attributes¶
instance-attribute
¶
credential_provider_configurations: list[CredentialsProviderConfiguration]
The credential provider configurations for the updated 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 updated payment connector.
instance-attribute
¶
payment_manager_id: str
The unique identifier of the parent payment manager.
instance-attribute
¶
status: PaymentConnectorStatus
The current status of the updated payment connector. Possible values
include CREATING, READY, UPDATING, DELETING, CREATE_FAILED,
UPDATE_FAILED, and DELETE_FAILED.