<a id="cli-aws-payments-list-payment-instruments"></a>

# list-payment-instruments

## Description

Lists the payment instruments on your account. This operation returns summaries. To get the details that are specific to an instrument’s payment method, use `GetPaymentInstrument` . Results are paginated. Use `nextToken` to retrieve more results.

To use this operation, you must have Amazon Web Services Identity and Access Management (IAM) permission for `payments:ListPaymentInstruments` .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/payments-2026-09-23/ListPaymentInstruments)

`list-payment-instruments` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `paymentInstrumentSummaries`

## Synopsis

```
  list-payment-instruments
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--help]
```

## Options

`--starting-token` (string)

> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--page-size` (integer)

> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `25`

`--max-items` (integer)

> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

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

`--help` (boolean)

Display help for the command/subcommand.

## Output

paymentInstrumentSummaries -> (list)

> The payment instruments on your account, one summary for each instrument. This list is empty when your account has no payment instruments.

> Constraints:

> * min: `0`
> * max: `25`

> (structure)

> > A payment instrument as it appears in `ListPaymentInstruments` . Call `GetPaymentInstrument` for the full instrument, including the details specific to its payment method such as a card’s last four digits and expiration.

> > id -> (string) [required]

> > > The ID of the instrument, unique within your account. It’s the last segment of the instrument’s ARN.

> > > Constraints:

> > > * min: `1`
> > > * max: `64`
> > > * pattern: `[a-z0-9-]+`

> > arn -> (string) [required]

> > > The Amazon Resource Name (ARN) of the instrument. To allow or deny `GetPaymentInstrument` for this instrument, use the ARN in the `Resource` element of an Amazon Web Services Identity and Access Management (IAM) policy.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`
> > > * pattern: `arn:[a-z0-9-]+:payments::[0-9]{12}:payment-instrument:[a-z0-9-]+`

> > paymentMethod -> (string) [required]

> > > The payment method of the instrument. The following values are valid:

> > > * `CARD` – A credit or debit card.
> > > * `US_ACH_BANK_ACCOUNT` – A US bank account debited over Automated Clearing House (ACH).
> > > * `SEPA_BANK_ACCOUNT` – A bank account debited over Single Euro Payments Area (SEPA) Direct Debit.
> > > * `UK_BACS_BANK_ACCOUNT` – A UK bank account debited over Bacs Direct Debit.
> > > * `IN_NET_BANKING` – India net banking. You authorize each payment on your bank’s website.
> > > * `CN_BANK_REDIRECT` – China bank redirect. You authorize each payment on your bank’s website.
> > > * `UPI` – Unified Payments Interface, the India real-time payment system.
> > > * `PIX` – Pix, the Brazilian Central Bank instant payment system.
> > > * `PAY_BY_INVOICE` – Pay by invoice. You pay each invoice yourself, for example by bank transfer, instead of Amazon Web Services collecting payment from a card or a bank account.

> > > Possible values:

> > > * `CARD`
> > > * `US_ACH_BANK_ACCOUNT`
> > > * `SEPA_BANK_ACCOUNT`
> > > * `UK_BACS_BANK_ACCOUNT`
> > > * `IN_NET_BANKING`
> > > * `CN_BANK_REDIRECT`
> > > * `UPI`
> > > * `PIX`
> > > * `PAY_BY_INVOICE`

> > status -> (string) [required]

> > > The current status of the instrument. The following values are valid:

> > > * `ACTIVE` – The instrument is set up, and Amazon Web Services can use it for payments. `ACTIVE` doesn’t confirm that the instrument is verified or that a payment with it will succeed. You don’t need to take action.
> > > * `INVALID` – Amazon Web Services can’t use the instrument for payments, for example because its Direct Debit or UPI mandate is no longer valid. This status is permanent. The instrument doesn’t return to `ACTIVE` . To pay with this payment method again, add a new payment instrument.
> > > * `PENDING_SETUP` – The instrument needs an action from you before Amazon Web Services can use it, such as resuming a paused UPI mandate in your UPI app. Amazon Web Services doesn’t use the instrument for payments until you complete that action.
> > > * `SETUP_IN_PROGRESS` – You completed the setup steps, and setup of the instrument is in progress, for example while a Direct Debit or UPI mandate waits for confirmation. Amazon Web Services doesn’t use the instrument for payments until setup is complete. You don’t need to take action.

> > > Possible values:

> > > * `ACTIVE`
> > > * `PENDING_SETUP`
> > > * `SETUP_IN_PROGRESS`
> > > * `INVALID`

> > createdAt -> (timestamp)

> > > The date and time, in UTC, when the instrument was registered.

> > updatedAt -> (timestamp)

> > > The date and time, in UTC, when the instrument was last changed.

nextToken -> (string)

> The pagination token that indicates the next set of results to retrieve. This value is absent when there are no more results.

> Constraints:

> * min: `1`
> * max: `2048`
