increase 1.347.0 → 1.348.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  4. data/lib/increase/models/ach_transfer.rb +2 -2
  5. data/lib/increase/models/ach_transfer_create_params.rb +1 -24
  6. data/lib/increase/models/balance_lookup.rb +49 -1
  7. data/lib/increase/models/beneficial_owner_update_params.rb +9 -1
  8. data/lib/increase/models/card.rb +43 -1
  9. data/lib/increase/models/card_create_params.rb +42 -1
  10. data/lib/increase/models/card_dispute.rb +1 -1
  11. data/lib/increase/models/card_dispute_list_params.rb +1 -1
  12. data/lib/increase/models/card_payment.rb +18 -1
  13. data/lib/increase/models/check_transfer.rb +13 -1
  14. data/lib/increase/models/check_transfer_create_params.rb +25 -13
  15. data/lib/increase/models/entity.rb +22 -4
  16. data/lib/increase/models/entity_update_params.rb +754 -1
  17. data/lib/increase/models/event.rb +9 -0
  18. data/lib/increase/models/event_list_params.rb +9 -0
  19. data/lib/increase/models/event_subscription.rb +9 -0
  20. data/lib/increase/models/event_subscription_create_params.rb +9 -0
  21. data/lib/increase/models/file.rb +7 -6
  22. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  23. data/lib/increase/models/pending_transaction.rb +18 -1
  24. data/lib/increase/models/real_time_decision.rb +18 -1
  25. data/lib/increase/models/real_time_payments_transfer.rb +30 -19
  26. data/lib/increase/models/real_time_payments_transfer_create_params.rb +12 -1
  27. data/lib/increase/models/simulations/card_dispute_action_params.rb +30 -1
  28. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  29. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +18 -18
  30. data/lib/increase/models/unwrap_webhook_event.rb +9 -0
  31. data/lib/increase/models/wire_transfer_create_params.rb +100 -42
  32. data/lib/increase/resources/ach_prenotifications.rb +1 -1
  33. data/lib/increase/resources/ach_transfers.rb +1 -4
  34. data/lib/increase/resources/beneficial_owners.rb +3 -1
  35. data/lib/increase/resources/cards.rb +5 -1
  36. data/lib/increase/resources/real_time_payments_transfers.rb +5 -1
  37. data/lib/increase/version.rb +1 -1
  38. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  39. data/rbi/increase/models/ach_transfer.rbi +2 -2
  40. data/rbi/increase/models/ach_transfer_create_params.rbi +0 -59
  41. data/rbi/increase/models/balance_lookup.rbi +48 -0
  42. data/rbi/increase/models/beneficial_owner_update_params.rbi +11 -0
  43. data/rbi/increase/models/card.rbi +63 -0
  44. data/rbi/increase/models/card_create_params.rbi +65 -0
  45. data/rbi/increase/models/card_dispute.rbi +1 -1
  46. data/rbi/increase/models/card_dispute_list_params.rbi +1 -1
  47. data/rbi/increase/models/card_payment.rbi +16 -0
  48. data/rbi/increase/models/check_transfer.rbi +15 -0
  49. data/rbi/increase/models/check_transfer_create_params.rbi +26 -12
  50. data/rbi/increase/models/entity.rbi +61 -3
  51. data/rbi/increase/models/entity_update_params.rbi +1326 -3
  52. data/rbi/increase/models/event.rbi +21 -0
  53. data/rbi/increase/models/event_list_params.rbi +21 -0
  54. data/rbi/increase/models/event_subscription.rbi +21 -0
  55. data/rbi/increase/models/event_subscription_create_params.rbi +21 -0
  56. data/rbi/increase/models/file.rbi +7 -6
  57. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  58. data/rbi/increase/models/pending_transaction.rbi +16 -0
  59. data/rbi/increase/models/real_time_decision.rbi +16 -0
  60. data/rbi/increase/models/real_time_payments_transfer.rbi +29 -18
  61. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +15 -0
  62. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +60 -0
  63. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  64. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +18 -18
  65. data/rbi/increase/models/unwrap_webhook_event.rbi +21 -0
  66. data/rbi/increase/models/wire_transfer_create_params.rbi +146 -62
  67. data/rbi/increase/resources/ach_prenotifications.rbi +1 -1
  68. data/rbi/increase/resources/ach_transfers.rbi +0 -4
  69. data/rbi/increase/resources/beneficial_owners.rbi +3 -0
  70. data/rbi/increase/resources/cards.rbi +4 -0
  71. data/rbi/increase/resources/real_time_payments_transfers.rbi +4 -0
  72. data/sig/increase/models/ach_transfer_create_params.rbs +1 -24
  73. data/sig/increase/models/balance_lookup.rbs +30 -0
  74. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -0
  75. data/sig/increase/models/card.rbs +19 -0
  76. data/sig/increase/models/card_create_params.rbs +25 -0
  77. data/sig/increase/models/card_dispute.rbs +1 -1
  78. data/sig/increase/models/card_dispute_list_params.rbs +1 -1
  79. data/sig/increase/models/card_payment.rbs +5 -0
  80. data/sig/increase/models/check_transfer.rbs +9 -0
  81. data/sig/increase/models/check_transfer_create_params.rbs +7 -0
  82. data/sig/increase/models/entity.rbs +21 -4
  83. data/sig/increase/models/entity_update_params.rbs +585 -3
  84. data/sig/increase/models/event.rbs +12 -0
  85. data/sig/increase/models/event_list_params.rbs +12 -0
  86. data/sig/increase/models/event_subscription.rbs +12 -0
  87. data/sig/increase/models/event_subscription_create_params.rbs +12 -0
  88. data/sig/increase/models/inbound_ach_transfer.rbs +2 -2
  89. data/sig/increase/models/pending_transaction.rbs +5 -0
  90. data/sig/increase/models/real_time_decision.rbs +5 -0
  91. data/sig/increase/models/real_time_payments_transfer.rbs +23 -18
  92. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +7 -0
  93. data/sig/increase/models/simulations/card_dispute_action_params.rbs +23 -0
  94. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  95. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +18 -18
  96. data/sig/increase/models/unwrap_webhook_event.rbs +12 -0
  97. data/sig/increase/models/wire_transfer_create_params.rbs +78 -32
  98. data/sig/increase/resources/ach_transfers.rbs +0 -1
  99. data/sig/increase/resources/beneficial_owners.rbs +1 -0
  100. data/sig/increase/resources/cards.rbs +1 -0
  101. data/sig/increase/resources/real_time_payments_transfers.rbs +1 -0
  102. metadata +2 -2
