Skip to content

create_payment_instrument

Operation

create_payment_instrument

create_payment_instrument(request: CreatePaymentInstrumentInput | CreatePaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePaymentInstrumentInputDict]) -> CreatePaymentInstrumentOutput

Create a new payment instrument for a connector.

Parameters:

Name Type Description Default
request CreatePaymentInstrumentInput | CreatePaymentInstrumentInputDict | 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[CreatePaymentInstrumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentInstrumentOutput

An instance of CreatePaymentInstrumentOutput.

create_payment_instrument async

create_payment_instrument(request: CreatePaymentInstrumentInput | CreatePaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePaymentInstrumentInputDict]) -> CreatePaymentInstrumentOutput

Create a new payment instrument for a connector.

Parameters:

Name Type Description Default
request CreatePaymentInstrumentInput | CreatePaymentInstrumentInputDict | 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[CreatePaymentInstrumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentInstrumentOutput

An instance of CreatePaymentInstrumentOutput.

Input

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

CreatePaymentInstrumentInputDict

Bases: TypedDict

Dictionary form of CreatePaymentInstrumentInput.

Attributes

agent_name instance-attribute
agent_name: str | None

The agent name associated with this request, used for observability.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

payment_connector_id instance-attribute
payment_connector_id: Required[str]

The ID of the payment connector to use for this instrument.

payment_instrument_details instance-attribute

The details of the payment instrument.

payment_instrument_type instance-attribute
payment_instrument_type: Required[str]

The type of payment instrument being created.

payment_manager_arn instance-attribute
payment_manager_arn: Required[str]

The ARN of the payment manager that owns this payment instrument.

user_id instance-attribute
user_id: str | None

The user ID associated with this payment instrument.

CreatePaymentInstrumentInput dataclass

Bases: _SerdeShape

Request structure for creating a payment instrument.

Attributes

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

The agent name associated with this request, used for observability.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

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

The ID of the payment connector to use for this instrument.

payment_instrument_details class-attribute instance-attribute
payment_instrument_details: PaymentInstrumentDetails | None = ...

The details of the payment instrument.

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

The type of payment instrument being created.

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

The ARN of the payment manager that owns this payment instrument.

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

The user ID associated with this payment instrument.

Output

CreatePaymentInstrumentOutput dataclass

Bases: _SerdeShape

Response structure for creating a payment instrument.

Attributes

payment_instrument instance-attribute
payment_instrument: PaymentInstrument

The created payment instrument.

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.