PaymentMethod.md

Bfwd::PaymentMethod

Properties

Name	Type	Description	Notes
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
id	String	{ "description" : "ID of the payment-method.", "verbs":["GET"] }	[optional]
crm_id	String	{ "description" : "CRM ID of the product-rate-plan.", "verbs":] }	[optional]
account_id	String	{ "description" : "ID of the account associated with the payment-method.", "verbs":["POST","GET"] }
organization_id	String		[optional]
name	String	{ "description" : "Name of the payment-method.", "verbs":["POST","PUT","GET"] }
description	String	{ "description" : "Description of the payment-method.", "verbs":["POST","PUT","GET"] }	[optional]
card_holder_name	String	{ "description" : "Name of the card holder", "verbs":["POST","PUT","GET"] }	[optional]
expiry_date	String	{ "description" : "In the case of card payment methods this is the expiry date of the card, format should be MMYY including leading 0's. For example 0115 for January 2015.", "verbs":["POST","GET"] }
card_type	String	{ "description" : "Type of the card. In the case of card payment methods this is the payment type, for example VISA, MasterCard.", "verbs":["POST","GET"] }	[optional]
country	String		[optional]
province	String		[optional]
first_six	String		[optional]
last_four	String		[optional]
expiry_year	Integer		[optional]
expiry_month	Integer		[optional]
link_id	String
gateway	String	{ "description" : "Gateway type for payment-method.", "verbs":["POST","GET"] }
ip_address	String	{"description":"IP address associated with this payment method.","verbs":["POST","PUT","GET"]}	[optional]
ip_address_country	String	{"description":"Country of the IP address associated with this payment method.","verbs":["POST","PUT","GET"]}	[optional]
state	String	{ "description" : "State of the payment-method.", "verbs":["POST","GET"] }
deleted	BOOLEAN	{"default" : "false", "description" : "Indicates if a payment-method has been retired. If a payment-method has been retired it can still be retrieved using the appropriate flag on API requests. Generally payment-methods will be retired by customers wanting to remove the payment method from their account. Caution should be used when requested deleted payment methods.", "verbs":["GET"] }	[optional] [default to false]
default_payment_method	BOOLEAN	{"default" : "false", "description" : "Indicates if this is the default payment method for the account.", "verbs":["GET","POST","PUT"] }	[optional] [default to false]