Skip to content

get_resource_payment_token

Operation

get_resource_payment_token

get_resource_payment_token(request: GetResourcePaymentTokenInput | GetResourcePaymentTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePaymentTokenInputDict]) -> GetResourcePaymentTokenOutput

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

Parameters:

Name Type Description Default
request GetResourcePaymentTokenInput | GetResourcePaymentTokenInputDict | 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[GetResourcePaymentTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcePaymentTokenOutput

An instance of GetResourcePaymentTokenOutput.

get_resource_payment_token async

get_resource_payment_token(request: GetResourcePaymentTokenInput | GetResourcePaymentTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePaymentTokenInputDict]) -> GetResourcePaymentTokenOutput

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

Parameters:

Name Type Description Default
request GetResourcePaymentTokenInput | GetResourcePaymentTokenInputDict | 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[GetResourcePaymentTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcePaymentTokenOutput

An instance of GetResourcePaymentTokenOutput.

Input

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

GetResourcePaymentTokenInputDict

Bases: TypedDict

Dictionary form of GetResourcePaymentTokenInput.

Attributes

payment_token_request instance-attribute

Vendor-specific token request input. Contains all request parameters in a type-safe, vendor-specific structure.

resource_credential_provider_name instance-attribute
resource_credential_provider_name: Required[str]

Name of the payment credential provider to use.

workload_identity_token instance-attribute
workload_identity_token: Required[str]

Workload access token for authorization.

GetResourcePaymentTokenInput dataclass

Bases: _SerdeShape

Dataclass for GetResourcePaymentTokenInput structure.

Attributes

payment_token_request class-attribute instance-attribute
payment_token_request: PaymentTokenRequestInput | None = ...

Vendor-specific token request input. Contains all request parameters in a type-safe, vendor-specific structure.

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

Name of the payment credential provider to use.

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

Workload access token for authorization.

Output

GetResourcePaymentTokenOutput dataclass

Bases: _SerdeShape

Dataclass for GetResourcePaymentTokenOutput structure.

Attributes

payment_token_response instance-attribute
payment_token_response: PaymentTokenResponseOutput

Vendor-specific token response output. Contains all response data in a type-safe, vendor-specific structure.

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.