Payment methods represent your customers' payment instruments and are the response returned by GetPaymentMethod.
| Name | Type | Tags | Description | Getter |
|---|---|---|---|---|
id |
String |
ReadOnly | Unique identifier for the object. | String getId() |
type |
Enum |
The type of the PaymentMethod. | String getType() | |
accountKey |
String |
A customer account key. | String getAccountKey() | |
billingDetails |
BillingDetails |
. | String getBillingDetails() | |
card |
CreditCard |
CreditCard getCard() | ||
isDefault |
Boolean |
Indicates whether this is the default payment method for a customer account. | Boolean getIsDefault() | |
mitConsentAgreementRef |
String |
Your reference for the stored credential consent agreement that you have established with your customer. | String getMitConsentAgreementRef() | |
mitNetworkTransactionId |
String |
String getMitNetworkTransactionId() | ||
mitProfileAction |
Enum |
String getMitProfileAction() | ||
mitProfileAgreementOn |
String |
String getMitProfileAgreementOn() | ||
mitProfileType |
Enum |
. | String getMitProfileType() | |
IBAN |
String |
International Bank Account Number used to create SEPA_DEBIT payment methods. | String getIBAN() | |
accountNumber |
String |
The number of the customer's bank account. Used with Direct Debit payment methods. | String getaccountNumber() | |
bankCode |
String |
The sort code or number that identifies the bank. | String getbankCode() | |
bankName |
String |
The name of the bank where the ACH payment account is held. | String getbankName() | |
branchCode |
String |
The branch code of the bank. Used with Direct Debit payment methods. | String getbranchCode() | |
businessIdentificationCode |
String |
The BIC code. Used with SEPA_DEBIT payment methods. | String getBusiness IdentificationCode() | |
identityNumber |
String |
The identity number used for bank transfer. | String getIdentityNumber() | |
accountName |
String |
The name on the Direct Debit bank account or ACH. Use this field for Direct Debit or ACH payment methods. | String getAccountName() | |
accountType |
BankAccountType |
The type of bank account associated with an ACH payment. | String getAccountType() | |
BAID |
String |
ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. | String getBAID() | |
email |
String |
Email address associated with the payment method. This is required with a PayPal Express Checkout or a PayPal Adaptive payment method. | String getEmail() | |
preapprovalKey |
String |
The PayPal preapproval key. | String getPreapprovalKey() | |
mandateId |
String |
The mandate id. | String getMandateId() | |
mandateReceivedStatus |
String |
Indicates whether the mandate has been received from the gateway. Possible values true or false. |
String getMandateReceivedStatus() | |
existingMandateStatus |
String |
Indicates whether the mandate is an existing mandate. Possible values true or false. |
String getExistingMandateStatus() | |
mandateCreationDate |
String |
The date on which the mandate was updated. | String getMandateCreationDate() | |
mandateStatus |
String |
The gateway status of the mandate. | String getMandateStatus() | |
mandateReason |
String |
The gateway mandate reason. | String getMandateReason() | |
state |
Enum |
ReadOnly | . | PaymentMethodState getState() |
customFields |
Map<String, Object> |
Custom fields. | Map<String, Object> getCustomFields() |