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
@@ -593,6 +593,13 @@ module Increase
593
593
  Increase::Event::Category::TaggedSymbol
594
594
  )
595
595
 
596
+ # Occurs whenever a Loan Obligation is created.
597
+ LOAN_OBLIGATION_CREATED =
598
+ T.let(
599
+ :"loan_obligation.created",
600
+ Increase::Event::Category::TaggedSymbol
601
+ )
602
+
596
603
  # Occurs whenever a Loan Offer is created.
597
604
  LOAN_OFFER_CREATED =
598
605
  T.let(:"loan_offer.created", Increase::Event::Category::TaggedSymbol)
@@ -616,6 +623,20 @@ module Increase
616
623
  LOCKBOX_UPDATED =
617
624
  T.let(:"lockbox.updated", Increase::Event::Category::TaggedSymbol)
618
625
 
626
+ # Occurs whenever a Lockbox Address is created.
627
+ LOCKBOX_ADDRESS_CREATED =
628
+ T.let(
629
+ :"lockbox_address.created",
630
+ Increase::Event::Category::TaggedSymbol
631
+ )
632
+
633
+ # Occurs whenever a Lockbox Address is updated.
634
+ LOCKBOX_ADDRESS_UPDATED =
635
+ T.let(
636
+ :"lockbox_address.updated",
637
+ Increase::Event::Category::TaggedSymbol
638
+ )
639
+
619
640
  # Occurs whenever an OAuth Connection is created.
620
641
  OAUTH_CONNECTION_CREATED =
621
642
  T.let(
@@ -696,6 +696,13 @@ module Increase
696
696
  Increase::EventListParams::Category::In::TaggedSymbol
697
697
  )
698
698
 
699
+ # Occurs whenever a Loan Obligation is created.
700
+ LOAN_OBLIGATION_CREATED =
701
+ T.let(
702
+ :"loan_obligation.created",
703
+ Increase::EventListParams::Category::In::TaggedSymbol
704
+ )
705
+
699
706
  # Occurs whenever a Loan Offer is created.
700
707
  LOAN_OFFER_CREATED =
701
708
  T.let(
@@ -731,6 +738,20 @@ module Increase
731
738
  Increase::EventListParams::Category::In::TaggedSymbol
732
739
  )
733
740
 
741
+ # Occurs whenever a Lockbox Address is created.
742
+ LOCKBOX_ADDRESS_CREATED =
743
+ T.let(
744
+ :"lockbox_address.created",
745
+ Increase::EventListParams::Category::In::TaggedSymbol
746
+ )
747
+
748
+ # Occurs whenever a Lockbox Address is updated.
749
+ LOCKBOX_ADDRESS_UPDATED =
750
+ T.let(
751
+ :"lockbox_address.updated",
752
+ Increase::EventListParams::Category::In::TaggedSymbol
753
+ )
754
+
734
755
  # Occurs whenever an OAuth Connection is created.
735
756
  OAUTH_CONNECTION_CREATED =
736
757
  T.let(
@@ -717,6 +717,13 @@ module Increase
717
717
  Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
718
718
  )
719
719
 
720
+ # Occurs whenever a Loan Obligation is created.
721
+ LOAN_OBLIGATION_CREATED =
722
+ T.let(
723
+ :"loan_obligation.created",
724
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
725
+ )
726
+
720
727
  # Occurs whenever a Loan Offer is created.
721
728
  LOAN_OFFER_CREATED =
722
729
  T.let(
@@ -752,6 +759,20 @@ module Increase
752
759
  Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
753
760
  )
754
761
 
762
+ # Occurs whenever a Lockbox Address is created.
763
+ LOCKBOX_ADDRESS_CREATED =
764
+ T.let(
765
+ :"lockbox_address.created",
766
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
767
+ )
768
+
769
+ # Occurs whenever a Lockbox Address is updated.
770
+ LOCKBOX_ADDRESS_UPDATED =
771
+ T.let(
772
+ :"lockbox_address.updated",
773
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
774
+ )
775
+
755
776
  # Occurs whenever an OAuth Connection is created.
756
777
  OAUTH_CONNECTION_CREATED =
757
778
  T.let(
@@ -715,6 +715,13 @@ module Increase
715
715
  Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
716
716
  )
717
717
 
718
+ # Occurs whenever a Loan Obligation is created.
719
+ LOAN_OBLIGATION_CREATED =
720
+ T.let(
721
+ :"loan_obligation.created",
722
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
723
+ )
724
+
718
725
  # Occurs whenever a Loan Offer is created.