@@ -304,6 +304,9 @@ module Increase
304
304
  # Occurs whenever a Loan Distribution is created.
305
305
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
306
306
 
307
+ # Occurs whenever a Loan Obligation is created.
308
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
309
+
307
310
  # Occurs whenever a Loan Offer is created.
308
311
  LOAN_OFFER_CREATED = :"loan_offer.created"
309
312
 
@@ -319,6 +322,12 @@ module Increase
319
322
  # Occurs whenever a Lockbox is updated.
320
323
  LOCKBOX_UPDATED = :"lockbox.updated"
321
324
 
325
+ # Occurs whenever a Lockbox Address is created.
326
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
327
+
328
+ # Occurs whenever a Lockbox Address is updated.
329
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
330
+
322
331
  # Occurs whenever an OAuth Connection is created.
323
332
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
324
333
 
@@ -316,6 +316,9 @@ module Increase
316
316
  # Occurs whenever a Loan Distribution is created.
317
317
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
318
318
 
319
+ # Occurs whenever a Loan Obligation is created.
320
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
321
+
319
322
  # Occurs whenever a Loan Offer is created.
320
323
  LOAN_OFFER_CREATED = :"loan_offer.created"
321
324
 
@@ -331,6 +334,12 @@ module Increase
331
334
  # Occurs whenever a Lockbox is updated.
332
335
  LOCKBOX_UPDATED = :"lockbox.updated"
333
336
 
337
+ # Occurs whenever a Lockbox Address is created.
338
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
339
+
340
+ # Occurs whenever a Lockbox Address is updated.
341
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
342
+
334
343
  # Occurs whenever an OAuth Connection is created.
335
344
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
336
345
 
@@ -345,6 +345,9 @@ module Increase
345
345
  # Occurs whenever a Loan Distribution is created.
346
346
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
347
347
 
348
+ # Occurs whenever a Loan Obligation is created.
349
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
350
+
348
351
  # Occurs whenever a Loan Offer is created.
