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

#account_number ⇒ String

Returns The bank account number. (ACH, Bacs only).

Returns:

  • (String) —

    The bank account number. (ACH, Bacs only)



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

define_attribute :account_number, String

#account_type ⇒ String

Returns The bank account type. (ACH only).

Returns:

  • (String) —

    The bank account type. (ACH only)



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

define_attribute :account_type, String

#address ⇒ Address

Returns:



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

define_attribute :address, :Address

#adyen_risk_profile_reference_id ⇒ String

Returns The Adyen Risk Profile Reference ID is used to identify the risk profile for the payment method.

Returns:

  • (String) —

    The Adyen Risk Profile Reference ID is used to identify the risk profile for the payment method.



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

define_attribute :adyen_risk_profile_reference_id, String

#amazon_billing_agreement_id ⇒ String

Returns Only supported on Amazon V1. For Amazon V2, use token_id with Recurly.js.

Returns:

  • (String) —

    Only supported on Amazon V1. For Amazon V2, use token_id with Recurly.js.



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

define_attribute :amazon_billing_agreement_id, String

#authentication_method ⇒ String

Returns UPI Autopay authentication method. Specifies how the customer authorizes the enrollment mandate. Defaults to 'vpa' if omitted.

Returns:

  • (String) —

    UPI Autopay authentication method. Specifies how the customer authorizes the enrollment mandate. Defaults to 'vpa' if omitted.



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

define_attribute :authentication_method, String

#backup_payment_method ⇒ Boolean

Returns The backup_payment_method field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. 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 field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. 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.



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

define_attribute :backup_payment_method, :Boolean

#card_network_preference ⇒ String

Returns Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.

Returns:

  • (String) —

    Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.



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

define_attribute :card_network_preference, String

#card_type ⇒ String

Returns:

  • (String) 


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

define_attribute :card_type, String

#company ⇒ String

Returns Company name.

Returns:

  • (String) —

    Company name



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

define_attribute :company, String

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

  • (String) —

    3-letter ISO 4217 currency code.



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

define_attribute :currency, String

#cvv ⇒ String

Returns STRONGLY RECOMMENDED.

Returns:

  • (String) —

    STRONGLY RECOMMENDED



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

define_attribute :cvv, String

#external_hpp_type ⇒ String

Returns Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.

Returns:

  • (String) —

    Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.



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

define_attribute :external_hpp_type, String

#first_name ⇒ String

Returns First name.

Returns:

  • (String) —

    First name



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

define_attribute :first_name, String

#fraud_session_id ⇒ String

Returns Fraud Session ID.

Returns:

  • (String) —

    Fraud Session ID



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

define_attribute :fraud_session_id, String

#gateway_attributes ⇒ GatewayAttributes

Returns Additional attributes to send to the gateway.

Returns:



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

define_attribute :gateway_attributes, :GatewayAttributes

#gateway_code ⇒ String

Returns An identifier for a specific payment gateway.

Returns:

  • (String) —

    An identifier for a specific payment gateway.



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

define_attribute :gateway_code, String

#gateway_token ⇒ String

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.



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

define_attribute :gateway_token, String

#iban ⇒ String

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



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

define_attribute :iban, String

#ip_address ⇒ String

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.



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

define_attribute :ip_address, String

#last_name ⇒ String

Returns Last name.

Returns:

  • (String) —

    Last name



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

define_attribute :last_name, String

#month ⇒ String

Returns Expiration month.

Returns:

  • (String) —

    Expiration month



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

define_attribute :month, String

#name_on_account ⇒ String

Returns The name associated with the bank account (ACH, SEPA, Bacs only).

Returns:

  • (String) —

    The name associated with the bank account (ACH, SEPA, Bacs only)



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

define_attribute :name_on_account, String

#number ⇒ String

Returns Credit card number, spaces and dashes are accepted.

Returns:

  • (String) —

    Credit card number, spaces and dashes are accepted.



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

define_attribute :number, String

#online_banking_payment_type ⇒ String

Returns Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.

Returns:

  • (String) —

    Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.



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

define_attribute :online_banking_payment_type, String

#payment_gateway_references ⇒ Array[PaymentGatewayReferences]

Returns Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.

Returns:

  • (Array[PaymentGatewayReferences]) —

    Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.



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

define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }

#paypal_billing_agreement_id ⇒ String

Returns PayPal billing agreement ID.

Returns:

  • (String) —

    PayPal billing agreement ID



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

define_attribute :paypal_billing_agreement_id, String

#primary_payment_method ⇒ Boolean

Returns The primary_payment_method field 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 with a value of true. 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 field 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 with a value of true. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.



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

define_attribute :primary_payment_method, :Boolean

#return_url ⇒ String

Returns Specifies a URL to which a consumer will be redirected upon completion of a redirect payment flow. Only redirect payment flows operating through Adyen Components will utilize this return URL.

Returns:

  • (String) —

    Specifies a URL to which a consumer will be redirected upon completion of a redirect payment flow. Only redirect payment flows operating through Adyen Components will utilize this return URL.



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

define_attribute :return_url, String

#roku_billing_agreement_id ⇒ String

Returns Roku's CIB if billing through Roku.

Returns:

  • (String) —

    Roku's CIB if billing through Roku



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

define_attribute :roku_billing_agreement_id, String

#routing_number ⇒ String

Returns The bank's rounting number. (ACH only).

Returns:

  • (String) —

    The bank's rounting number. (ACH only)



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

define_attribute :routing_number, String

#sort_code ⇒ String

Returns Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only).

Returns:

  • (String) —

    Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)



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

define_attribute :sort_code, String

#tax_identifier ⇒ String

Returns Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.

Returns:

  • (String) —

    Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.



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

define_attribute :tax_identifier, String

#tax_identifier_type ⇒ String

Returns This field and a value of cpf, cnpj or cuit are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.

Returns:

  • (String) —

    This field and a value of cpf, cnpj or cuit are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.



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

define_attribute :tax_identifier_type, String

#three_d_secure_action_result_token_id ⇒ String

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.



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

define_attribute :three_d_secure_action_result_token_id, String

#token_id ⇒ String

Returns A token generated by Recurly.js.

Returns:



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

define_attribute :token_id, String

#transaction_type ⇒ String

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.



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

define_attribute :transaction_type, String

#type ⇒ String

Returns The payment method type for a non-credit card based billing info. bacs, becs, pix-automatico, mercadopago, upi-autopay are the only accepted values.

Returns:

  • (String) —

    The payment method type for a non-credit card based billing info. bacs, becs, pix-automatico, mercadopago, upi-autopay are the only accepted values.



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

define_attribute :type, String

#vat_number ⇒ String

Returns VAT number.

Returns:

  • (String) —

    VAT number



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

define_attribute :vat_number, String

#year ⇒ String

Returns Expiration year.

Returns:

  • (String) —

    Expiration year



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

define_attribute :year, String