719
726
  LOAN_OFFER_CREATED =
720
727
  T.let(
@@ -750,6 +757,20 @@ module Increase
750
757
  Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
751
758
  )
752
759
 
760
+ # Occurs whenever a Lockbox Address is created.
761
+ LOCKBOX_ADDRESS_CREATED =
762
+ T.let(
763
+ :"lockbox_address.created",
764
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
765
+ )
766
+
767
+ # Occurs whenever a Lockbox Address is updated.
768
+ LOCKBOX_ADDRESS_UPDATED =
769
+ T.let(
770
+ :"lockbox_address.updated",
771
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
772
+ )
773
+
753
774
  # Occurs whenever an OAuth Connection is created.
754
775
  OAUTH_CONNECTION_CREATED =
755
776
  T.let(
@@ -47,12 +47,13 @@ module Increase
47
47
  sig { returns(Increase::File::Type::TaggedSymbol) }
48
48
  attr_accessor :type
49
49
 
50
- # Files are objects that represent a file hosted on Increase's servers. The file
51
- # may have been uploaded by you (for example, when uploading a check image) or it
52
- # may have been created by Increase (for example, an autogenerated statement PDF).
53
- # If you need to download a File, use the `/files/{file_id}/contents` endpoint. If
54
- # you need to share a File with someone who doesn't have access to your API key,
55
- # create a File Link.
50
+ # Files are objects that represent a file hosted on Increase's servers. Each File
51
+ # has a `purpose` that determines how Increase will use it. You upload a File so
52
+ # it can be attached to another object in the API (for example, when uploading a
53
+ # check image), or Increase creates one for you to download (for example, an
54
+ # autogenerated statement PDF). If you need to download a File, use the
55
+ # `/files/{file_id}/contents` endpoint. If you need to share a File with someone
56
+ # who doesn't have access to your API key, create a File Link.
56
57
  sig do
57
58
  params(
58
59
  id: String,
@@ -830,7 +830,7 @@ module Increase
830
830
  attr_accessor :originating_depository_financial_institution_branch_country
831
831
 
832
832
  # An identifier for the originating bank. One of an International Bank Account
833
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
833
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
834
834
  # domestic identifier like a US Routing Number.
835
835
  sig { returns(String) }
836
836
  attr_accessor :originating_depository_financial_institution_id
@@ -924,7 +924,7 @@ module Increase
924
924
  attr_accessor :receiving_depository_financial_institution_country
925
925
 
926
926
  # An identifier for the receiving bank. One of an International Bank Account
927
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
927
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
928
928
  # domestic identifier like a US Routing Number.
929
929
  sig { returns(String) }
930
930
  attr_accessor :receiving_depository_financial_institution_id
@@ -1015,7 +1015,7 @@ module Increase
1015
1015
  # country code of the originating branch country.
1016
1016
  originating_depository_financial_institution_branch_country:,
1017
1017
  # An identifier for the originating bank. One of an International Bank Account
1018
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
1018
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
1019
1019
  # domestic identifier like a US Routing Number.
1020
1020
  originating_depository_financial_institution_id:,
1021
1021
  # An instruction of how to interpret the
@@ -1065,7 +1065,7 @@ module Increase
1065
1065
  # country code of the receiving bank country.
1066
1066
  receiving_depository_financial_institution_country:,
1067
1067
  # An identifier for the receiving bank. One of an International Bank Account
1068
- # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
1068
+ # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
1069
1069
  # domestic identifier like a US Routing Number.
1070
1070
  receiving_depository_financial_institution_id:,
1071
1071
  # An instruction of how to interpret the
@@ -1400,7 +1400,7 @@ module Increase
1400
1400
  Increase::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol
1401
1401
  )
1402
1402
 
1403
- # The SWIFT Bank Identifier Code (BIC) of the bank.
1403
+ # The Swift Bank Identifier Code (BIC) of the bank.
1404
1404
  BIC_CODE =
1405
1405
  T.let(
1406
1406
  :bic_code,
@@ -1446,7 +1446,7 @@ module Increase
1446
1446
  Increase::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol
1447
1447
  )
1448
1448
 
1449
- # The SWIFT Bank Identifier Code (BIC) of the bank.
1449
+ # The Swift Bank Identifier Code (BIC) of the bank.
1450
1450
  BIC_CODE =
1451
1451
  T.let(
1452
1452
  :bic_code,
@@ -1491,6 +1491,14 @@ module Increase
1491
1491
  sig { returns(T.nilable(Integer)) }
1492
1492
  attr_accessor :network_risk_score
1493
1493
 
1494
+ # The ID of the Card Payment containing the original authorization or card
1495
+ # validation this transaction references. For a merchant-initiated transaction,
1496
+ # this is the Card Payment from when the card was first stored, which is typically
1497
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1498
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1499
+ sig { returns(T.nilable(String)) }
1500
+ attr_accessor :original_card_payment_id
1501
+
1494
1502
  # The identifier of the Pending Transaction associated with this Transaction.
1495
1503
  sig { returns(T.nilable(String)) }
1496
1504
  attr_accessor :pending_transaction_id
@@ -1598,6 +1606,7 @@ module Increase
1598
1606
  network_identifiers:
1599
1607
  Increase::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers::OrHash,
1600
1608
  network_risk_score: T.nilable(Integer),
1609
+ original_card_payment_id: T.nilable(String),
1601
1610
  pending_transaction_id: T.nilable(String),
1602
1611
  physical_card_id: T.nilable(String),
1603
1612
  presentment_amount: Integer,
@@ -1671,6 +1680,12 @@ module Increase
1671
1680
  # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1672
1681
  # score is from 0 to 999, where 999 is the riskiest.
1673
1682
  network_risk_score:,
1683
+ # The ID of the Card Payment containing the original authorization or card
1684
+ # validation this transaction references. For a merchant-initiated transaction,
1685
+ # this is the Card Payment from when the card was first stored, which is typically
1686
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1687
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1688
+ original_card_payment_id:,
1674
1689
  # The identifier of the Pending Transaction associated with this Transaction.
1675
1690
  pending_transaction_id:,
1676
1691
  # If the authorization was made in-person with a physical card, the Physical Card
@@ -1732,6 +1747,7 @@ module Increase
1732
1747
  network_identifiers:
1733
1748
  Increase::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers,
1734
1749
  network_risk_score: T.nilable(Integer),
1750
+ original_card_payment_id: T.nilable(String),
1735
1751
  pending_transaction_id: T.nilable(String),
1736
1752
  physical_card_id: T.nilable(String),
1737
1753
  presentment_amount: Integer,
@@ -1870,6 +1870,14 @@ module Increase
1870
1870
  sig { returns(T.nilable(Integer)) }
1871
1871
  attr_accessor :network_risk_score
1872
1872
 
1873
+ # The identifier of the Card Payment containing the original authorization or card
1874
+ # validation this transaction references. For a merchant-initiated transaction,
1875
+ # this is the Card Payment from when the card was first stored, which is typically
1876
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1877
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1878
+ sig { returns(T.nilable(String)) }
1879
+ attr_accessor :original_card_payment_id
1880
+
1873
1881
  # Whether or not the authorization supports partial approvals.
1874
1882
  sig do
1875
1883
  returns(
@@ -1989,6 +1997,7 @@ module Increase
1989
1997
  network_identifiers:
1990
1998
  Increase::RealTimeDecision::CardAuthorization::NetworkIdentifiers::OrHash,
1991
1999
  network_risk_score: T.nilable(Integer),
2000
+ original_card_payment_id: T.nilable(String),
1992
2001
  partial_approval_capability:
1993
2002
  Increase::RealTimeDecision::CardAuthorization::PartialApprovalCapability::OrSymbol,
1994
2003
  physical_card_id: T.nilable(String),
@@ -2057,6 +2066,12 @@ module Increase
2057
2066
  # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
2058
2067
  # score is from 0 to 999, where 999 is the riskiest.
2059
2068
  network_risk_score:,
2069
+ # The identifier of the Card Payment containing the original authorization or card
2070
+ # validation this transaction references. For a merchant-initiated transaction,
2071
+ # this is the Card Payment from when the card was first stored, which is typically
2072
+ # where the CVV2 was verified. The reference this is derived from is supplied by
2073
+ # the merchant or their acquirer, so it is not guaranteed to be present.
2074
+ original_card_payment_id:,
2060
2075
  # Whether or not the authorization supports partial approvals.
2061
2076
  partial_approval_capability:,
2062
2077
  # If the authorization was made in-person with a physical card, the Physical Card
@@ -2129,6 +2144,7 @@ module Increase
2129
2144
  network_identifiers:
2130
2145
  Increase::RealTimeDecision::CardAuthorization::NetworkIdentifiers,
2131
2146
  network_risk_score: T.nilable(Integer),
2147
+ original_card_payment_id: T.nilable(String),
2132
2148
  partial_approval_capability:
2133
2149
  Increase::RealTimeDecision::CardAuthorization::PartialApprovalCapability::TaggedSymbol,
2134
2150
  physical_card_id: T.nilable(String),
@@ -113,6 +113,11 @@ module Increase
113
113
  sig { returns(T.nilable(String)) }
114
114
  attr_accessor :idempotency_key
115
115
 
116
+ # The identifier of the Inbound Real-Time Payments Request for Payment this
117
+ # transfer was sent in response to, if any.
118
+ sig { returns(T.nilable(String)) }
119
+ attr_accessor :inbound_real_time_payments_request_for_payment_id
120
+
116
121
  # The ID for the pending transaction representing the transfer. A pending
117
122
  # transaction is created when the transfer
118
123
  # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
@@ -206,6 +211,7 @@ module Increase
206
211
  debtor_name: T.nilable(String),
207
212
  external_account_id: T.nilable(String),
208
213
  idempotency_key: T.nilable(String),
214
+ inbound_real_time_payments_request_for_payment_id: T.nilable(String),
209
215
  pending_transaction_id: T.nilable(String),
210
216
  rejection:
211
217
  T.nilable(Increase::RealTimePaymentsTransfer::Rejection::OrHash),
@@ -259,6 +265,9 @@ module Increase
259
265
  # Increase and is used to ensure that a request is only processed once. Learn more
260
266
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
261
267
  idempotency_key:,
268
+ # The identifier of the Inbound Real-Time Payments Request for Payment this
269
+ # transfer was sent in response to, if any.
270
+ inbound_real_time_payments_request_for_payment_id:,
262
271
  # The ID for the pending transaction representing the transfer. A pending
263
272
  # transaction is created when the transfer
264
273
  # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
@@ -314,6 +323,8 @@ module Increase
314
323
  debtor_name: T.nilable(String),
315
324
  external_account_id: T.nilable(String),
316
325
  idempotency_key: T.nilable(String),
326
+ inbound_real_time_payments_request_for_payment_id:
327
+ T.nilable(String),
317
328
  pending_transaction_id: T.nilable(String),
318
329
  rejection: T.nilable(Increase::RealTimePaymentsTransfer::Rejection),
319
330
  routing_number: String,
@@ -805,42 +816,42 @@ module Increase
805
816
  end
806
817
  OrSymbol = T.type_alias { T.any(Symbol, String) }
807
818
 
808
- # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.
819
+ # The destination account is closed. Corresponds to the Real-Time Payments reason code "AC04".
809
820
  ACCOUNT_CLOSED =
810
821
  T.let(
811
822
  :account_closed,
812
823
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
813
824
  )
814
825
 
815
- # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.
826
+ # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code "AC06".
816
827
  ACCOUNT_BLOCKED =
817
828
  T.let(
818
829
  :account_blocked,
819
830
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
820
831
  )
821
832
 
822
- # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.
833
+ # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code "AC14".
823
834
  INVALID_CREDITOR_ACCOUNT_TYPE =
824
835
  T.let(
825
836
  :invalid_creditor_account_type,
826
837
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
827
838
  )
828
839
 
829
- # The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.
840
+ # The destination account does not exist. Corresponds to the Real-Time Payments reason code "AC03".
830
841
  INVALID_CREDITOR_ACCOUNT_NUMBER =
831
842
  T.let(
832
843
  :invalid_creditor_account_number,
833
844
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
834
845
  )
835
846
 
836
- # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
847
+ # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code "RC04".
837
848
  INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER =
838
849
  T.let(
839
850
  :invalid_creditor_financial_institution_identifier,
840
851
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
841
852
  )
842
853
 
843
- # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.
854
+ # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code "MD07".
844
855
  END_CUSTOMER_DECEASED =
845
856
  T.let(
846
857
  :end_customer_deceased,
@@ -854,84 +865,84 @@ module Increase
854
865
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
855
866
  )
856
867
 
857
- # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.
868
+ # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code "AG01".
858
869
  TRANSACTION_FORBIDDEN =
859
870
  T.let(
860
871
  :transaction_forbidden,
861
872
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
862
873
  )
863
874
 
864
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.
875
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "AG03".
865
876
  TRANSACTION_TYPE_NOT_SUPPORTED =
866
877
  T.let(
867
878
  :transaction_type_not_supported,
868
879
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
869
880
  )
870
881
 
871
- # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
882
+ # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code "AM09".
872
883
  UNEXPECTED_AMOUNT =
873
884
  T.let(
874
885
  :unexpected_amount,
875
886
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
876
887
  )
877
888
 
878
- # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.
889
+ # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code "AM14".
879
890
  AMOUNT_EXCEEDS_BANK_LIMITS =
880
891
  T.let(
881
892
  :amount_exceeds_bank_limits,
882
893
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
883
894
  )
884
895
 
885
- # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
896
+ # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE04".
886
897
  INVALID_CREDITOR_ADDRESS =
887
898
  T.let(
888
899
  :invalid_creditor_address,
889
900
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
890
901
  )
891
902
 
892
- # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.
903
+ # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code "BE06".
893
904
  UNKNOWN_END_CUSTOMER =
894
905
  T.let(
895
906
  :unknown_end_customer,
896
907
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
897
908
  )
898
909
 
899
- # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.
910
+ # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE07".
900
911
  INVALID_DEBTOR_ADDRESS =
901
912
  T.let(
902
913
  :invalid_debtor_address,
903
914
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
904
915
  )
905
916
 
906
- # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.
917
+ # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code "DS24".
907
918
  TIMEOUT =
908
919
  T.let(
909
920
  :timeout,
910
921
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
911
922
  )
912
923
 
913
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.
924
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "NOAT".
914
925
  UNSUPPORTED_MESSAGE_FOR_RECIPIENT =
915
926
  T.let(
916
927
  :unsupported_message_for_recipient,
917
928
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
918
929
  )
919
930
 
920
- # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.
931
+ # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code "9912".
921
932
  RECIPIENT_CONNECTION_NOT_AVAILABLE =
922
933
  T.let(
923
934
  :recipient_connection_not_available,
924
935
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
925
936
  )
926
937
 
927
- # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.
938
+ # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code "9948".
928
939
  REAL_TIME_PAYMENTS_SUSPENDED =
929
940
  T.let(
930
941
  :real_time_payments_suspended,
931
942
  Increase::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol
932
943
  )
933
944
 
934
- # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.
945
+ # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code "9910".
935
946
  INSTRUCTED_AGENT_SIGNED_OFF =
936
947
  T.let(
937
948
  :instructed_agent_signed_off,
@@ -54,6 +54,16 @@ module Increase
54
54
  sig { params(external_account_id: String).void }
55
55
  attr_writer :external_account_id
56
56
 
57
+ # The ID of an Inbound Real-Time Payments Request for Payment in response to which
58
+ # this transfer is being sent.
59
+ sig { returns(T.nilable(String)) }
60
+ attr_reader :inbound_real_time_payments_request_for_payment_id
61
+
62
+ sig do
63
+ params(inbound_real_time_payments_request_for_payment_id: String).void
64
+ end
65
+ attr_writer :inbound_real_time_payments_request_for_payment_id
66
+
57
67
  # Whether the transfer requires explicit approval via the dashboard or API.
58
68
  sig { returns(T.nilable(T::Boolean)) }
59
69
  attr_reader :require_approval
@@ -94,6 +104,7 @@ module Increase
94
104
  account_number: String,
95
105
  debtor_name: String,
96
106
  external_account_id: String,
107
+ inbound_real_time_payments_request_for_payment_id: String,
97
108
  require_approval: T::Boolean,
98
109
  routing_number: String,
99
110
  ultimate_creditor_name: String,
@@ -119,6 +130,9 @@ module Increase
119
130
  # The ID of an External Account to initiate a transfer to. If this parameter is
120
131
  # provided, `account_number` and `routing_number` must be absent.
121
132
  external_account_id: nil,
133
+ # The ID of an Inbound Real-Time Payments Request for Payment in response to which
134
+ # this transfer is being sent.
135
+ inbound_real_time_payments_request_for_payment_id: nil,
122
136
  # Whether the transfer requires explicit approval via the dashboard or API.
123
137
  require_approval: nil,
124
138
  # The destination American Bankers' Association (ABA) Routing Transit Number
@@ -144,6 +158,7 @@ module Increase
144
158
  account_number: String,
145
159
  debtor_name: String,
146
160
  external_account_id: String,
161
+ inbound_real_time_payments_request_for_payment_id: String,
147
162
  require_approval: T::Boolean,
148
163
  routing_number: String,
149
164
  ultimate_creditor_name: String,
@@ -206,6 +206,25 @@ module Increase
206
206
  end
207
207
  attr_writer :receive_merchant_prearbitration
208
208
 
209
+ # The parameters for rejecting the dispute. Required if and only if `action` is
210
+ # `reject`.
211
+ sig do
212
+ returns(
213
+ T.nilable(
214
+ Increase::Simulations::CardDisputeActionParams::Visa::Reject
215
+ )
216
+ )
217
+ end
218
+ attr_reader :reject
219
+
220
+ sig do
221
+ params(
222
+ reject:
223
+ Increase::Simulations::CardDisputeActionParams::Visa::Reject::OrHash
224
+ ).void
225
+ end
226
+ attr_writer :reject
227
+
209
228
  # The parameters for re-presenting the dispute. Required if and only if `action`
210
229
  # is `represent`.
211
230
  sig do
@@ -334,6 +353,8 @@ module Increase
334
353
  Increase::Simulations::CardDisputeActionParams::Visa::DeclineUserPrearbitration::OrHash,
335
354
  receive_merchant_prearbitration:
336
355
  Increase::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration::OrHash,
356
+ reject:
357
+ Increase::Simulations::CardDisputeActionParams::Visa::Reject::OrHash,
337
358
  represent:
338
359
  Increase::Simulations::CardDisputeActionParams::Visa::Represent::OrHash,
339
360
  request_further_information:
@@ -364,6 +385,9 @@ module Increase
364
385
  # The parameters for receiving the prearbitration. Required if and only if
365
386
  # `action` is `receive_merchant_prearbitration`.
366
387
  receive_merchant_prearbitration: nil,
388
+ # The parameters for rejecting the dispute. Required if and only if `action` is
389
+ # `reject`.
390
+ reject: nil,
367
391
  # The parameters for re-presenting the dispute. Required if and only if `action`
368
392
  # is `represent`.
369
393
  represent: nil,
@@ -398,6 +422,8 @@ module Increase
398
422
  Increase::Simulations::CardDisputeActionParams::Visa::DeclineUserPrearbitration,
399
423
  receive_merchant_prearbitration:
400
424
  Increase::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration,
425
+ reject:
426
+ Increase::Simulations::CardDisputeActionParams::Visa::Reject,
401
427
  represent:
402
428
  Increase::Simulations::CardDisputeActionParams::Visa::Represent,
403
429
  request_further_information:
@@ -458,6 +484,13 @@ module Increase
458
484
  Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
459
485
  )
460
486
 
487
+ # Simulate the dispute being rejected before it is submitted to the network. This will move the dispute to a `rejected` state.
488
+ REJECT =
489
+ T.let(
490
+ :reject,
491
+ Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
492
+ )
493
+
461
494
  # Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
462
495
  REPRESENT =
463
496
  T.let(
@@ -591,6 +624,33 @@ module Increase
591
624
  end
592
625
  end
593
626
 
627
+ class Reject < Increase::Internal::Type::BaseModel
628
+ OrHash =
629
+ T.type_alias do
630
+ T.any(
631
+ Increase::Simulations::CardDisputeActionParams::Visa::Reject,
632
+ Increase::Internal::AnyHash
633
+ )
634
+ end
635
+
636
+ # The explanation for rejecting the dispute.
637
+ sig { returns(String) }
638
+ attr_accessor :explanation
639
+
640
+ # The parameters for rejecting the dispute. Required if and only if `action` is
641
+ # `reject`.
642
+ sig { params(explanation: String).returns(T.attached_class) }
643
+ def self.new(
644
+ # The explanation for rejecting the dispute.
645
+ explanation:
646
+ )
647
+ end
648
+
649
+ sig { override.returns({ explanation: String }) }
650
+ def to_hash
651
+ end
652
+ end
653
+
594
654
  class Represent < Increase::Internal::Type::BaseModel
595
655
  OrHash =
596
656
  T.type_alias do
@@ -130,6 +130,13 @@ module Increase
130
130
  Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
131
131
  )
132
132
 
133
+ # 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).
134
+ ENTITY_IDENTITY =
135
+ T.let(
136
+ :entity_identity,
137
+ Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
138
+ )
139
+
133
140
  # 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).
134
141
  BENEFICIAL_OWNER_IDENTITY =
135
142
  T.let(