PaymentRequestPaymentMethod class abstract

The type and required details of a payment method to use.

Properties:

  • accountHolderType - The account holder type (personal or business).
  • bankAccountNumber - The bank account number (without separators).
  • bankAccountType - The bank account type (checking, savings...).
  • bankLocationId - The bank routing number of the account.
  • checkoutAttemptId - The checkout attempt identifier.
  • encryptedBankAccountNumber - Encrypted bank account number. The bank account number (without separators).
  • encryptedBankLocationId - Encrypted location id. The bank routing number of the account. The field value is nil in most cases.
  • ownerName - The name of the bank account holder.
  • recurringDetailReference - This is the recurringDetailReference returned in the response when you created the token.
  • sdkData - Base64-encoded JSON object containing SDK related parameters required by the SDK
  • storedPaymentMethodId - This is the recurringDetailReference returned in the response when you created the token.
  • transferInstrumentId - The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts.
  • type - ach
  • billingAddress - The address where to send the invoice.
  • deliveryAddress - The address where the goods should be delivered.
  • personalDetails - Shopper name, date of birth, phone number, and email address.
  • amazonPayToken - This is the amazonPayToken that you obtained from the Get Checkout Session response. This token is used for API only integration specifically.
  • checkoutSessionId - The checkoutSessionId is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.
  • beneficiaryId - ANCV account identification (email or account number)
  • applePayToken - The stringified and base64 encoded paymentData you retrieved from the Apple framework.
  • fundingSource - The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to debit.
  • holderName - The name of the card holder.
  • issuer - The PayByBank issuer value of the shopper's selected bank.
  • blikCode - BLIK code consisting of 6 digits.
  • billingSequenceNumber - The sequence number for the debit. For example, send 2 if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
  • brand - Secondary brand of the card. For example: plastix, hmclub.
  • cupsecureplusPeriodSmscode
  • cvc - The card verification code. Only collect raw card data if you are fully PCI compliant.
  • encryptedCard - Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
  • encryptedCardNumber - The encrypted card number.
  • encryptedExpiryMonth - The encrypted card expiry month.
  • encryptedExpiryYear - The encrypted card expiry year.
  • encryptedPassword - This field contains an encrypted, one-time password or an authentication code provided by the cardholder.
  • encryptedSecurityCode - The encrypted card verification code.
  • expiryMonth - The card expiry month. Only collect raw card data if you are fully PCI compliant.
  • expiryYear - The card expiry year. Only collect raw card data if you are fully PCI compliant.
  • fastlaneData - The encoded fastlane data blob
  • networkPaymentReference - The transaction identifier from card schemes. This is the networkTxReference from the response to the first payment.
  • number - The card number. Only collect raw card data if you are fully PCI compliant.
  • shopperNotificationReference - The shopperNotificationReference returned in the response when you requested to notify the shopper. Used for recurring payment only.
  • srcCorrelationId - An identifier used for the Click to Pay transaction.
  • srcDigitalCardId - The SRC reference for the Click to Pay token.
  • srcScheme - The scheme that is being used for Click to Pay.
  • srcTokenReference - The reference for the Click to Pay token.
  • threeDS2SdkVersion - Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
  • cashtag - Cash App issued cashtag for recurring payment
  • customerId - Cash App issued customerId for recurring payment
  • grantId - Cash App issued grantId for one time payment
  • onFileGrantId - Cash App issued onFileGrantId for recurring payment
  • requestId - Cash App request id
  • subtype - The type of flow to initiate.
  • firstName - The shopper's first name.
  • lastName - The shopper's last name.
  • shopperEmail -
  • telephoneNumber -
  • bankCode - The financial institution code.
  • googlePayCardNetwork - The selected payment card network.
  • googlePayToken - The token that you obtained from the Google Pay API PaymentData response.
  • masterpassTransactionId - The Masterpass transaction ID.
  • orderID - The unique ID associated with the order.
  • payeePreferred - IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED
  • payerID - The unique ID associated with the payer.
  • payerSelected - PAYPAL or PAYPAL_CREDIT
  • shopperAccountIdentifier - The shopper's banking details or payId reference, used to complete payment.
  • virtualPaymentAddress - The virtual payment address for UPI.
  • pixRecurring
  • bank - The shopper's bank.
  • clientType - The client type.
  • identification - The identification code.
  • identificationType - The identification type.
  • deviceFingerprint - A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
  • iban - The International Bank Account Number (IBAN).
  • samsungPayToken - The payload you received from the Samsung Pay SDK response.
  • dueDate - The date that the the shopper's bank account is charged.
  • appId
  • visaCheckoutCallId - The Visa Click to Pay Call ID value. When your shopper selects a payment and/or a shipping address from Visa Click to Pay, you will receive a Visa Click to Pay Call ID.
  • openid
  • clickAndCollect - Set this to true if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.
Annotations
  • @BuiltValue.new()

Constructors

PaymentRequestPaymentMethod([void updates(PaymentRequestPaymentMethodBuilder b)])
factory

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentRequestPaymentMethodBuilder)) → PaymentRequestPaymentMethod
Rebuilds the instance.
inherited
toBuilder() → PaymentRequestPaymentMethodBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PaymentRequestPaymentMethod>
no setter