The Payment Method Object - Vindicia Subscribe — SaaS Knowledge Center

Attributes

Name	Type	Description
object	string	Value is “PaymentMethod”
id	string	A merchant-specified unique identifier. Optionally, this object can be identified by its vid.
vid	string	A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe.
created	datetime	The date/time the object was created.
type	enum	Values can be: - `Amazon` - `ApplePay` - `Boleto` - `CarrierBilling` - `CreditCard` - `DirectDebit` - `ECP` - `ExternalBilling` - `HostedPage` - `MerchantAcceptedPayment` - `PayPal` - `Skrill` - `Token` - `Venmo`
linked_subscription	boolean	Indicates whether the payment method is used in a subscription. if true, the payment method is used by a subscription. Note: The Subscribe Merchant Portal 2.0 does not allow you to remove a Payment Method from an account if there are subscriptions using that Payment Method.
credit_card	Credit Card	Credit Card details.
ecp	ECP	ACH (aka ECP) details.
direct_debit	Direct Debit	Direct Debit details (vary by country/system)
paypal	PayPal	PayPal Express Checkout account details.
Braintree PayPal Attributes	Braintree PayPal account details.
amazon	Amazon	Amazon Payments account details.
skrill	Skrill	Skrill digital wallet details.
boleto	Boleto	Boleto Bancario details.
hosted_page	Hosted Page	Externally Hosted Payment Page details.
token	Token	Token (payment method) details.
merchant_accepted_payment	Merchant Accepted Payment	Pay By Invoice details.
carrier_billing	Carrier Billing	Telco carrier billing details.
external_billing	External Billing	External Billing details.
apple_pay	ApplePay	Apple Pay details.
google_pay	Google Pay	Google Pay details.
military_star	Military Star Attributes	Military Star details.
venmo	Venmo Attributes	Venmo details
metadata	hash	A set of key/value pairs that you can attach to an object. Useful for storing additional information.
account_holder	string	Name of the account holder.
billing_address	Address	The official billing address associated with this payment method.
customer_specified_type	string	Optional merchant- or customer-specified type description.
customer_description	string	Optional merchant- or customer-specified card (method) description.
currency	string	An ISO 4217 Currency Code.
primary	boolean	Primary/default payment method for the account.
active	boolean	Active and available for use.
validation_status	Transaction Status	Transaction status of Transaction used to validate this payment method.
external_token	string	Token value identifying a tokenized payment method used. Relevant for different payment methods such as tokenized credit cards, PayPal, or Venmo.
policy	hash	The policy object governing Payment Method behavior.
policy: enable_3ds	boolean	Enable the 3DS payment standard for strong customer authentication. A merchant configuration serves as a higher level indication whether 3DS is used by the merchant. When available for use, you can enable the 3DS flow per subscription, transaction, or payment method.
policy: min_chargeback_probability	integer	If Chargeback Probability from risk scoring is greater than this, the transaction will fail. Default is 100.
policy: ignore_cvn_policy	boolean	Indicates whether to evaluate any custom or default CVN (card security code) policy.
policy: ignore_avs_policy	boolean	Indicates whether to evaluate any custom or default AVS (card Address Verification Service) policy.
policy: validate	boolean	Enable to validate the `PaymentMethod` object first before creating or updating. If validation fails, the `PaymentMethod` is not updated.
policy: source_ip	string	The customer IP address from which the customer specified details for this payment method. It must be specified if you want Subscribe to evaluate risk score for this payment method.

Example Object

{
    "object": "PaymentMethod",
    "id": "paym_1235",
    "vid": "97b0915f6e65614462fdee6ffbc8385f3308188f",
    "created": "2020-05-24T17:41:29-07:00",
    "type": "CreditCard",
    "credit_card": {
        "object": "CreditCard",
        "vid": "0f0c86caef22b95b80f430cd4f8fc2df52a03f97",
        "account": "422277XXXXXX9507",
        "bin": "422277",
        "last_digits": "9507",
        "account_length": 16,
        "expiration_date": "201805"
        },
    "account_holder": "Sally W. Brown",
    "billing_address": {
        "object": "Address",
        "vid": "2eec375cdf13cd4998346796995099146448a651",
        "name": "Sally Brown",
        "line1": "123 Main Street",
        "city": "San Francisco",
        "district": "CA",
        "postal_code": "94105",
        "country": "US",
        "phone": "415-555-3212"
        },
    "customer_specified_type": "VI",
    "primary": true,
    "active": true
}

Parent topic:Payment Methods