[ aws . payments ]

get-payment-instrument

Description

Retrieves a payment instrument on your account, including the details that are specific to its payment method, such as a card’s last four digits. Identify the instrument by its Amazon Resource Name (ARN) or by its ID. ListPaymentInstruments returns both.

To use this operation, you must have Amazon Web Services Identity and Access Management (IAM) permission for payments:GetPaymentInstrument . You can scope this permission to the instrument’s ARN.

See also: AWS API Documentation

Synopsis

  get-payment-instrument
--identifier <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

--identifier (string) [required]

The instrument to retrieve. Specify one of the following:

  • The Amazon Resource Name (ARN) of the instrument, as ListPaymentInstruments returns in arn . The ARN must be for an instrument on your account.
  • The ID of the instrument, as ListPaymentInstruments returns in id .

Constraints:

  • min: 1
  • max: 128
  • pattern: (arn:[a-z0-9-]+:payments::[0-9]{12}:payment-instrument:[a-z0-9-]{1,64}|[a-z0-9-]{1,64})

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

paymentInstrument -> (structure)

The payment instrument, including the details that are specific to its payment method.

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

details -> (tagged union structure)

The details that are specific to the instrument’s payment method. This member is absent for a payment method that has no additional details.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: card, usAchBankAccount, sepaBankAccount, ukBacsBankAccount, inNetBanking, cnBankRedirect, upi.

card -> (structure)

The details of a card payment instrument.

brand -> (string)

The network the card runs on.

Possible values:

  • VISA
  • MASTERCARD
  • AMEX
  • DISCOVER
  • JCB
  • RUPAY
  • CHINA_UNIONPAY

last4 -> (string) [required]

The last four digits of the card number.

Constraints:

  • min: 4
  • max: 4
  • pattern: [0-9]{4}

expirationMonth -> (integer)

The calendar month that the card expires in.

Constraints:

  • min: 1
  • max: 12

expirationYear -> (integer)

The calendar year that the card expires in.

Constraints:

  • min: 2000
  • max: 2300

cardType -> (string)

Whether the card is a credit card or a debit card.

Possible values:

  • CREDIT
  • DEBIT

issuingBank -> (string)

The bank that issued the card.

Constraints:

  • min: 1
  • max: 256

issuerCountry -> (string)

The country of the bank that issued the card.

Constraints:

  • min: 2
  • max: 2
  • pattern: [A-Z]{2}

usAchBankAccount -> (structure)

The details of a bank account that is debited over Automated Clearing House (ACH).

accountNumberTail -> (string)

The last one to four characters of the account number. This member is absent until your bank provides the account details, for example before you complete authentication with your bank.

Constraints:

  • min: 1
  • max: 4
  • pattern: [A-Za-z0-9]{1,4}

accountHolderName -> (string)

The name on the account.

Constraints:

  • min: 1
  • max: 256

bankName -> (string)

The bank holding the account.

Constraints:

  • min: 1
  • max: 256

accountType -> (string)

Whether the account is a checking account or a savings account.

Possible values:

  • CHECKING
  • SAVINGS

sepaBankAccount -> (structure)

The details of a bank account that is debited over Single Euro Payments Area (SEPA) Direct Debit.

accountNumberTail -> (string)

The last one to four characters of the account number. This member is absent until your bank provides the account details, for example before you complete authentication with your bank.

Constraints:

  • min: 1
  • max: 4
  • pattern: [A-Za-z0-9]{1,4}

accountHolderName -> (string)

The name on the account.

Constraints:

  • min: 1
  • max: 256

bankName -> (string)

The bank holding the account.

Constraints:

  • min: 1
  • max: 256

accountType -> (string)

Whether the account is a checking account or a savings account.

Possible values:

  • CHECKING
  • SAVINGS

ukBacsBankAccount -> (structure)

The details of a bank account that is debited over Bacs Direct Debit.

accountNumberTail -> (string)

The last one to four characters of the account number. This member is absent until your bank provides the account details, for example before you complete authentication with your bank.

Constraints:

  • min: 1
  • max: 4
  • pattern: [A-Za-z0-9]{1,4}

accountHolderName -> (string)

The name on the account.

Constraints:

  • min: 1
  • max: 256

bankName -> (string)

The bank holding the account.

Constraints:

  • min: 1
  • max: 256

accountType -> (string)

Whether the account is a checking account or a savings account.

Possible values:

  • CHECKING
  • SAVINGS

inNetBanking -> (structure)

The details of an India net banking instrument.

bankCode -> (string) [required]

The code of the bank that the instrument is registered with.

Constraints:

  • min: 1
  • max: 64

bankName -> (string)

The name of the bank that the instrument is registered with.

Constraints:

  • min: 1
  • max: 256

cnBankRedirect -> (structure)

The details of a China bank redirect instrument.

bankCode -> (string)

The code of the bank that the instrument is registered with. This member is present only for retail instruments.

Constraints:

  • min: 1
  • max: 64

upi -> (structure)

The details of a Unified Payments Interface (UPI) instrument.

appName -> (string)

The name of the UPI app that the instrument is registered with.

Constraints:

  • min: 1
  • max: 256

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.