Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore ]

process-payment

Description

Process a payment transaction

See also: AWS API Documentation

process-payment uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  process-payment
[--user-id <value>]
[--agent-name <value>]
--payment-manager-arn <value>
--payment-session-id <value>
--payment-instrument-id <value>
--payment-type <value>
--payment-input <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--user-id (string)

The user ID associated with this payment.

--agent-name (string)

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

--payment-manager-arn (string)

The ARN of the payment manager handling this payment.

--payment-session-id (string)

The ID of the payment session for this transaction.

--payment-instrument-id (string)

The ID of the payment instrument to use for this transaction.

--payment-type (string)

The type of payment being processed.

Possible values:

• CRYPTO_X402

--payment-input (tagged union structure)

The payment input details specific to the payment type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cryptoX402.

cryptoX402 -> (structure)

X402 payment requirement input

version -> (string)

The X402 protocol version (e.g., “v1”, “v2”)

payload -> (document)

This can hold any JSON-like object

Shorthand Syntax:

cryptoX402={version=string}

JSON Syntax:

{
  "cryptoX402": {
    "version": "string",
    "payload": {...}
  }
}

--client-token (string)

Idempotency token to ensure request uniqueness.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

processPaymentId -> (string)

The unique ID of the processed payment transaction.

paymentManagerArn -> (string)

The ARN of the payment manager that processed this payment.

paymentSessionId -> (string)

The ID of the payment session for this transaction.

paymentInstrumentId -> (string)

The ID of the payment instrument used for this transaction.

paymentType -> (string)

The type of payment that was processed.

status -> (string)

The status of the payment transaction.

paymentOutput -> (tagged union structure)

The payment output details specific to the payment type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cryptoX402.

cryptoX402 -> (structure)

X402 payment requirement output

version -> (string)

The X402 protocol version (e.g., “1”, “2”)

payload -> (document)

This can hold any JSON-like object

createdAt -> (timestamp)

The timestamp when the payment was created.

updatedAt -> (timestamp)

The timestamp when the payment was last updated.