Class: Increase::Models::CardPushTransferCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/card_push_transfer_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: BusinessApplicationIdentifier

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount: , business_application_identifier: , card_token_id: , merchant_category_code: , merchant_city_name: , merchant_name: , merchant_name_prefix: , merchant_postal_code: , merchant_state: , recipient_name: , sender_address_city: , sender_address_line1: , sender_address_postal_code: , sender_address_state: , sender_name: , source_account_number_id: , require_approval: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CardPushTransferCreateParams for more details.

Parameters:

  • amount (Integer) (defaults to: ) —

    The transfer amount in USD cents. For Card Push transfers, must be positive.

  • business_application_identifier (Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier) (defaults to: ) —

    The Business Application Identifier describes the type of transaction being perf

  • card_token_id (String) (defaults to: ) —

    The Increase identifier for the Card Token that represents the card number you’r

  • merchant_category_code (String) (defaults to: ) —

    The merchant category code (MCC) of the merchant (generally your business) sendi

  • merchant_city_name (String) (defaults to: ) —

    The city name of the merchant (generally your business) sending the transfer.

  • merchant_name (String) (defaults to: ) —

    The merchant name shows up as the statement descriptor for the transfer. This is

  • merchant_name_prefix (String) (defaults to: ) —

    For certain Business Application Identifiers, the statement descriptor is ‘merch

  • merchant_postal_code (String) (defaults to: ) —

    The postal code of the merchant (generally your business) sending the transfer.

  • merchant_state (String) (defaults to: ) —

    The state of the merchant (generally your business) sending the transfer.

  • recipient_name (String) (defaults to: ) —

    The name of the funds recipient.

  • sender_address_city (String) (defaults to: ) —

    The city of the sender.

  • sender_address_line1 (String) (defaults to: ) —

    The address line 1 of the sender.

  • sender_address_postal_code (String) (defaults to: ) —

    The postal code of the sender.

  • sender_address_state (String) (defaults to: ) —

    The state of the sender.

  • sender_name (String) (defaults to: ) —

    The name of the funds originator.

  • source_account_number_id (String) (defaults to: ) —

    The identifier of the Account Number from which to send the transfer.

  • require_approval (Boolean) (defaults to: nil) —

    Whether the transfer requires explicit approval via the dashboard or API.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/increase/models/card_push_transfer_create_params.rb', line 122

Instance Attribute Details

#amount ⇒ Integer

The transfer amount in USD cents. For Card Push transfers, must be positive.

Returns:

  • (Integer) 


14
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 14

required :amount, Integer

#business_application_identifier ⇒ Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier

The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.

Returns:



22
23
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 22

required :business_application_identifier,
enum: -> { Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier }

#card_token_id ⇒ String

The Increase identifier for the Card Token that represents the card number you’re pushing funds to.

Returns:

  • (String) 


30
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 30

required :card_token_id, String

#merchant_category_code ⇒ String

The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.

Returns:

  • (String) 


39
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 39

required :merchant_category_code, String

#merchant_city_name ⇒ String

The city name of the merchant (generally your business) sending the transfer.

Returns:

  • (String) 


45
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 45

required :merchant_city_name, String

#merchant_name ⇒ String

The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.

Returns:

  • (String) 


52
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 52

required :merchant_name, String

#merchant_name_prefix ⇒ String

For certain Business Application Identifiers, the statement descriptor is ‘merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant.

Returns:

  • (String) 


60
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 60

required :merchant_name_prefix, String

#merchant_postal_code ⇒ String

The postal code of the merchant (generally your business) sending the transfer.

Returns:

  • (String) 


66
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 66

required :merchant_postal_code, String

#merchant_state ⇒ String

The state of the merchant (generally your business) sending the transfer.

Returns:

  • (String) 


72
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 72

required :merchant_state, String

#recipient_name ⇒ String

The name of the funds recipient.

Returns:

  • (String) 


78
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 78

required :recipient_name, String

#require_approval ⇒ Boolean?

Whether the transfer requires explicit approval via the dashboard or API.

Returns:

  • (Boolean, nil) 


120
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 120

optional :require_approval, Increase::Internal::Type::Boolean

#sender_address_city ⇒ String

The city of the sender.

Returns:

  • (String) 


84
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 84

required :sender_address_city, String

#sender_address_line1 ⇒ String

The address line 1 of the sender.

Returns:

  • (String) 


90
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 90

required :sender_address_line1, String

#sender_address_postal_code ⇒ String

The postal code of the sender.

Returns:

  • (String) 


96
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 96

required :sender_address_postal_code, String

#sender_address_state ⇒ String

The state of the sender.

Returns:

  • (String) 


102
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 102

required :sender_address_state, String

#sender_name ⇒ String

The name of the funds originator.

Returns:

  • (String) 


108
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 108

required :sender_name, String

#source_account_number_id ⇒ String

The identifier of the Account Number from which to send the transfer.

Returns:

  • (String) 


114
 
# File 'lib/increase/models/card_push_transfer_create_params.rb', line 114

required :source_account_number_id, String