349
352
  LOAN_OFFER_CREATED = :"loan_offer.created"
350
353
 
@@ -360,6 +363,12 @@ module Increase
360
363
  # Occurs whenever a Lockbox is updated.
361
364
  LOCKBOX_UPDATED = :"lockbox.updated"
362
365
 
366
+ # Occurs whenever a Lockbox Address is created.
367
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
368
+
369
+ # Occurs whenever a Lockbox Address is updated.
370
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
371
+
363
372
  # Occurs whenever an OAuth Connection is created.
364
373
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
365
374
 
@@ -314,6 +314,9 @@ module Increase
314
314
  # Occurs whenever a Loan Distribution is created.
315
315
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
316
316
 
317
+ # Occurs whenever a Loan Obligation is created.
318
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
319
+
317
320
  # Occurs whenever a Loan Offer is created.
318
321
  LOAN_OFFER_CREATED = :"loan_offer.created"
319
322
 
@@ -329,6 +332,12 @@ module Increase
329
332
  # Occurs whenever a Lockbox is updated.
330
333
  LOCKBOX_UPDATED = :"lockbox.updated"
331
334
 
335
+ # Occurs whenever a Lockbox Address is created.
336
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
337
+
338
+ # Occurs whenever a Lockbox Address is updated.
339
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
340
+
332
341
  # Occurs whenever an OAuth Connection is created.
333
342
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
334
343
 
@@ -64,12 +64,13 @@ module Increase
64
64
  required :type, enum: -> { Increase::File::Type }
65
65
 
66
66
  # @!method initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:)
67
- # Files are objects that represent a file hosted on Increase's servers. The file
68
- # may have been uploaded by you (for example, when uploading a check image) or it
69
- # may have been created by Increase (for example, an autogenerated statement PDF).
70
- # If you need to download a File, use the `/files/{file_id}/contents` endpoint. If
71
- # you need to share a File with someone who doesn't have access to your API key,
72
- # create a File Link.
67
+ # Files are objects that represent a file hosted on Increase's servers. Each File
68
+ # has a `purpose` that determines how Increase will use it. You upload a File so
69
+ # it can be attached to another object in the API (for example, when uploading a
70
+ # check image), or Increase creates one for you to download (for example, an
71
+ # autogenerated statement PDF). If you need to download a File, use the
72
+ # `/files/{file_id}/contents` endpoint. If you need to share a File with someone
73
+ # who doesn't have access to your API key, create a File Link.
73
74
  #
74
75
  # @param id [String] The File's identifier.
75
76
  #
@@ -527,7 +527,7 @@ module Increase
527
527
 
528
528
  # @!attribute originating_depository_financial_institution_id
529
529
  # An identifier for the originating bank. One of an International Bank Account
530
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
530
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
531
531
  # domestic identifier like a US Routing Number.
532
532
  #
533
533
  # @return [String]
@@ -658,7 +658,7 @@ module Increase
658
658
 
659
659
  # @!attribute receiving_depository_financial_institution_id
660
660
  # An identifier for the receiving bank. One of an International Bank Account
661
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
661
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
662
662
  # domestic identifier like a US Routing Number.
663
663
  #
664
664
  # @return [String]
@@ -720,7 +720,7 @@ module Increase
720
720
  #
721
721
  # @param originating_depository_financial_institution_id [String]
722
722
  # An identifier for the originating bank. One of an International Bank Account
723
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
723
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
724
724
  # domestic identifier like a US Routing Number.
725
725
  #
726
726
  # @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier]
@@ -780,7 +780,7 @@ module Increase
780
780
  #
781
781
  # @param receiving_depository_financial_institution_id [String]
782
782
  # An identifier for the receiving bank. One of an International Bank Account
783
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
783
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
784
784
  # domestic identifier like a US Routing Number.
785
785
  #
786
786
  # @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier]
@@ -909,7 +909,7 @@ module Increase
909
909
  # A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.
910
910
  NATIONAL_CLEARING_SYSTEM_NUMBER = :national_clearing_system_number
911
911
 
912
- # The SWIFT Bank Identifier Code (BIC) of the bank.
912
+ # The Swift Bank Identifier Code (BIC) of the bank.
913
913
  BIC_CODE = :bic_code
914
914
 
915
915
  # An International Bank Account Number.
