Class: Increase::Models::CardPushTransfer

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_push_transfer.rb

Overview

See Also:

Defined Under Namespace

Modules: BusinessApplicationIdentifier, Currency, Status, Type Classes: Acceptance, Approval, Cancellation, CreatedBy, Decline, Submission

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(retrieval_reference_number: , sender_reference: , submitted_at: , trace_number: ) ⇒ Object

Some parameter documentations has been truncated, see Submission for more details.

After the transfer is submitted to the card network, this will contain supplemental details.

Parameters:

  • retrieval_reference_number (String) (defaults to: ) —

    A 12-digit retrieval reference number that identifies the transfer. Usually a co

  • sender_reference (String) (defaults to: ) —

    A unique reference for the transfer.

  • submitted_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • trace_number (String) (defaults to: ) —

    A 6-digit trace number that identifies the transfer within a small window of tim




# File 'lib/increase/models/card_push_transfer.rb', line 194

Instance Attribute Details

#acceptance ⇒ Increase::Models::CardPushTransfer::Acceptance?

If the transfer is accepted by the recipient bank, this will contain supplemental details.

Returns:



18
 
# File 'lib/increase/models/card_push_transfer.rb', line 18

required :acceptance, -> { Increase::CardPushTransfer::Acceptance }, nil?: true

#account_id ⇒ String

The Account from which the transfer was sent.

Returns:

  • (String) 


24
 
# File 'lib/increase/models/card_push_transfer.rb', line 24

required :account_id, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::CardPushTransfer::Approval?

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

Returns:



37
 
# File 'lib/increase/models/card_push_transfer.rb', line 37

required :approval, -> { Increase::CardPushTransfer::Approval }, nil?: true

#business_application_identifier ⇒ Symbol, Increase::Models::CardPushTransfer::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:



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

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

#cancellation ⇒ Increase::Models::CardPushTransfer::Cancellation?

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

Returns:



53
 
# File 'lib/increase/models/card_push_transfer.rb', line 53

required :cancellation, -> { Increase::CardPushTransfer::Cancellation }, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.

Returns:

  • (Time) 


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

required :created_at, Time

#created_by ⇒ Increase::Models::CardPushTransfer::CreatedBy?

What object created the transfer, either via the API or the dashboard.

Returns:



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

required :created_by, -> { Increase::CardPushTransfer::CreatedBy }, nil?: true

#currency ⇒ Symbol, Increase::Models::CardPushTransfer::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transfer’s currency.

Returns:



73
 
# File 'lib/increase/models/card_push_transfer.rb', line 73

required :currency, enum: -> { Increase::CardPushTransfer::Currency }

#decline ⇒ Increase::Models::CardPushTransfer::Decline?

If the transfer is rejected by the card network or the destination financial institution, this will contain supplemental details.

Returns:



80
 
# File 'lib/increase/models/card_push_transfer.rb', line 80

required :decline, -> { Increase::CardPushTransfer::Decline }, nil?: true

#id ⇒ String

The Card Push Transfer’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/card_push_transfer.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


88
 
# File 'lib/increase/models/card_push_transfer.rb', line 88

required :idempotency_key, String, nil?: true

#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) 


97
 
# File 'lib/increase/models/card_push_transfer.rb', line 97

required :merchant_category_code, String

#merchant_city_name ⇒ String

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

Returns:

  • (String) 


103
 
# File 'lib/increase/models/card_push_transfer.rb', line 103

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) 


110
 
# File 'lib/increase/models/card_push_transfer.rb', line 110

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) 


118
 
# File 'lib/increase/models/card_push_transfer.rb', line 118

required :merchant_name_prefix, String

#merchant_postal_code ⇒ String

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

Returns:

  • (String) 


124
 
# File 'lib/increase/models/card_push_transfer.rb', line 124

required :merchant_postal_code, String

#merchant_state ⇒ String

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

Returns:

  • (String) 


130
 
# File 'lib/increase/models/card_push_transfer.rb', line 130

required :merchant_state, String

#recipient_name ⇒ String

The name of the funds recipient.

Returns:

  • (String) 


136
 
# File 'lib/increase/models/card_push_transfer.rb', line 136

required :recipient_name, String

#sender_address_city ⇒ String

The city of the sender.

Returns:

  • (String) 


142
 
# File 'lib/increase/models/card_push_transfer.rb', line 142

required :sender_address_city, String

#sender_address_line1 ⇒ String

The address line 1 of the sender.

Returns:

  • (String) 


148
 
# File 'lib/increase/models/card_push_transfer.rb', line 148

required :sender_address_line1, String

#sender_address_postal_code ⇒ String

The postal code of the sender.

Returns:

  • (String) 


154
 
# File 'lib/increase/models/card_push_transfer.rb', line 154

required :sender_address_postal_code, String

#sender_address_state ⇒ String

The state of the sender.

Returns:

  • (String) 


160
 
# File 'lib/increase/models/card_push_transfer.rb', line 160

required :sender_address_state, String

#sender_name ⇒ String

The name of the funds originator.

Returns:

  • (String) 


166
 
# File 'lib/increase/models/card_push_transfer.rb', line 166

required :sender_name, String

#source_account_number_id ⇒ String

The Account Number the recipient will see as having sent the transfer.

Returns:

  • (String) 


172
 
# File 'lib/increase/models/card_push_transfer.rb', line 172

required :source_account_number_id, String

#status ⇒ Symbol, Increase::Models::CardPushTransfer::Status

The lifecycle status of the transfer.

Returns:



178
 
# File 'lib/increase/models/card_push_transfer.rb', line 178

required :status, enum: -> { Increase::CardPushTransfer::Status }

#submission ⇒ Increase::Models::CardPushTransfer::Submission?

After the transfer is submitted to the card network, this will contain supplemental details.

Returns:



185
 
# File 'lib/increase/models/card_push_transfer.rb', line 185

required :submission, -> { Increase::CardPushTransfer::Submission }, nil?: true

#type ⇒ Symbol, Increase::Models::CardPushTransfer::Type

A constant representing the object’s type. For this resource it will always be ‘card_push_transfer`.

Returns:



192
 
# File 'lib/increase/models/card_push_transfer.rb', line 192

required :type, enum: -> { Increase::CardPushTransfer::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_push_transfer.rb', line 312