create_payment_instrument¶
Operation¶
async
¶
create_payment_instrument(input: CreatePaymentInstrumentInput, plugins: list[Plugin] | None = None) -> CreatePaymentInstrumentOutput
Create a new payment instrument for a connector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePaymentInstrumentInput
|
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 |
|---|---|
CreatePaymentInstrumentOutput
|
An instance of |
Input¶
dataclass
¶
Request structure for creating a payment instrument.
Attributes¶
class-attribute
instance-attribute
¶
agent_name: str | None = None
The agent name associated with this request, used for observability.
class-attribute
instance-attribute
¶
client_token: str | None = None
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
class-attribute
instance-attribute
¶
payment_connector_id: str | None = None
The ID of the payment connector to use for this instrument.
class-attribute
instance-attribute
¶
payment_instrument_details: PaymentInstrumentDetails | None = None
The details of the payment instrument.
class-attribute
instance-attribute
¶
payment_instrument_type: PaymentInstrumentType | None = None
The type of payment instrument being created.
class-attribute
instance-attribute
¶
payment_manager_arn: str | None = None
The ARN of the payment manager that owns this payment instrument.
class-attribute
instance-attribute
¶
user_id: str | None = None
The user ID associated with this payment instrument.
Output¶
dataclass
¶
Response structure for creating a payment instrument.
Attributes¶
instance-attribute
¶
payment_instrument: PaymentInstrument
The created payment instrument.