Interface PaymentInstrument.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<PaymentInstrument.Builder,,PaymentInstrument> SdkBuilder<PaymentInstrument.Builder,,PaymentInstrument> SdkPojo
- Enclosing class:
PaymentInstrument
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the instrument.The date and time, in UTC, when the instrument was registered.default PaymentInstrument.Builderdetails(Consumer<PaymentInstrumentDetails.Builder> details) The details that are specific to the instrument's payment method.details(PaymentInstrumentDetails details) The details that are specific to the instrument's payment method.paymentMethod(String paymentMethod) The payment method of the instrument.paymentMethod(PaymentMethod paymentMethod) The payment method of the instrument.The current status of the instrument.status(PaymentInstrumentStatus status) The current status of the instrument.The date and time, in UTC, when the instrument was last changed.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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.- Parameters:
arn- The Amazon Resource Name (ARN) of the instrument. To allow or denyGetPaymentInstrumentfor this instrument, use the ARN in theResourceelement of an Amazon Web Services Identity and Access Management (IAM) policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of thePaymentInstrumentDetails.Builderavoiding the need to create one manually viaPaymentInstrumentDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todetails(PaymentInstrumentDetails).- Parameters:
details- a consumer that will call methods onPaymentInstrumentDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdAt
The date and time, in UTC, when the instrument was registered.
- Parameters:
createdAt- The date and time, in UTC, when the instrument was registered.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
The date and time, in UTC, when the instrument was last changed.
- Parameters:
updatedAt- The date and time, in UTC, when the instrument was last changed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-