Skip to content

create_payment_connector

Operation

create_payment_connector

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

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentConnectorOutput

An instance of CreatePaymentConnectorOutput.

create_payment_connector async

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

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentConnectorOutput

An instance of CreatePaymentConnectorOutput.

Input

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

CreatePaymentConnectorInputDict

Bases: TypedDict

Dictionary form of CreatePaymentConnectorInput.

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 credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

description instance-attribute
description: str | None

A description of the payment connector.

name instance-attribute
name: Required[str]

The name of the payment connector.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the payment manager to create the connector for.

provision_mode instance-attribute
provision_mode: str | None

The provision mode for creating the payment connector. If you don't specify a value, the default is MANUAL.

  • MANUAL - You provide the credential provider configurations directly.

  • QUICK_CREATE - The service orchestrates OAuth consent and provisions the credential provider for you.

type instance-attribute
type: Required[str]

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

CreatePaymentConnectorInput dataclass

Bases: _SerdeShape

Dataclass for CreatePaymentConnectorInput 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 credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

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

A description of the payment connector.

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

The name of the payment connector.

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

The unique identifier of the payment manager to create the connector for.

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

The provision mode for creating the payment connector. If you don't specify a value, the default is MANUAL.

  • MANUAL - You provide the credential provider configurations directly.

  • QUICK_CREATE - The service orchestrates OAuth consent and provisions the credential provider for you.

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

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

Output

CreatePaymentConnectorOutput dataclass

Bases: _SerdeShape

Dataclass for CreatePaymentConnectorOutput 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 created payment connector.

name instance-attribute
name: str

The name of the created payment connector.

payment_connector_id instance-attribute
payment_connector_id: str

The unique identifier of the created 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 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 created payment connector.