list_payment_instruments¶
Operation¶
list_payment_instruments
¶
list_payment_instruments(request: ListPaymentInstrumentsInput | ListPaymentInstrumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPaymentInstrumentsInputDict]) -> ListPaymentInstrumentsOutput
List payment instruments for a manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListPaymentInstrumentsInput | ListPaymentInstrumentsInputDict | 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[ListPaymentInstrumentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPaymentInstrumentsOutput
|
An instance of |
list_payment_instruments
async
¶
list_payment_instruments(request: ListPaymentInstrumentsInput | ListPaymentInstrumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPaymentInstrumentsInputDict]) -> ListPaymentInstrumentsOutput
List payment instruments for a manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListPaymentInstrumentsInput | ListPaymentInstrumentsInputDict | 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[ListPaymentInstrumentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPaymentInstrumentsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListPaymentInstrumentsInputDict
¶
Bases: TypedDict
Dictionary form of ListPaymentInstrumentsInput.
Attributes¶
agent_name
instance-attribute
¶
agent_name: str | None
The agent name associated with this request, used for observability.
max_results
instance-attribute
¶
max_results: int | None
Maximum number of results to return in a single response.
next_token
instance-attribute
¶
next_token: str | None
Token for pagination to retrieve the next set of results.
payment_connector_id
instance-attribute
¶
payment_connector_id: str | None
The ID of the payment connector to filter by.
payment_manager_arn
instance-attribute
¶
The ARN of the payment manager that owns the payment instruments.
ListPaymentInstrumentsInput
dataclass
¶
Bases: _SerdeShape
Request structure for listing payment instruments.
Attributes¶
agent_name
class-attribute
instance-attribute
¶
agent_name: str | None = ...
The agent name associated with this request, used for observability.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
Maximum number of results to return in a single response.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Token for pagination to retrieve the next set of results.
payment_connector_id
class-attribute
instance-attribute
¶
payment_connector_id: str | None = ...
The ID of the payment connector to filter by.
Output¶
ListPaymentInstrumentsOutput
dataclass
¶
Bases: _SerdeShape
Response structure for listing payment instruments.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Token for pagination to retrieve the next set of results.
payment_instruments
instance-attribute
¶
payment_instruments: list[PaymentInstrumentSummary]
List of payment instrument summaries matching the request criteria.
response_metadata
class-attribute
instance-attribute
¶
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.