AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock AgentCore Data Plane Fronting Layer ProcessPayment API operation.

Syntax

Invoke-BACPayment
-AgentName <String>
-PaymentInput_Mpp_BuyerPaysGasFee <Boolean>
-PaymentInput_CryptoX402_Payload <PSObject>
-PaymentInstrumentId <String>
-PaymentManagerArn <String>
-PaymentSessionId <String>
-PaymentType <PaymentType>
-PaymentInput_CryptoX402_Permit2AllowanceLimit <String>
-UserId <String>
-PaymentInput_CryptoX402_Version <String>
-PaymentInput_Mpp_Version <String>
-PaymentInput_Mpp_WwwAuthenticateHeader <String[]>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentCoreConfig>

Description

Processes a payment using a payment instrument within a payment session.

Parameters

-AgentName <String>
The agent name associated with this request, used for observability.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
Amazon.PowerShell.Cmdlets.BAC.AmazonBedrockAgentCoreClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentInput_CryptoX402_Payload <PSObject>
The X402 payment payload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentInput_CryptoX402_Permit2AllowanceLimit <String>
The maximum on-chain Permit2 allowance to grant before signing the payment authorization, in the asset's smallest denomination. This field is valid only for the upto (metered) scheme; supplying it for the exact scheme returns a validation error.When set, the service approves an ERC-20 allowance for this amount before processing the payment. The approval sets, rather than adds to, the wallet's allowance. Set this field only when the wallet needs approving, for example on its first upto payment, to avoid a redundant on-chain transaction. Omit the field to skip allowance handling. This is the default, and the only behavior for the exact scheme.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentInput_CryptoX402_Version <String>
The version of the X402 protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentInput_Mpp_BuyerPaysGasFee <Boolean>
Authorizes the service to sign a payment whose blockchain network (gas) fees are charged to your wallet, on top of the payment amount.The challenge indicates who sponsors the network fees. When the challenge does not sponsor them, the service signs the payment only if this field is true. Otherwise it returns a validation error, so you can decide whether to pay the fees or obtain a challenge that sponsors them.Optional. When omitted or false, you decline to pay network fees. This field has no effect on challenges that already sponsor the fees.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentInput_Mpp_BuyerPaysGasFees
-PaymentInput_Mpp_Version <String>
The MPP protocol version, for example "1" or "2".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentInput_Mpp_WwwAuthenticateHeader <String[]>
The raw WWW-Authenticate: Payment header value from the 402 response, passed verbatim. Provide exactly one entry. The service uses this value to generate the payment credential. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPaymentInput_Mpp_WwwAuthenticateHeaders
-PaymentInstrumentId <String>
The ID of the payment instrument to use.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentManagerArn <String>
The ARN of the payment manager.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentSessionId <String>
The ID of the payment session.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaymentType <PaymentType>
The type of payment to process.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentCore.Model.ProcessPaymentResponse). Specifying the name of a property of type Amazon.BedrockAgentCore.Model.ProcessPaymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserId <String>
The user ID associated with this payment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.BedrockAgentCore.Model.ProcessPaymentResponse object containing multiple properties.

Supported Version

AWS Tools for PowerShell: 2.x.y.z