create_payment_connector¶
Operation¶
async
¶
create_payment_connector(input: CreatePaymentConnectorInput, plugins: list[Plugin] | None = None) -> CreatePaymentConnectorOutput
Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePaymentConnectorInput
|
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 |
|---|---|
CreatePaymentConnectorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreatePaymentConnectorInput 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 credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.
class-attribute
instance-attribute
¶
description: str | None = None
A description of the payment connector.
class-attribute
instance-attribute
¶
name: str | None = None
The name of the payment connector.
class-attribute
instance-attribute
¶
payment_manager_id: str | None = None
The unique identifier of the payment manager to create the connector for.
class-attribute
instance-attribute
¶
type: PaymentConnectorType | None = None
The type of payment connector, which determines the payment provider integration.
Output¶
dataclass
¶
Dataclass for CreatePaymentConnectorOutput 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 created payment connector.
instance-attribute
¶
payment_connector_id: str
The unique identifier of the created 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 payment connector. Possible values include
CREATING, READY, UPDATING, DELETING, CREATE_FAILED,
UPDATE_FAILED, and DELETE_FAILED.