Skip to content

get_payment_instrument

Operation

get_payment_instrument

get_payment_instrument(request: GetPaymentInstrumentInput | GetPaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentInstrumentInputDict]) -> GetPaymentInstrumentOutput

Get a payment instrument by ID.

Parameters:

Name Type Description Default
request GetPaymentInstrumentInput | GetPaymentInstrumentInputDict | 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[GetPaymentInstrumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentInstrumentOutput

An instance of GetPaymentInstrumentOutput.

get_payment_instrument async

get_payment_instrument(request: GetPaymentInstrumentInput | GetPaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentInstrumentInputDict]) -> GetPaymentInstrumentOutput

Get a payment instrument by ID.

Parameters:

Name Type Description Default
request GetPaymentInstrumentInput | GetPaymentInstrumentInputDict | 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[GetPaymentInstrumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentInstrumentOutput

An instance of GetPaymentInstrumentOutput.

Input

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

GetPaymentInstrumentInputDict

Bases: TypedDict

Dictionary form of GetPaymentInstrumentInput.

Attributes

agent_name instance-attribute
agent_name: str | None

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

payment_connector_id instance-attribute
payment_connector_id: str | None

The ID of the payment connector.

payment_instrument_id instance-attribute
payment_instrument_id: Required[str]

The ID of the payment instrument to retrieve.

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.

GetPaymentInstrumentInput dataclass

Bases: _SerdeShape

Request structure for getting a payment instrument.

Attributes

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

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

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

The ID of the payment connector.

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

The ID of the payment instrument to retrieve.

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

GetPaymentInstrumentOutput dataclass

Bases: _SerdeShape

Response structure for getting a payment instrument.

Attributes

payment_instrument instance-attribute
payment_instrument: PaymentInstrument

The payment instrument details.

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.