@@ -929,7 +929,7 @@ module Increase
929
929
  # A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.
930
930
  NATIONAL_CLEARING_SYSTEM_NUMBER = :national_clearing_system_number
931
931
 
932
- # The SWIFT Bank Identifier Code (BIC) of the bank.
932
+ # The Swift Bank Identifier Code (BIC) of the bank.
933
933
  BIC_CODE = :bic_code
934
934
 
935
935
  # An International Bank Account Number.
@@ -892,6 +892,16 @@ module Increase
892
892
  # @return [Integer, nil]
893
893
  required :network_risk_score, Integer, nil?: true
894
894
 
895
+ # @!attribute original_card_payment_id
896
+ # The ID of the Card Payment containing the original authorization or card
897
+ # validation this transaction references. For a merchant-initiated transaction,
898
+ # this is the Card Payment from when the card was first stored, which is typically
899
+ # where the CVV2 was verified. The reference this is derived from is supplied by
900
+ # the merchant or their acquirer, so it is not guaranteed to be present.
901
+ #
902
+ # @return [String, nil]
903
+ required :original_card_payment_id, String, nil?: true
904
+
895
905
  # @!attribute pending_transaction_id
896
906
  # The identifier of the Pending Transaction associated with this Transaction.
897
907
  #
@@ -960,7 +970,7 @@ module Increase
960
970
  # @return [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification]
961
971
  required :verification, -> { Increase::PendingTransaction::Source::CardAuthorization::Verification }
962
972
 
963
- # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
973
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, original_card_payment_id:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
964
974
  # A Card Authorization object. This field will be present in the JSON response if
965
975
  # and only if `category` is equal to `card_authorization`. Card Authorizations are
966
976
  # temporary holds placed on a customer's funds with the intent to later clear a
@@ -1034,6 +1044,13 @@ module Increase
1034
1044
  # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1035
1045
  # score is from 0 to 999, where 999 is the riskiest.
1036
1046
  #
1047
+ # @param original_card_payment_id [String, nil]
1048
+ # The ID of the Card Payment containing the original authorization or card
1049
+ # validation this transaction references. For a merchant-initiated transaction,
1050
+ # this is the Card Payment from when the card was first stored, which is typically
1051
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1052
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1053
+ #
1037
1054
  # @param pending_transaction_id [String, nil]
1038
1055
  # The identifier of the Pending Transaction associated with this Transaction.
1039
1056
  #
@@ -1094,6 +1094,16 @@ module Increase
1094
1094
  # @return [Integer, nil]
1095
1095
  required :network_risk_score, Integer, nil?: true
1096
1096
 
1097
+ # @!attribute original_card_payment_id
1098
+ # The identifier of the Card Payment containing the original authorization or card
1099
+ # validation this transaction references. For a merchant-initiated transaction,
1100
+ # this is the Card Payment from when the card was first stored, which is typically
1101
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1102
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1103
+ #
1104
+ # @return [String, nil]
1105
+ required :original_card_payment_id, String, nil?: true
1106
+
1097
1107
  # @!attribute partial_approval_capability
1098
1108
  # Whether or not the authorization supports partial approvals.
1099
1109
  #
@@ -1171,7 +1181,7 @@ module Increase
1171
1181
  # @return [Increase::Models::RealTimeDecision::CardAuthorization::Verification]
1172
1182
  required :verification, -> { Increase::RealTimeDecision::CardAuthorization::Verification }
1173
1183
 
1174
- # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1184
+ # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, original_card_payment_id:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1175
1185
  # Fields related to a card authorization.
1176
1186
  #
1177
1187
  # @param account_id [String] The identifier of the Account the authorization will debit.
@@ -1237,6 +1247,13 @@ module Increase
1237
1247
  # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1238
1248
  # score is from 0 to 999, where 999 is the riskiest.
1239
1249
  #
1250
+ # @param original_card_payment_id [String, nil]
1251
+ # The identifier of the Card Payment containing the original authorization or card
1252
+ # validation this transaction references. For a merchant-initiated transaction,
1253
+ # this is the Card Payment from when the card was first stored, which is typically
1254
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1255
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1256
+ #
1240
1257
  # @param partial_approval_capability [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::PartialApprovalCapability]
1241
1258
  # Whether or not the authorization supports partial approvals.
1242
1259
  #
