Class: Increase::Models::RealTimePaymentsRequestForPayment

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/real_time_payments_request_for_payment.rb

Defined Under Namespace

Classes: Refusal, Rejection, Submission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#created_at ⇒ String

The ISO 8601 date and time at which the request for payment was created.

Returns:

  • (String) 


19
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 19

required :created_at, String

#currency ⇒ Symbol

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

Returns:

  • (Symbol) 


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

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

#debtor_name ⇒ String

The name of the recipient the sender is requesting a transfer from.

Returns:

  • (String) 


29
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 29

required :debtor_name, String

#destination_account_number_id ⇒ String

The Account Number in which a successful transfer will arrive.

Returns:

  • (String) 


34
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 34

required :destination_account_number_id, String

#expires_at ⇒ String

The expiration time for this request, in UTC. The requestee will not be able to pay after this date.

Returns:

  • (String) 


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

required :expires_at, String

#fulfillment_transaction_id ⇒ String

The transaction that fulfilled this request.

Returns:

  • (String) 


44
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 44

required :fulfillment_transaction_id, String

#id ⇒ String

The Real-Time Payments Request for Payment's identifier.

Returns:

  • (String) 


9
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 9

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.

Returns:

  • (String) 


49
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 49

required :idempotency_key, String

#refusal ⇒ Increase::Models::RealTimePaymentsRequestForPayment::Refusal

If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.

Returns:



54
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 54

required :refusal, -> { Increase::Models::RealTimePaymentsRequestForPayment::Refusal }

#rejection ⇒ Increase::Models::RealTimePaymentsRequestForPayment::Rejection

If the request for payment is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

Returns:



59
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 59

required :rejection, -> { Increase::Models::RealTimePaymentsRequestForPayment::Rejection }

#remittance_information ⇒ String

Unstructured information that will show on the recipient's bank statement.

Returns:

  • (String) 


64
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 64

required :remittance_information, String

#source_account_number ⇒ String

The account number the request is sent to.

Returns:

  • (String) 


69
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 69

required :source_account_number, String

#source_routing_number ⇒ String

The receiver's American Bankers' Association (ABA) Routing Transit Number (RTN).

Returns:

  • (String) 


74
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 74

required :source_routing_number, String

#status ⇒ Symbol

The lifecycle status of the request for payment.

Returns:

  • (Symbol) 


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

required :status,
Increase::Enum.new(:pending_submission, :pending_response, :rejected, :accepted, :refused, :fulfilled)

#submission ⇒ Increase::Models::RealTimePaymentsRequestForPayment::Submission

After the request for payment is submitted to Real-Time Payments, this will contain supplemental details.

Returns:



85
 
# File 'lib/increase/models/real_time_payments_request_for_payment.rb', line 85

required :submission, -> { Increase::Models::RealTimePaymentsRequestForPayment::Submission }

#type ⇒ Symbol

A constant representing the object's type. For this resource it will always be real_time_payments_request_for_payment.

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:real_time_payments_request_for_payment)