Skip to content

list_payment_managers

Operation

list_payment_managers

list_payment_managers(request: ListPaymentManagersInput | ListPaymentManagersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPaymentManagersInputDict]) -> ListPaymentManagersOutput

Lists all payment managers in the account.

Parameters:

Name Type Description Default
request ListPaymentManagersInput | ListPaymentManagersInputDict | 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[ListPaymentManagersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPaymentManagersOutput

An instance of ListPaymentManagersOutput.

list_payment_managers async

list_payment_managers(request: ListPaymentManagersInput | ListPaymentManagersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPaymentManagersInputDict]) -> ListPaymentManagersOutput

Lists all payment managers in the account.

Parameters:

Name Type Description Default
request ListPaymentManagersInput | ListPaymentManagersInputDict | 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[ListPaymentManagersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPaymentManagersOutput

An instance of ListPaymentManagersOutput.

Input

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

ListPaymentManagersInputDict

Bases: TypedDict

Dictionary form of ListPaymentManagersInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

ListPaymentManagersInput dataclass

Bases: _SerdeShape

Dataclass for ListPaymentManagersInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListPaymentManagersOutput dataclass

Bases: _SerdeShape

Dataclass for ListPaymentManagersOutput structure.

Attributes

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

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

payment_managers instance-attribute
payment_managers: list[PaymentManagerSummary]

The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.

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.