@@ -97,6 +97,13 @@ module Increase
97
97
  # @return [String, nil]
98
98
  required :idempotency_key, String, nil?: true
99
99
 
100
+ # @!attribute inbound_real_time_payments_request_for_payment_id
101
+ # The identifier of the Inbound Real-Time Payments Request for Payment this
102
+ # transfer was sent in response to, if any.
103
+ #
104
+ # @return [String, nil]
105
+ required :inbound_real_time_payments_request_for_payment_id, String, nil?: true
106
+
100
107
  # @!attribute pending_transaction_id
101
108
  # The ID for the pending transaction representing the transfer. A pending
102
109
  # transaction is created when the transfer
@@ -172,7 +179,7 @@ module Increase
172
179
  # @return [String]
173
180
  required :unstructured_remittance_information, String
174
181
 
175
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
182
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
176
183
  # Real-Time Payments transfers move funds, within seconds, between your Increase
177
184
  # account and any other account on the Real-Time Payments network.
178
185
  #
@@ -223,6 +230,10 @@ module Increase
223
230
  # Increase and is used to ensure that a request is only processed once. Learn more
224
231
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
225
232
  #
233
+ # @param inbound_real_time_payments_request_for_payment_id [String, nil]
234
+ # The identifier of the Inbound Real-Time Payments Request for Payment this
235
+ # transfer was sent in response to, if any.
236
+ #
226
237
  # @param pending_transaction_id [String, nil]
227
238
  # The ID for the pending transaction representing the transfer. A pending
228
239
  # transaction is created when the transfer
@@ -502,61 +513,61 @@ module Increase
502
513
  module RejectReasonCode
503
514
  extend Increase::Internal::Type::Enum
504
515
 
505
- # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.
516
+ # The destination account is closed. Corresponds to the Real-Time Payments reason code "AC04".
506
517
  ACCOUNT_CLOSED = :account_closed
507
518
 
508
- # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.
519
+ # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code "AC06".
509
520
  ACCOUNT_BLOCKED = :account_blocked
510
521
 
511
- # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.
522
+ # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code "AC14".
512
523
  INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type
513
524
 
514
- # The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.
525
+ # The destination account does not exist. Corresponds to the Real-Time Payments reason code "AC03".
515
526
  INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
516
527
 
517
- # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
528
+ # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code "RC04".
518
529
  INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier
519
530
 
520
- # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.
531
+ # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code "MD07".
521
532
  END_CUSTOMER_DECEASED = :end_customer_deceased
522
533
 
523
534
  # The reason is provided as narrative information in the additional information field.
524
535
  NARRATIVE = :narrative
525
536
 
526
- # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.
537
+ # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code "AG01".
527
538
  TRANSACTION_FORBIDDEN = :transaction_forbidden
528
539
 
529
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.
540
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "AG03".
530
541
  TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported
531
542
 
532
- # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
543
+ # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code "AM09".
533
544
  UNEXPECTED_AMOUNT = :unexpected_amount
534
545
 
535
- # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.
546
+ # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code "AM14".
536
547
  AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits
537
548
 
538
- # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
549
+ # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE04".
539
550
  INVALID_CREDITOR_ADDRESS = :invalid_creditor_address
540
551
 
541
- # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.
552
+ # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code "BE06".
542
553
  UNKNOWN_END_CUSTOMER = :unknown_end_customer
543
554
 
544
- # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.
555
+ # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE07".
545
556
  INVALID_DEBTOR_ADDRESS = :invalid_debtor_address
546
557
 
547
- # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.
558
+ # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code "DS24".
548
559
  TIMEOUT = :timeout
549
560
 
550
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.
561
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "NOAT".
551
562
  UNSUPPORTED_MESSAGE_FOR_RECIPIENT = :unsupported_message_for_recipient
552
563
 
553
- # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.
564
+ # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code "9912".
554
565
  RECIPIENT_CONNECTION_NOT_AVAILABLE = :recipient_connection_not_available
555
566
 
556
- # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.
567
+ # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code "9948".
557
568
  REAL_TIME_PAYMENTS_SUSPENDED = :real_time_payments_suspended
558
569
 
559
- # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.
570
+ # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code "9910".
560
571
  INSTRUCTED_AGENT_SIGNED_OFF = :instructed_agent_signed_off
