process-payment¶

Description¶

Process a payment transaction

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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--user-id (string)

The user ID associated with this payment.

Constraints:

min: 0

max: 120

--agent-name (string)

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

Constraints:

min: 0

max: 256

--payment-manager-arn (string) [required]

The ARN of the payment manager handling this payment.

Constraints:

min: 66

max: 2048

pattern: arn:(aws|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}

--payment-session-id (string) [required]

The ID of the payment session for this transaction.

Constraints:

min: 31

max: 31

pattern: payment-session-[0-9a-zA-Z-]{15}

--payment-instrument-id (string) [required]

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

Constraints:

min: 34

max: 34

pattern: payment-instrument-[0-9a-zA-Z-]{15}

--payment-type (string) [required]

The type of payment being processed.

Possible values:

CRYPTO_X402

--payment-input (tagged union structure) [required]

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) [required]

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

payload -> (document) [required]

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.

Constraints:

min: 33

max: 256

pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

processPaymentId -> (string)

The unique ID of the processed payment transaction.

Constraints:

min: 36

max: 36

pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

paymentManagerArn -> (string)

The ARN of the payment manager that processed this payment.

Constraints:

min: 66

max: 2048

pattern: arn:(aws|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}

paymentSessionId -> (string)

The ID of the payment session for this transaction.

Constraints:

min: 31

max: 31

pattern: payment-session-[0-9a-zA-Z-]{15}

paymentInstrumentId -> (string)

The ID of the payment instrument used for this transaction.

Constraints:

min: 34

max: 34

pattern: payment-instrument-[0-9a-zA-Z-]{15}

paymentType -> (string)

The type of payment that was processed.

Possible values:

CRYPTO_X402

status -> (string)

The status of the payment transaction.

Possible values:

PROOF_GENERATED

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) [required]

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

payload -> (document) [required]

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.

Table of Contents

Feedback

User Guide

process-payment¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note