Class: Recurly::Requests::BillingInfoCreate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/billing_info_create.rb

Instance Attribute Summary collapse

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#addressAddress

Returns:



11
# File 'lib/recurly/requests/billing_info_create.rb', line 11

define_attribute :address, :Address

#amazon_billing_agreement_idString

Returns Amazon billing agreement ID.

Returns:

  • (String)

    Amazon billing agreement ID



15
# File 'lib/recurly/requests/billing_info_create.rb', line 15

define_attribute :amazon_billing_agreement_id, String

#backup_payment_methodBoolean

Returns The `backup_payment_method` indicator is used to designate a billing info as a backup on the account that will be tried if the billing info marked `primary_payment_method` fails. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.

Returns:

  • (Boolean)

    The `backup_payment_method` indicator is used to designate a billing info as a backup on the account that will be tried if the billing info marked `primary_payment_method` fails. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.



19
# File 'lib/recurly/requests/billing_info_create.rb', line 19

define_attribute :backup_payment_method, :Boolean

#companyString

Returns Company name.

Returns:

  • (String)

    Company name



23
# File 'lib/recurly/requests/billing_info_create.rb', line 23

define_attribute :company, String

#cvvString

Returns *STRONGLY RECOMMENDED*.

Returns:

  • (String)

    *STRONGLY RECOMMENDED*



27
# File 'lib/recurly/requests/billing_info_create.rb', line 27

define_attribute :cvv, String

#first_nameString

Returns First name.

Returns:

  • (String)

    First name



31
# File 'lib/recurly/requests/billing_info_create.rb', line 31

define_attribute :first_name, String

#fraud_session_idString

Returns Fraud Session ID.

Returns:

  • (String)

    Fraud Session ID



35
# File 'lib/recurly/requests/billing_info_create.rb', line 35

define_attribute :fraud_session_id, String

#gateway_codeString

Returns An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.

Returns:

  • (String)

    An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.



39
# File 'lib/recurly/requests/billing_info_create.rb', line 39

define_attribute :gateway_code, String

#gateway_tokenString

Returns A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.

Returns:

  • (String)

    A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.



43
# File 'lib/recurly/requests/billing_info_create.rb', line 43

define_attribute :gateway_token, String

#ibanString

Returns The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information.

Returns:

  • (String)

    The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information



47
# File 'lib/recurly/requests/billing_info_create.rb', line 47

define_attribute :iban, String

#ip_addressString

Returns *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.

Returns:

  • (String)

    *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.



51
# File 'lib/recurly/requests/billing_info_create.rb', line 51

define_attribute :ip_address, String

#last_nameString

Returns Last name.

Returns:

  • (String)

    Last name



55
# File 'lib/recurly/requests/billing_info_create.rb', line 55

define_attribute :last_name, String

#monthString

Returns Expiration month.

Returns:

  • (String)

    Expiration month



59
# File 'lib/recurly/requests/billing_info_create.rb', line 59

define_attribute :month, String

#numberString

Returns Credit card number, spaces and dashes are accepted.

Returns:

  • (String)

    Credit card number, spaces and dashes are accepted.



63
# File 'lib/recurly/requests/billing_info_create.rb', line 63

define_attribute :number, String

#paypal_billing_agreement_idString

Returns PayPal billing agreement ID.

Returns:

  • (String)

    PayPal billing agreement ID



67
# File 'lib/recurly/requests/billing_info_create.rb', line 67

define_attribute :paypal_billing_agreement_id, String

#primary_payment_methodBoolean

Returns The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.

Returns:

  • (Boolean)

    The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.



71
# File 'lib/recurly/requests/billing_info_create.rb', line 71

define_attribute :primary_payment_method, :Boolean

#tax_identifierString

Returns Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.

Returns:

  • (String)

    Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.



75
# File 'lib/recurly/requests/billing_info_create.rb', line 75

define_attribute :tax_identifier, String

#tax_identifier_typeString

Returns this field and a value of 'cpf' are required if adding a billing info that is an elo or hipercard type in Brazil.

Returns:

  • (String)

    this field and a value of 'cpf' are required if adding a billing info that is an elo or hipercard type in Brazil.



79
# File 'lib/recurly/requests/billing_info_create.rb', line 79

define_attribute :tax_identifier_type, String

#three_d_secure_action_result_token_idString

Returns A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.

Returns:

  • (String)

    A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.



83
# File 'lib/recurly/requests/billing_info_create.rb', line 83

define_attribute :three_d_secure_action_result_token_id, String

#token_idString

Returns A token [generated by Recurly.js](developers.recurly.com/reference/recurly-js/#getting-a-token).

Returns:



87
# File 'lib/recurly/requests/billing_info_create.rb', line 87

define_attribute :token_id, String

#transaction_typeString

Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

Returns:

  • (String)

    An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.



91
# File 'lib/recurly/requests/billing_info_create.rb', line 91

define_attribute :transaction_type, String

#vat_numberString

Returns VAT number.

Returns:

  • (String)

    VAT number



95
# File 'lib/recurly/requests/billing_info_create.rb', line 95

define_attribute :vat_number, String

#yearString

Returns Expiration year.

Returns:

  • (String)

    Expiration year



99
# File 'lib/recurly/requests/billing_info_create.rb', line 99

define_attribute :year, String