Skip to content

update_payment_connector

Operation

update_payment_connector

update_payment_connector(request: UpdatePaymentConnectorInput | UpdatePaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePaymentConnectorInputDict]) -> 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
request UpdatePaymentConnectorInput | UpdatePaymentConnectorInputDict | 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[UpdatePaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePaymentConnectorOutput

An instance of UpdatePaymentConnectorOutput.

update_payment_connector async

update_payment_connector(request: UpdatePaymentConnectorInput | UpdatePaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePaymentConnectorInputDict]) -> 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
request UpdatePaymentConnectorInput | UpdatePaymentConnectorInputDict | 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[UpdatePaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePaymentConnectorOutput

An instance of UpdatePaymentConnectorOutput.

Input

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

UpdatePaymentConnectorInputDict

Bases: TypedDict

Dictionary form of UpdatePaymentConnectorInput.

Attributes

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

credential_provider_configurations instance-attribute

The updated credential provider configurations for the payment connector.

description instance-attribute
description: str | None

The updated description of the payment connector.

payment_connector_id instance-attribute
payment_connector_id: Required[str]

The unique identifier of the payment connector to update.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the parent payment manager.

type instance-attribute
type: str | None

The updated type of the payment connector.

UpdatePaymentConnectorInput dataclass

Bases: _SerdeShape

Dataclass for UpdatePaymentConnectorInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

credential_provider_configurations class-attribute instance-attribute
credential_provider_configurations: list[CredentialsProviderConfiguration] | None = ...

The updated credential provider configurations for the payment connector.

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

The updated description of the payment connector.

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

The unique identifier of the payment connector to update.

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

The unique identifier of the parent payment manager.

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

The updated type of the payment connector.

Output

UpdatePaymentConnectorOutput dataclass

Bases: _SerdeShape

Dataclass for UpdatePaymentConnectorOutput 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.

credential_provider_configurations instance-attribute
credential_provider_configurations: list[CredentialsProviderConfiguration]

The credential provider configurations for the updated 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 updated payment connector.

payment_connector_id instance-attribute
payment_connector_id: str

The unique identifier of the updated payment connector.

payment_manager_id instance-attribute
payment_manager_id: str

The unique identifier of the parent payment manager.

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 updated 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 updated payment connector.