561
572
 
562
573
  # The transfer was rejected due to an internal Increase issue. We have been notified.
@@ -52,6 +52,13 @@ module Increase
52
52
  # @return [String, nil]
53
53
  optional :external_account_id, String
54
54
 
55
+ # @!attribute inbound_real_time_payments_request_for_payment_id
56
+ # The ID of an Inbound Real-Time Payments Request for Payment in response to which
57
+ # this transfer is being sent.
58
+ #
59
+ # @return [String, nil]
60
+ optional :inbound_real_time_payments_request_for_payment_id, String
61
+
55
62
  # @!attribute require_approval
56
63
  # Whether the transfer requires explicit approval via the dashboard or API.
57
64
  #
@@ -79,7 +86,7 @@ module Increase
79
86
  # @return [String, nil]
80
87
  optional :ultimate_debtor_name, String
81
88
 
82
- # @!method initialize(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
89
+ # @!method initialize(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, inbound_real_time_payments_request_for_payment_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
83
90
  # @param amount [Integer]
84
91
  # The transfer amount in USD cents. For Real-Time Payments transfers, must be
85
92
  # positive.
@@ -102,6 +109,10 @@ module Increase
102
109
  # The ID of an External Account to initiate a transfer to. If this parameter is
103
110
  # provided, `account_number` and `routing_number` must be absent.
104
111
  #
112
+ # @param inbound_real_time_payments_request_for_payment_id [String]
113
+ # The ID of an Inbound Real-Time Payments Request for Payment in response to which
114
+ # this transfer is being sent.
115
+ #
105
116
  # @param require_approval [Boolean]
106
117
  # Whether the transfer requires explicit approval via the dashboard or API.
107
118
  #
@@ -92,6 +92,13 @@ module Increase
92
92
  optional :receive_merchant_prearbitration,
93
93
  -> { Increase::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration }
94
94
 
95
+ # @!attribute reject
96
+ # The parameters for rejecting the dispute. Required if and only if `action` is
97
+ # `reject`.
98
+ #
99
+ # @return [Increase::Models::Simulations::CardDisputeActionParams::Visa::Reject, nil]
100
+ optional :reject, -> { Increase::Simulations::CardDisputeActionParams::Visa::Reject }
101
+
95
102
  # @!attribute represent
96
103
  # The parameters for re-presenting the dispute. Required if and only if `action`
97
104
  # is `represent`.
@@ -139,7 +146,7 @@ module Increase
139
146
  optional :time_out_user_prearbitration,
140
147
  -> { Increase::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration }
141
148
 
142
- # @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
149
+ # @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, reject: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
143
150
  # The Visa-specific parameters for the taking action on the dispute. Required if
144
151
  # and only if `network` is `visa`.
145
152
  #
@@ -163,6 +170,10 @@ module Increase
163
170
  # The parameters for receiving the prearbitration. Required if and only if
164
171
  # `action` is `receive_merchant_prearbitration`.
165
172
  #
173
+ # @param reject [Increase::Models::Simulations::CardDisputeActionParams::Visa::Reject]
174
+ # The parameters for rejecting the dispute. Required if and only if `action` is
175
+ # `reject`.
176
+ #
166
177
  # @param represent [Increase::Models::Simulations::CardDisputeActionParams::Visa::Represent]
167
178
  # The parameters for re-presenting the dispute. Required if and only if `action`
168
179
  # is `represent`.
@@ -206,6 +217,9 @@ module Increase
206
217
  # Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.
207
218
  RECEIVE_MERCHANT_PREARBITRATION = :receive_merchant_prearbitration
208
219
 
220
+ # Simulate the dispute being rejected before it is submitted to the network. This will move the dispute to a `rejected` state.
221
+ REJECT = :reject
222
+
209
223
  # Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
210
224
  REPRESENT = :represent
211
225
 
@@ -256,6 +270,21 @@ module Increase
256
270
  # `action` is `receive_merchant_prearbitration`.
257
271
  end
258
272
 
273
+ # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#reject
274
+ class Reject < Increase::Internal::Type::BaseModel
275
+ # @!attribute explanation
276
+ # The explanation for rejecting the dispute.
277
+ #
278
+ # @return [String]
279
+ required :explanation, String
280
+
281
+ # @!method initialize(explanation:)
282
+ # The parameters for rejecting the dispute. Required if and only if `action` is
283
+ # `reject`.
284
+ #
285
+ # @param explanation [String] The explanation for rejecting the dispute.
286
+ end
287
+
259
288
  # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#represent
