Class: Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection

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

Defined Under Namespace

Modules: RejectReasonCode

Instance Attribute 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(reject_reason_code:) ⇒ Object

If set, the simulation will reject the transfer.

Parameters:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb', line 30

class Rejection < Increase::Internal::Type::BaseModel
  # @!attribute reject_reason_code
  #   The reason code that the simulated rejection will have.
  #
  #   @return [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode]
  required :reject_reason_code,
           enum: -> { Increase::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode }

  # @!method initialize(reject_reason_code:)
  #   If set, the simulation will reject the transfer.
  #
  #   @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] The reason code that the simulated rejection will have.

  # The reason code that the simulated rejection will have.
  #
  # @see Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection#reject_reason_code
  module RejectReasonCode
    extend Increase::Internal::Type::Enum

    # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.
    ACCOUNT_CLOSED = :account_closed

    # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.
    ACCOUNT_BLOCKED = :account_blocked

    # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.
    INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type

    # The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.
    INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number

    # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
    INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier

    # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.
    END_CUSTOMER_DECEASED = :end_customer_deceased

    # The reason is provided as narrative information in the additional information field.
    NARRATIVE = :narrative

    # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.
    TRANSACTION_FORBIDDEN = :transaction_forbidden

    # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.
    TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported

    # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
    UNEXPECTED_AMOUNT = :unexpected_amount

    # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.
    AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits

    # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
    INVALID_CREDITOR_ADDRESS = :invalid_creditor_address

    # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.
    UNKNOWN_END_CUSTOMER = :unknown_end_customer

    # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.
    INVALID_DEBTOR_ADDRESS = :invalid_debtor_address

    # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.
    TIMEOUT = :timeout

    # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.
    UNSUPPORTED_MESSAGE_FOR_RECIPIENT = :unsupported_message_for_recipient

    # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.
    RECIPIENT_CONNECTION_NOT_AVAILABLE = :recipient_connection_not_available

    # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.
    REAL_TIME_PAYMENTS_SUSPENDED = :real_time_payments_suspended

    # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.
    INSTRUCTED_AGENT_SIGNED_OFF = :instructed_agent_signed_off

    # The transfer was rejected due to an internal Increase issue. We have been notified.
    PROCESSING_ERROR = :processing_error

    # Some other error or issue has occurred.
    OTHER = :other

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#reject_reason_code ⇒ Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode

The reason code that the simulated rejection will have.

Returns:



35
36
 
# File 'lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb', line 35

required :reject_reason_code,
enum: -> { Increase::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode }