Class PaymentInstrument
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PaymentInstrument.Builder,PaymentInstrument>
A payment instrument on your account, such as a card or a bank account.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The Amazon Resource Name (ARN) of the instrument.static PaymentInstrument.Builderbuilder()final InstantThe date and time, in UTC, when the instrument was registered.final PaymentInstrumentDetailsdetails()The details that are specific to the instrument's payment method.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final PaymentMethodThe payment method of the instrument.final StringThe payment method of the instrument.static Class<? extends PaymentInstrument.Builder> final PaymentInstrumentStatusstatus()The current status of the instrument.final StringThe current status of the instrument.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InstantThe date and time, in UTC, when the instrument was last changed.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the instrument. To allow or deny
GetPaymentInstrumentfor this instrument, use the ARN in theResourceelement of an Amazon Web Services Identity and Access Management (IAM) policy.- Returns:
- The Amazon Resource Name (ARN) of the instrument. To allow or deny
GetPaymentInstrumentfor this instrument, use the ARN in theResourceelement of an Amazon Web Services Identity and Access Management (IAM) policy.
-
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,
paymentMethodwill returnPaymentMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentMethodAsString().- 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
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,
paymentMethodwill returnPaymentMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentMethodAsString().- 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
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.ACTIVEdoesn'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 toACTIVE. 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,
statuswill returnPaymentInstrumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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.ACTIVEdoesn'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 toACTIVE. 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
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.ACTIVEdoesn'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 toACTIVE. 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,
statuswill returnPaymentInstrumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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.ACTIVEdoesn'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 toACTIVE. 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:
-
-
details
The details that are specific to the instrument's payment method. This member is absent for a payment method that has no additional details.
- Returns:
- The details that are specific to the instrument's payment method. This member is absent for a payment method that has no additional details.
-
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
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PaymentInstrument.Builder,PaymentInstrument> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-