260
289
  class Represent < Increase::Internal::Type::BaseModel
261
290
  # @!method initialize
@@ -54,6 +54,9 @@ module Increase
54
54
  # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
55
55
  ENTITY_ADDRESS = :entity_address
56
56
 
57
+ # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
58
+ ENTITY_IDENTITY = :entity_identity
59
+
57
60
  # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
58
61
  BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity
59
62
 
@@ -49,61 +49,61 @@ module Increase
49
49
  module RejectReasonCode
50
50
  extend Increase::Internal::Type::Enum
51
51
 
52
- # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.
52
+ # The destination account is closed. Corresponds to the Real-Time Payments reason code "AC04".
53
53
  ACCOUNT_CLOSED = :account_closed
54
54
 
55
- # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.
55
+ # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code "AC06".
56
56
  ACCOUNT_BLOCKED = :account_blocked
57
57
 
58
- # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.
58
+ # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code "AC14".
59
59
  INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type
60
60
 
61
- # The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.
61
+ # The destination account does not exist. Corresponds to the Real-Time Payments reason code "AC03".
62
62
  INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
63
63
 
64
- # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
64
+ # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code "RC04".
65
65
  INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier
66
66
 
67
- # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.
67
+ # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code "MD07".
68
68
  END_CUSTOMER_DECEASED = :end_customer_deceased
69
69
 
70
70
  # The reason is provided as narrative information in the additional information field.
71
71
  NARRATIVE = :narrative
72
72
 
73
- # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.
73
+ # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code "AG01".
74
74
  TRANSACTION_FORBIDDEN = :transaction_forbidden
75
75
 
76
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.
76
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "AG03".
77
77
  TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported
78
78
 
79
- # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
79
+ # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code "AM09".
80
80
  UNEXPECTED_AMOUNT = :unexpected_amount
81
81
 
82
- # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.
82
+ # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code "AM14".
83
83
  AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits
84
84
 
85
- # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
85
+ # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE04".
86
86
  INVALID_CREDITOR_ADDRESS = :invalid_creditor_address
87
87
 
88
- # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.
88
+ # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code "BE06".
89
89
  UNKNOWN_END_CUSTOMER = :unknown_end_customer
90
90
 
91
- # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.
91
+ # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE07".
92
92
  INVALID_DEBTOR_ADDRESS = :invalid_debtor_address
93
93
 
94
- # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.
94
+ # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code "DS24".
95
95
  TIMEOUT = :timeout
96
96
 
97
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.
97
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "NOAT".
98
98
  UNSUPPORTED_MESSAGE_FOR_RECIPIENT = :unsupported_message_for_recipient
99
99
 
100
- # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.
100
+ # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code "9912".
101
101
  RECIPIENT_CONNECTION_NOT_AVAILABLE = :recipient_connection_not_available
102
102
 
103
- # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.
103
+ # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code "9948".
104
104
  REAL_TIME_PAYMENTS_SUSPENDED = :real_time_payments_suspended
105
105
 
106
- # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.
106
+ # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code "9910".
107
107
  INSTRUCTED_AGENT_SIGNED_OFF = :instructed_agent_signed_off
108
108
 
109
109
  # The transfer was rejected due to an internal Increase issue. We have been notified.
@@ -303,6 +303,9 @@ module Increase
303
303
  # Occurs whenever a Loan Distribution is created.
304
304
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
305
305
 
306
+ # Occurs whenever a Loan Obligation is created.
307
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
308
+
306
309
  # Occurs whenever a Loan Offer is created.
307
310
  LOAN_OFFER_CREATED = :"loan_offer.created"
308
311
 
@@ -318,6 +321,12 @@ module Increase
318
321
  # Occurs whenever a Lockbox is updated.
319
322
  LOCKBOX_UPDATED = :"lockbox.updated"
320
323
 
324
+ # Occurs whenever a Lockbox Address is created.
325
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
326
+
327
+ # Occurs whenever a Lockbox Address is updated.
328
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
329
+
321
330
  # Occurs whenever an OAuth Connection is created.
322
331
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
323
332