> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PaymentMethod Data Members

The following table lists and describes the data members of the `PaymentMethod` object.

| Data Member | Data Type | Description |
| - | - | - |
| `accountHolderName` | string | The name of the account holder. |
| `active` | Boolean | A Boolean flag that, if set to `true`, causes Subscribe to include this `PaymentMethod` object in the list of payment methods for the associated `Account` object, if any. |
| `amazon` | `Amazon` | A subobject that specifies the details of an Amazon payment. You must populate this attribute if you set the type attribute (described later in this table) to `Amazon`. See the [Amazon Subobject](Amazon_Subobject) |
| `applePay` | `ApplePay` | A subobject that specifies the details of payment accepted via ApplePay.You must specify this attribute if you set the type attribute to `ApplePay.` See the [ApplePay Subobject](ApplePay_Subobject). |
| `billingAddress` | `Address` | The customer’s billing address for this payment method only. This field is required if this payment method refers to a credit card and you want to conduct address-verification operations through AVS while validating the payment method. See the [The Address Object](The_Address_Object). |
| `boleto` | `Boleto` | A subobject that specifies the details of a Boleto Bancário payment in Latin America. You must populate this attribute if you set the `type` attribute to `Boleto`. See the [Boleto Subobject](Boleto_Subobject). |
| `carrierBilling` | `CarrierBilling` | A subobject that specifies the details of a Carrier Billing Payment Method. You must populate this data member if you set the `type` attribute to `CarrierBilling`. See the [CarrierBilling Subobject](CarrierBilling_Subobject). |
| `creditCard` | `CreditCard` | A subobject that specifies the details of a credit card. You must populate this attribute if you set the type attribute to `CreditCard`. See the [CreditCard Subobject](CreditCard_Subobject). |
| `currency` | string | The ISO 4217 currency code (see [www.xe.com/iso4217.htm\\](http://www.xe.com/iso4217.htm\\)) to use for validating this payment method. The default is USD. Often, Subscribe validates a payment method by only authorizing a transaction that uses the method for a small amount of this currency. If this `PaymentMethod` object represents an EDD payment (that is, the type is set to `DirectDebit`), the currency must be one of the EDD-supported currencies, such as EUR for Euro. Subscribe uses this currency while validating the payment method. |
| `customerDescription` | string | **Optional.** The customer’s description for this payment method. |
| `customerSpecifiedType` | string | A customer-specified arbitrary string that describes the payment method type. This field is optional for most credit cards, but required for the following card types, which must be specified exactly as listed: - Switch - Solo - Dankort - Laser, and - CarteBleue. |
| `directDebit` | `DirectDebit` | A subobject that contains the details of the EDD payment. You must specify this attribute if you set the type attribute to `DirectDebit`. See the [DirectDebit Subobject](DirectDebit_Subobject). |
| `ecp` | `ECP` | A subobject that specifies the details of an electronic-check payment. You must populate this attribute if you set the `type` attribute to `ECP`. See the [ECP Subobject](ECP_Subobject). |
| `extendedVerification` | `ExtendedVerification` | Data needed to enable extended verification systems, such as 3D Secure. See the [ExtendedVerification Subobject](ExtendedVerification_Sub). |
| `externalbilling` | `ExternalBilling` | A subobject that specifies the details of an external billing system.You must specify this attribute if you set the type attribute to `ExternalBilling`. See the [ExternalBilling Subobject](ExternalBilling_Subobjec). |
| `externalToken` | string | The `externalToken` data member accepts and stores the externally provided token or identifier for payment methods, usually credit cards that use an external abstraction vendor like a card or network token. Support is limited to certain payment processors and method types (for example, Edgil and Credit Card). When set, the value passed is used to represent this `paymentMethod` when presenting to your processor or gateway. |
| `googlePay` | `GooglePay` | Details of payment accepted via GooglePay. See the [GooglePay Subobject](GooglePay_Subobject). |
| `hostedPage` | `HostedPage` | A subobject that contains the details of a payment accepted or applied using payment provider billing pages. **Note:** Your customer’s Account must exist before any Hosted Page related call references that Account. See the [HostedPage Subobject](HostedPage_Subobject). |
| `merchantAcceptedPayment` | `MerchantAcceptedPayment` | A subobject that specifies the merchant's (optional) unique ID for this payment method. This is a free-form, unique string of 1024 or fewer bytes. See the [MerchantAcceptedPayment Subobject](MerchantAcceptedPayment_). |
| `merchantPaymentMethodId` | string | Your unique identifier for this `PaymentMethod` object. Once you’ve created this object, you may refer to it with this identifier. **Note:** use of the forward slash character (/) in merchant identifiers is not allowed. See [Merchant Identifiers](Merchant_Identifiers) for more information. |
| `militaryStar` | `MilitaryStar` | A subobject that specifies the details of a Military Star card. You must specify this attribute if you set the type attribute to `MilitaryStar.` See the [MilitaryStar Subobject](MilitaryStar_Subobject). |
| `nameValues` | `NameValuePair[]` | **Optional.** An array of name–value pairs that provides additional information on the `PaymentMethod` object, as follows: A name–value pair with the Name: `CVN`. The value for `CVN` is the security code on a credit card (the CVV2 code for Visa or the CVC code for MasterCard), for example, **111**. This name–value pair is requiredif you want to run security code checks, such as CVV checks for Visa, on credit cards. A name–value pair with Name: `issueNumber`. The value for `issueNumber` is the issue number on the customer’s Switch or Solo card. A name–value pair with Name: `startDate`. The value for `startDate` is the start date on a customer’s Switch or Solo credit card with a date format of MMYY. See [The NameValuePair Object](The_NameValuePair_Object). |
| `paypal` | `PayPal` | A subobject that specifies the details of a PayPal payment. You must populate this attribute if you set the `type` attribute to `PayPal`. See the [PayPal Subobject](PayPal_Subobject). |
| `skrill` | `Skrill` | The Skrill account details for a PaymentMethod of type Skrill. See the [Skrill Subobject](Skrill_Subobject). |
| `sortOrder` | integer | The index into the `paymentMethods` array at which the `PaymentMethod` object is to be inserted if this object is associated with an `Account` object. (See the `Account` object’s `paymentMethods` data member in [Account Data Members](Account_Data_Members)). When a new payment method is added, Subscribe adds it to the beginning of the array, making it the default Payment Method for the Account. |
| `token` | `Token` | An object that specifies the details of a token-based payment. You must populate this attribute if you set the type attribute to `Token`. See [Token Data Members](Token_Data_Members). |
| `type` | `PaymentMethodType` | **Required.** A string of the Subscribe enumerated data type that defines the type of this payment method. Depending on this string, you must also populate the corresponding subobject in the appropriate attribute. For example, if you set the value of this data member to `CreditCard`, populate the `CreditCard` data member with a `CreditCard` object that contains the card details. See the [PaymentMethodType Subobject](PaymentMethodType_Subobj). |
| `VID` | string | Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new `PaymentMethod` object, leave this field blank; it will be automatically populated by Subscribe. |
| **Parent topic:**[The PaymentMethod Object](../topics/The_PaymentMethod_Object) | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.