Class PaymentInstrumentSummary

java.lang.Object
software.amazon.awssdk.services.payments.model.PaymentInstrumentSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PaymentInstrumentSummary.Builder,PaymentInstrumentSummary>

@Generated("software.amazon.awssdk:codegen") public final class PaymentInstrumentSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PaymentInstrumentSummary.Builder,PaymentInstrumentSummary>

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.

See Also:
  • Method Details

    • id

      public final String id()

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

      Returns:
      The ID of the instrument, unique within your account. It's the last segment of the instrument's ARN.
    • arn

      public final String arn()

      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.

      Returns:
      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.
    • paymentMethod

      public final PaymentMethod paymentMethod()

      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.

      If the service returns an enum value that is not available in the current SDK version, paymentMethod will return PaymentMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentMethodAsString().

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

      See Also:
    • paymentMethodAsString

      public final String paymentMethodAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, paymentMethod will return PaymentMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentMethodAsString().

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

      See Also:
    • status

      public final PaymentInstrumentStatus status()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return PaymentInstrumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:
    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return PaymentInstrumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:
    • createdAt

      public final Instant createdAt()

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

      Returns:
      The date and time, in UTC, when the instrument was registered.
    • updatedAt

      public final Instant updatedAt()

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

      Returns:
      The date and time, in UTC, when the instrument was last changed.
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PaymentInstrumentSummary.Builder,PaymentInstrumentSummary>
      Returns:
      a builder for type T
    • builder

      public static PaymentInstrumentSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends PaymentInstrumentSummary.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.