straddle 0.3.0 → 0.4.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +74 -0
- data/README.md +10 -1
- data/lib/straddle/client.rb +34 -0
- data/lib/straddle/internal/transport/pooled_net_requester.rb +13 -11
- data/lib/straddle/internal/util.rb +39 -3
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +8 -0
- data/lib/straddle/models/bridge/link_create_tan_response.rb +8 -0
- data/lib/straddle/models/charge_cancel_params.rb +8 -1
- data/lib/straddle/models/charge_create_params.rb +20 -4
- data/lib/straddle/models/charge_get_params.rb +7 -1
- data/lib/straddle/models/charge_hold_params.rb +8 -1
- data/lib/straddle/models/charge_release_params.rb +8 -1
- data/lib/straddle/models/charge_unmask_params.rb +7 -1
- data/lib/straddle/models/charge_unmask_response.rb +59 -5
- data/lib/straddle/models/charge_update_params.rb +11 -4
- data/lib/straddle/models/charge_v1.rb +59 -5
- data/lib/straddle/models/customer_delete_params.rb +7 -1
- data/lib/straddle/models/customer_get_params.rb +7 -1
- data/lib/straddle/models/customer_unmasked_params.rb +7 -1
- data/lib/straddle/models/customer_update_params.rb +8 -1
- data/lib/straddle/models/customers/review_decision_params.rb +8 -1
- data/lib/straddle/models/customers/review_get_params.rb +7 -1
- data/lib/straddle/models/customers/review_refresh_review_params.rb +7 -1
- data/lib/straddle/models/embed/account_get_params.rb +11 -1
- data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
- data/lib/straddle/models/embed/account_paged_v1.rb +4 -0
- data/lib/straddle/models/embed/account_simulate_params.rb +7 -1
- data/lib/straddle/models/embed/account_update_params.rb +8 -1
- data/lib/straddle/models/embed/account_v1.rb +4 -0
- data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
- data/lib/straddle/models/embed/accounts/capability_request_list_params.rb +8 -1
- data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +9 -1
- data/lib/straddle/models/embed/address_v1.rb +14 -38
- data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_get_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
- data/lib/straddle/models/embed/organization_get_params.rb +7 -1
- data/lib/straddle/models/embed/representative_get_params.rb +7 -1
- data/lib/straddle/models/embed/representative_unmask_params.rb +7 -1
- data/lib/straddle/models/embed/representative_update_params.rb +8 -1
- data/lib/straddle/models/funding_event_get_params.rb +7 -1
- data/lib/straddle/models/funding_event_list_params.rb +105 -1
- data/lib/straddle/models/funding_event_summary_item_v1.rb +128 -1
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +128 -1
- data/lib/straddle/models/paykey_cancel_params.rb +7 -1
- data/lib/straddle/models/paykey_get_params.rb +7 -1
- data/lib/straddle/models/paykey_list_params.rb +24 -1
- data/lib/straddle/models/paykey_reveal_params.rb +7 -1
- data/lib/straddle/models/paykey_reveal_response.rb +8 -0
- data/lib/straddle/models/paykey_summary_paged_v1.rb +19 -1
- data/lib/straddle/models/paykey_unmasked_params.rb +7 -1
- data/lib/straddle/models/paykey_unmasked_v1.rb +8 -0
- data/lib/straddle/models/paykey_update_balance_params.rb +7 -1
- data/lib/straddle/models/paykey_v1.rb +19 -1
- data/lib/straddle/models/paykeys/review_decision_params.rb +7 -1
- data/lib/straddle/models/paykeys/review_get_params.rb +7 -1
- data/lib/straddle/models/paykeys/review_get_response.rb +19 -4
- data/lib/straddle/models/paykeys/review_refresh_review_params.rb +7 -1
- data/lib/straddle/models/payment_list_params.rb +17 -1
- data/lib/straddle/models/payment_summary_paged_v1.rb +13 -4
- data/lib/straddle/models/payout_cancel_params.rb +8 -1
- data/lib/straddle/models/payout_create_params.rb +20 -4
- data/lib/straddle/models/payout_get_params.rb +7 -1
- data/lib/straddle/models/payout_hold_params.rb +8 -1
- data/lib/straddle/models/payout_release_params.rb +8 -1
- data/lib/straddle/models/payout_unmask_params.rb +7 -1
- data/lib/straddle/models/payout_unmask_response.rb +59 -5
- data/lib/straddle/models/payout_update_params.rb +11 -4
- data/lib/straddle/models/payout_v1.rb +59 -5
- data/lib/straddle/models/status_details_v1.rb +7 -0
- data/lib/straddle/resources/bridge/link.rb +12 -6
- data/lib/straddle/resources/bridge.rb +13 -1
- data/lib/straddle/resources/charges.rb +13 -8
- data/lib/straddle/resources/customers/review.rb +7 -1
- data/lib/straddle/resources/customers.rb +23 -10
- data/lib/straddle/resources/embed/accounts/capability_requests.rb +9 -4
- data/lib/straddle/resources/embed/accounts.rb +25 -14
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +11 -6
- data/lib/straddle/resources/embed/organizations.rb +7 -2
- data/lib/straddle/resources/embed/representatives.rb +15 -8
- data/lib/straddle/resources/embed.rb +19 -0
- data/lib/straddle/resources/funding_events.rb +22 -3
- data/lib/straddle/resources/paykeys/review.rb +7 -2
- data/lib/straddle/resources/paykeys.rb +36 -11
- data/lib/straddle/resources/payments.rb +12 -6
- data/lib/straddle/resources/payouts.rb +11 -7
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +1 -0
- data/manifest.yaml +1 -0
- data/rbi/straddle/client.rbi +34 -0
- data/rbi/straddle/internal/util.rbi +21 -1
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +40 -0
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +40 -0
- data/rbi/straddle/models/charge_cancel_params.rbi +6 -0
- data/rbi/straddle/models/charge_create_params.rbi +19 -3
- data/rbi/straddle/models/charge_get_params.rbi +6 -0
- data/rbi/straddle/models/charge_hold_params.rbi +6 -0
- data/rbi/straddle/models/charge_release_params.rbi +6 -0
- data/rbi/straddle/models/charge_unmask_params.rbi +6 -0
- data/rbi/straddle/models/charge_unmask_response.rbi +143 -6
- data/rbi/straddle/models/charge_update_params.rbi +9 -3
- data/rbi/straddle/models/charge_v1.rbi +135 -6
- data/rbi/straddle/models/customer_delete_params.rbi +6 -0
- data/rbi/straddle/models/customer_get_params.rbi +6 -0
- data/rbi/straddle/models/customer_unmasked_params.rbi +6 -0
- data/rbi/straddle/models/customer_update_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_decision_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_get_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_refresh_review_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_get_params.rbi +13 -1
- data/rbi/straddle/models/embed/account_onboard_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_paged_v1.rbi +20 -0
- data/rbi/straddle/models/embed/account_simulate_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_update_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_v1.rbi +20 -0
- data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +6 -0
- data/rbi/straddle/models/embed/accounts/capability_request_list_params.rbi +6 -0
- data/rbi/straddle/models/embed/accounts/capability_request_paged_v1.rbi +8 -0
- data/rbi/straddle/models/embed/address_v1.rbi +18 -42
- data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +6 -0
- data/rbi/straddle/models/embed/linked_bank_account_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/linked_bank_account_unmask_params.rbi +11 -1
- data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +6 -0
- data/rbi/straddle/models/embed/organization_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_unmask_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_update_params.rbi +6 -0
- data/rbi/straddle/models/funding_event_get_params.rbi +6 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +333 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +392 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +393 -0
- data/rbi/straddle/models/paykey_cancel_params.rbi +6 -0
- data/rbi/straddle/models/paykey_get_params.rbi +6 -0
- data/rbi/straddle/models/paykey_list_params.rbi +30 -0
- data/rbi/straddle/models/paykey_reveal_params.rbi +6 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +40 -0
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +55 -3
- data/rbi/straddle/models/paykey_unmasked_params.rbi +6 -0
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +40 -0
- data/rbi/straddle/models/paykey_update_balance_params.rbi +6 -0
- data/rbi/straddle/models/paykey_v1.rbi +52 -3
- data/rbi/straddle/models/paykeys/review_decision_params.rbi +6 -0
- data/rbi/straddle/models/paykeys/review_get_params.rbi +6 -0
- data/rbi/straddle/models/paykeys/review_get_response.rbi +55 -18
- data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +6 -0
- data/rbi/straddle/models/payment_list_params.rbi +51 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +16 -3
- data/rbi/straddle/models/payout_cancel_params.rbi +6 -0
- data/rbi/straddle/models/payout_create_params.rbi +19 -3
- data/rbi/straddle/models/payout_get_params.rbi +6 -0
- data/rbi/straddle/models/payout_hold_params.rbi +6 -0
- data/rbi/straddle/models/payout_release_params.rbi +6 -0
- data/rbi/straddle/models/payout_unmask_params.rbi +6 -0
- data/rbi/straddle/models/payout_unmask_response.rbi +140 -3
- data/rbi/straddle/models/payout_update_params.rbi +9 -3
- data/rbi/straddle/models/payout_v1.rbi +132 -3
- data/rbi/straddle/models/status_details_v1.rbi +29 -0
- data/rbi/straddle/resources/bridge/link.rbi +12 -6
- data/rbi/straddle/resources/bridge.rbi +13 -1
- data/rbi/straddle/resources/charges.rbi +13 -8
- data/rbi/straddle/resources/customers/review.rbi +7 -1
- data/rbi/straddle/resources/customers.rbi +20 -8
- data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +6 -2
- data/rbi/straddle/resources/embed/accounts.rbi +19 -10
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +8 -4
- data/rbi/straddle/resources/embed/organizations.rbi +4 -0
- data/rbi/straddle/resources/embed/representatives.rbi +12 -6
- data/rbi/straddle/resources/embed.rbi +19 -0
- data/rbi/straddle/resources/funding_events.rbi +27 -0
- data/rbi/straddle/resources/paykeys/review.rbi +7 -2
- data/rbi/straddle/resources/paykeys.rbi +26 -8
- data/rbi/straddle/resources/payments.rbi +8 -3
- data/rbi/straddle/resources/payouts.rbi +11 -7
- data/sig/straddle/internal/util.rbs +10 -0
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +17 -1
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +17 -1
- data/sig/straddle/models/charge_cancel_params.rbs +5 -0
- data/sig/straddle/models/charge_create_params.rbs +14 -4
- data/sig/straddle/models/charge_get_params.rbs +5 -0
- data/sig/straddle/models/charge_hold_params.rbs +5 -0
- data/sig/straddle/models/charge_release_params.rbs +5 -0
- data/sig/straddle/models/charge_unmask_params.rbs +5 -0
- data/sig/straddle/models/charge_unmask_response.rbs +57 -7
- data/sig/straddle/models/charge_update_params.rbs +9 -4
- data/sig/straddle/models/charge_v1.rbs +57 -7
- data/sig/straddle/models/customer_delete_params.rbs +5 -0
- data/sig/straddle/models/customer_get_params.rbs +5 -0
- data/sig/straddle/models/customer_unmasked_params.rbs +5 -0
- data/sig/straddle/models/customer_update_params.rbs +5 -0
- data/sig/straddle/models/customers/review_decision_params.rbs +5 -0
- data/sig/straddle/models/customers/review_get_params.rbs +5 -0
- data/sig/straddle/models/customers/review_refresh_review_params.rbs +5 -0
- data/sig/straddle/models/embed/account_get_params.rbs +5 -1
- data/sig/straddle/models/embed/account_onboard_params.rbs +5 -0
- data/sig/straddle/models/embed/account_paged_v1.rbs +18 -2
- data/sig/straddle/models/embed/account_simulate_params.rbs +5 -0
- data/sig/straddle/models/embed/account_update_params.rbs +5 -0
- data/sig/straddle/models/embed/account_v1.rbs +18 -2
- data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +5 -0
- data/sig/straddle/models/embed/accounts/capability_request_list_params.rbs +5 -0
- data/sig/straddle/models/embed/accounts/capability_request_paged_v1.rbs +5 -0
- data/sig/straddle/models/embed/address_v1.rbs +12 -27
- data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +10 -1
- data/sig/straddle/models/embed/linked_bank_account_get_params.rbs +9 -1
- data/sig/straddle/models/embed/linked_bank_account_unmask_params.rbs +9 -1
- data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +5 -0
- data/sig/straddle/models/embed/organization_get_params.rbs +5 -1
- data/sig/straddle/models/embed/representative_get_params.rbs +9 -1
- data/sig/straddle/models/embed/representative_unmask_params.rbs +9 -1
- data/sig/straddle/models/embed/representative_update_params.rbs +5 -0
- data/sig/straddle/models/funding_event_get_params.rbs +5 -0
- data/sig/straddle/models/funding_event_list_params.rbs +125 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +164 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +164 -0
- data/sig/straddle/models/paykey_cancel_params.rbs +5 -0
- data/sig/straddle/models/paykey_get_params.rbs +5 -0
- data/sig/straddle/models/paykey_list_params.rbs +17 -1
- data/sig/straddle/models/paykey_reveal_params.rbs +5 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +17 -1
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +25 -4
- data/sig/straddle/models/paykey_unmasked_params.rbs +5 -0
- data/sig/straddle/models/paykey_unmasked_v1.rbs +17 -1
- data/sig/straddle/models/paykey_update_balance_params.rbs +5 -0
- data/sig/straddle/models/paykey_v1.rbs +25 -4
- data/sig/straddle/models/paykeys/review_decision_params.rbs +5 -0
- data/sig/straddle/models/paykeys/review_get_params.rbs +5 -0
- data/sig/straddle/models/paykeys/review_get_response.rbs +28 -10
- data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +5 -0
- data/sig/straddle/models/payment_list_params.rbs +23 -0
- data/sig/straddle/models/payment_summary_paged_v1.rbs +11 -4
- data/sig/straddle/models/payout_cancel_params.rbs +5 -0
- data/sig/straddle/models/payout_create_params.rbs +14 -4
- data/sig/straddle/models/payout_get_params.rbs +5 -0
- data/sig/straddle/models/payout_hold_params.rbs +5 -0
- data/sig/straddle/models/payout_release_params.rbs +5 -0
- data/sig/straddle/models/payout_unmask_params.rbs +5 -0
- data/sig/straddle/models/payout_unmask_response.rbs +54 -4
- data/sig/straddle/models/payout_update_params.rbs +9 -4
- data/sig/straddle/models/payout_v1.rbs +54 -4
- data/sig/straddle/models/status_details_v1.rbs +14 -0
- data/sig/straddle/resources/charges.rbs +2 -2
- data/sig/straddle/resources/funding_events.rbs +4 -0
- data/sig/straddle/resources/paykeys.rbs +2 -0
- data/sig/straddle/resources/payments.rbs +1 -0
- data/sig/straddle/resources/payouts.rbs +2 -2
- metadata +16 -2
|
@@ -7,6 +7,11 @@ module Straddle
|
|
|
7
7
|
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Straddle::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute reason
|
|
11
16
|
# Details about why the payout status was updated.
|
|
12
17
|
#
|
|
@@ -33,7 +38,9 @@ module Straddle
|
|
|
33
38
|
# @return [String, nil]
|
|
34
39
|
optional :straddle_account_id, String
|
|
35
40
|
|
|
36
|
-
# @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
41
|
+
# @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
42
|
+
# @param id [String]
|
|
43
|
+
#
|
|
37
44
|
# @param reason [String] Details about why the payout status was updated.
|
|
38
45
|
#
|
|
39
46
|
# @param correlation_id [String]
|
|
@@ -7,6 +7,11 @@ module Straddle
|
|
|
7
7
|
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Straddle::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute correlation_id
|
|
11
16
|
#
|
|
12
17
|
# @return [String, nil]
|
|
@@ -22,7 +27,8 @@ module Straddle
|
|
|
22
27
|
# @return [String, nil]
|
|
23
28
|
optional :straddle_account_id, String
|
|
24
29
|
|
|
25
|
-
# @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
30
|
+
# @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
31
|
+
# @param id [String]
|
|
26
32
|
# @param correlation_id [String]
|
|
27
33
|
# @param request_id [String]
|
|
28
34
|
# @param straddle_account_id [String]
|
|
@@ -65,8 +65,8 @@ module Straddle
|
|
|
65
65
|
# @!attribute description
|
|
66
66
|
# Description.
|
|
67
67
|
#
|
|
68
|
-
# @return [String]
|
|
69
|
-
required :description, String
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
required :description, String, nil?: true
|
|
70
70
|
|
|
71
71
|
# @!attribute device
|
|
72
72
|
#
|
|
@@ -115,6 +115,12 @@ module Straddle
|
|
|
115
115
|
required :status_history,
|
|
116
116
|
-> { Straddle::Internal::Type::ArrayOf[Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory] }
|
|
117
117
|
|
|
118
|
+
# @!attribute trace_ids
|
|
119
|
+
# Trace Ids.
|
|
120
|
+
#
|
|
121
|
+
# @return [Hash{Symbol=>String}]
|
|
122
|
+
required :trace_ids, Straddle::Internal::Type::HashOf[String]
|
|
123
|
+
|
|
118
124
|
# @!attribute created_at
|
|
119
125
|
# Created at.
|
|
120
126
|
#
|
|
@@ -156,13 +162,21 @@ module Straddle
|
|
|
156
162
|
# @return [Time, nil]
|
|
157
163
|
optional :processed_at, Time, nil?: true
|
|
158
164
|
|
|
165
|
+
# @!attribute related_payments
|
|
166
|
+
# Related payments.
|
|
167
|
+
#
|
|
168
|
+
# @return [Hash{Symbol=>Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment}, nil]
|
|
169
|
+
optional :related_payments,
|
|
170
|
+
-> { Straddle::Internal::Type::HashOf[enum: Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment] },
|
|
171
|
+
nil?: true
|
|
172
|
+
|
|
159
173
|
# @!attribute updated_at
|
|
160
174
|
# Updated at.
|
|
161
175
|
#
|
|
162
176
|
# @return [Time, nil]
|
|
163
177
|
optional :updated_at, Time, nil?: true
|
|
164
178
|
|
|
165
|
-
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, updated_at: nil)
|
|
179
|
+
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
|
|
166
180
|
# @param id [String] Id.
|
|
167
181
|
#
|
|
168
182
|
# @param amount [Integer] Amount.
|
|
@@ -171,7 +185,7 @@ module Straddle
|
|
|
171
185
|
#
|
|
172
186
|
# @param currency [String] Currency.
|
|
173
187
|
#
|
|
174
|
-
# @param description [String] Description.
|
|
188
|
+
# @param description [String, nil] Description.
|
|
175
189
|
#
|
|
176
190
|
# @param device [Straddle::Models::PayoutUnmaskResponse::Data::Device]
|
|
177
191
|
#
|
|
@@ -189,6 +203,8 @@ module Straddle
|
|
|
189
203
|
#
|
|
190
204
|
# @param status_history [Array<Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory>] Status history.
|
|
191
205
|
#
|
|
206
|
+
# @param trace_ids [Hash{Symbol=>String}] Trace Ids.
|
|
207
|
+
#
|
|
192
208
|
# @param created_at [Time, nil] Created at.
|
|
193
209
|
#
|
|
194
210
|
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
|
|
@@ -203,10 +219,24 @@ module Straddle
|
|
|
203
219
|
#
|
|
204
220
|
# @param processed_at [Time, nil] Processed at.
|
|
205
221
|
#
|
|
222
|
+
# @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment}, nil] Related payments.
|
|
223
|
+
#
|
|
206
224
|
# @param updated_at [Time, nil] Updated at.
|
|
207
225
|
|
|
208
226
|
# @see Straddle::Models::PayoutUnmaskResponse::Data#config
|
|
209
227
|
class Config < Straddle::Internal::Type::BaseModel
|
|
228
|
+
# @!attribute auto_hold
|
|
229
|
+
# Defines whether to automatically place this charge on hold after being created.
|
|
230
|
+
#
|
|
231
|
+
# @return [Boolean, nil]
|
|
232
|
+
optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
|
|
233
|
+
|
|
234
|
+
# @!attribute auto_hold_message
|
|
235
|
+
# The reason the payout is being automatically held on creation.
|
|
236
|
+
#
|
|
237
|
+
# @return [String, nil]
|
|
238
|
+
optional :auto_hold_message, String, nil?: true
|
|
239
|
+
|
|
210
240
|
# @!attribute sandbox_outcome
|
|
211
241
|
# Payment will simulate processing if not Standard.
|
|
212
242
|
#
|
|
@@ -214,7 +244,11 @@ module Straddle
|
|
|
214
244
|
optional :sandbox_outcome,
|
|
215
245
|
enum: -> { Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome }
|
|
216
246
|
|
|
217
|
-
# @!method initialize(sandbox_outcome: nil)
|
|
247
|
+
# @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
|
|
248
|
+
# @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
|
|
249
|
+
#
|
|
250
|
+
# @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
|
|
251
|
+
#
|
|
218
252
|
# @param sandbox_outcome [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
|
|
219
253
|
|
|
220
254
|
# Payment will simulate processing if not Standard.
|
|
@@ -266,6 +300,7 @@ module Straddle
|
|
|
266
300
|
PENDING = :pending
|
|
267
301
|
PAID = :paid
|
|
268
302
|
REVERSED = :reversed
|
|
303
|
+
VALIDATING = :validating
|
|
269
304
|
|
|
270
305
|
# @!method self.values
|
|
271
306
|
# @return [Array<Symbol>]
|
|
@@ -353,6 +388,13 @@ module Straddle
|
|
|
353
388
|
OK = :ok
|
|
354
389
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
355
390
|
PAYOUT_REFUSED = :payout_refused
|
|
391
|
+
CANCEL_REQUEST = :cancel_request
|
|
392
|
+
FAILED_VERIFICATION = :failed_verification
|
|
393
|
+
REQUIRE_REVIEW = :require_review
|
|
394
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
395
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
396
|
+
VALIDATING = :validating
|
|
397
|
+
AUTO_HOLD = :auto_hold
|
|
356
398
|
|
|
357
399
|
# @!method self.values
|
|
358
400
|
# @return [Array<Symbol>]
|
|
@@ -389,6 +431,7 @@ module Straddle
|
|
|
389
431
|
PENDING = :pending
|
|
390
432
|
PAID = :paid
|
|
391
433
|
REVERSED = :reversed
|
|
434
|
+
VALIDATING = :validating
|
|
392
435
|
|
|
393
436
|
# @!method self.values
|
|
394
437
|
# @return [Array<Symbol>]
|
|
@@ -406,6 +449,17 @@ module Straddle
|
|
|
406
449
|
# @!method self.values
|
|
407
450
|
# @return [Array<Symbol>]
|
|
408
451
|
end
|
|
452
|
+
|
|
453
|
+
module RelatedPayment
|
|
454
|
+
extend Straddle::Internal::Type::Enum
|
|
455
|
+
|
|
456
|
+
ORIGINAL = :original
|
|
457
|
+
RESUBMIT = :resubmit
|
|
458
|
+
REFUND = :refund
|
|
459
|
+
|
|
460
|
+
# @!method self.values
|
|
461
|
+
# @return [Array<Symbol>]
|
|
462
|
+
end
|
|
409
463
|
end
|
|
410
464
|
|
|
411
465
|
# Indicates the structure of the returned content.
|
|
@@ -7,6 +7,11 @@ module Straddle
|
|
|
7
7
|
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Straddle::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute amount
|
|
11
16
|
# The amount of the payout in cents.
|
|
12
17
|
#
|
|
@@ -16,8 +21,8 @@ module Straddle
|
|
|
16
21
|
# @!attribute description
|
|
17
22
|
# An arbitrary description for the payout.
|
|
18
23
|
#
|
|
19
|
-
# @return [String]
|
|
20
|
-
required :description, String
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
required :description, String, nil?: true
|
|
21
26
|
|
|
22
27
|
# @!attribute payment_date
|
|
23
28
|
# The desired date on which the payment should be occur. For payouts, this means
|
|
@@ -53,13 +58,15 @@ module Straddle
|
|
|
53
58
|
# @return [String, nil]
|
|
54
59
|
optional :straddle_account_id, String
|
|
55
60
|
|
|
56
|
-
# @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
61
|
+
# @!method initialize(id:, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
57
62
|
# Some parameter documentations has been truncated, see
|
|
58
63
|
# {Straddle::Models::PayoutUpdateParams} for more details.
|
|
59
64
|
#
|
|
65
|
+
# @param id [String]
|
|
66
|
+
#
|
|
60
67
|
# @param amount [Integer] The amount of the payout in cents.
|
|
61
68
|
#
|
|
62
|
-
# @param description [String] An arbitrary description for the payout.
|
|
69
|
+
# @param description [String, nil] An arbitrary description for the payout.
|
|
63
70
|
#
|
|
64
71
|
# @param payment_date [Date] The desired date on which the payment should be occur. For payouts, this means t
|
|
65
72
|
#
|
|
@@ -66,8 +66,8 @@ module Straddle
|
|
|
66
66
|
# @!attribute description
|
|
67
67
|
# An arbitrary description for the payout.
|
|
68
68
|
#
|
|
69
|
-
# @return [String]
|
|
70
|
-
required :description, String
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
required :description, String, nil?: true
|
|
71
71
|
|
|
72
72
|
# @!attribute device
|
|
73
73
|
# Information about the device used when the customer authorized the payout.
|
|
@@ -120,6 +120,12 @@ module Straddle
|
|
|
120
120
|
required :status_history,
|
|
121
121
|
-> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::StatusHistory] }
|
|
122
122
|
|
|
123
|
+
# @!attribute trace_ids
|
|
124
|
+
# Trace Ids.
|
|
125
|
+
#
|
|
126
|
+
# @return [Hash{Symbol=>String}]
|
|
127
|
+
required :trace_ids, Straddle::Internal::Type::HashOf[String]
|
|
128
|
+
|
|
123
129
|
# @!attribute created_at
|
|
124
130
|
# The time the payout was created.
|
|
125
131
|
#
|
|
@@ -165,13 +171,21 @@ module Straddle
|
|
|
165
171
|
# @return [Time, nil]
|
|
166
172
|
optional :processed_at, Time, nil?: true
|
|
167
173
|
|
|
174
|
+
# @!attribute related_payments
|
|
175
|
+
# Related payments.
|
|
176
|
+
#
|
|
177
|
+
# @return [Hash{Symbol=>Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment}, nil]
|
|
178
|
+
optional :related_payments,
|
|
179
|
+
-> { Straddle::Internal::Type::HashOf[enum: Straddle::PayoutV1::Data::RelatedPayment] },
|
|
180
|
+
nil?: true
|
|
181
|
+
|
|
168
182
|
# @!attribute updated_at
|
|
169
183
|
# The time the payout was last updated.
|
|
170
184
|
#
|
|
171
185
|
# @return [Time, nil]
|
|
172
186
|
optional :updated_at, Time, nil?: true
|
|
173
187
|
|
|
174
|
-
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, updated_at: nil)
|
|
188
|
+
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
|
|
175
189
|
# Some parameter documentations has been truncated, see
|
|
176
190
|
# {Straddle::Models::PayoutV1::Data} for more details.
|
|
177
191
|
#
|
|
@@ -183,7 +197,7 @@ module Straddle
|
|
|
183
197
|
#
|
|
184
198
|
# @param currency [String] The currency of the payout. Only USD is supported.
|
|
185
199
|
#
|
|
186
|
-
# @param description [String] An arbitrary description for the payout.
|
|
200
|
+
# @param description [String, nil] An arbitrary description for the payout.
|
|
187
201
|
#
|
|
188
202
|
# @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
|
|
189
203
|
#
|
|
@@ -201,6 +215,8 @@ module Straddle
|
|
|
201
215
|
#
|
|
202
216
|
# @param status_history [Array<Straddle::Models::PayoutV1::Data::StatusHistory>] History of the status changes for the payout.
|
|
203
217
|
#
|
|
218
|
+
# @param trace_ids [Hash{Symbol=>String}] Trace Ids.
|
|
219
|
+
#
|
|
204
220
|
# @param created_at [Time, nil] The time the payout was created.
|
|
205
221
|
#
|
|
206
222
|
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the payout.
|
|
@@ -215,19 +231,37 @@ module Straddle
|
|
|
215
231
|
#
|
|
216
232
|
# @param processed_at [Time, nil] The time the payout was processed by Straddle and originated to the payment rail
|
|
217
233
|
#
|
|
234
|
+
# @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment}, nil] Related payments.
|
|
235
|
+
#
|
|
218
236
|
# @param updated_at [Time, nil] The time the payout was last updated.
|
|
219
237
|
|
|
220
238
|
# @see Straddle::Models::PayoutV1::Data#config
|
|
221
239
|
class Config < Straddle::Internal::Type::BaseModel
|
|
240
|
+
# @!attribute auto_hold
|
|
241
|
+
# Defines whether to automatically place this charge on hold after being created.
|
|
242
|
+
#
|
|
243
|
+
# @return [Boolean, nil]
|
|
244
|
+
optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
|
|
245
|
+
|
|
246
|
+
# @!attribute auto_hold_message
|
|
247
|
+
# The reason the payout is being automatically held on creation.
|
|
248
|
+
#
|
|
249
|
+
# @return [String, nil]
|
|
250
|
+
optional :auto_hold_message, String, nil?: true
|
|
251
|
+
|
|
222
252
|
# @!attribute sandbox_outcome
|
|
223
253
|
# Payment will simulate processing if not Standard.
|
|
224
254
|
#
|
|
225
255
|
# @return [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome, nil]
|
|
226
256
|
optional :sandbox_outcome, enum: -> { Straddle::PayoutV1::Data::Config::SandboxOutcome }
|
|
227
257
|
|
|
228
|
-
# @!method initialize(sandbox_outcome: nil)
|
|
258
|
+
# @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
|
|
229
259
|
# Configuration for the payout.
|
|
230
260
|
#
|
|
261
|
+
# @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
|
|
262
|
+
#
|
|
263
|
+
# @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
|
|
264
|
+
#
|
|
231
265
|
# @param sandbox_outcome [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
|
|
232
266
|
|
|
233
267
|
# Payment will simulate processing if not Standard.
|
|
@@ -267,6 +301,7 @@ module Straddle
|
|
|
267
301
|
PENDING = :pending
|
|
268
302
|
PAID = :paid
|
|
269
303
|
REVERSED = :reversed
|
|
304
|
+
VALIDATING = :validating
|
|
270
305
|
|
|
271
306
|
# @!method self.values
|
|
272
307
|
# @return [Array<Symbol>]
|
|
@@ -354,6 +389,13 @@ module Straddle
|
|
|
354
389
|
OK = :ok
|
|
355
390
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
356
391
|
PAYOUT_REFUSED = :payout_refused
|
|
392
|
+
CANCEL_REQUEST = :cancel_request
|
|
393
|
+
FAILED_VERIFICATION = :failed_verification
|
|
394
|
+
REQUIRE_REVIEW = :require_review
|
|
395
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
396
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
397
|
+
VALIDATING = :validating
|
|
398
|
+
AUTO_HOLD = :auto_hold
|
|
357
399
|
|
|
358
400
|
# @!method self.values
|
|
359
401
|
# @return [Array<Symbol>]
|
|
@@ -390,6 +432,7 @@ module Straddle
|
|
|
390
432
|
PENDING = :pending
|
|
391
433
|
PAID = :paid
|
|
392
434
|
REVERSED = :reversed
|
|
435
|
+
VALIDATING = :validating
|
|
393
436
|
|
|
394
437
|
# @!method self.values
|
|
395
438
|
# @return [Array<Symbol>]
|
|
@@ -407,6 +450,17 @@ module Straddle
|
|
|
407
450
|
# @!method self.values
|
|
408
451
|
# @return [Array<Symbol>]
|
|
409
452
|
end
|
|
453
|
+
|
|
454
|
+
module RelatedPayment
|
|
455
|
+
extend Straddle::Internal::Type::Enum
|
|
456
|
+
|
|
457
|
+
ORIGINAL = :original
|
|
458
|
+
RESUBMIT = :resubmit
|
|
459
|
+
REFUND = :refund
|
|
460
|
+
|
|
461
|
+
# @!method self.values
|
|
462
|
+
# @return [Array<Symbol>]
|
|
463
|
+
end
|
|
410
464
|
end
|
|
411
465
|
|
|
412
466
|
# Indicates the structure of the returned content.
|
|
@@ -76,6 +76,13 @@ module Straddle
|
|
|
76
76
|
OK = :ok
|
|
77
77
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
78
78
|
PAYOUT_REFUSED = :payout_refused
|
|
79
|
+
CANCEL_REQUEST = :cancel_request
|
|
80
|
+
FAILED_VERIFICATION = :failed_verification
|
|
81
|
+
REQUIRE_REVIEW = :require_review
|
|
82
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
83
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
84
|
+
VALIDATING = :validating
|
|
85
|
+
AUTO_HOLD = :auto_hold
|
|
79
86
|
|
|
80
87
|
# @!method self.values
|
|
81
88
|
# @return [Array<Symbol>]
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Bridge
|
|
6
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
7
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
8
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
9
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
10
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
11
|
+
# bank accounts.
|
|
6
12
|
class Link
|
|
7
13
|
# Some parameter documentations has been truncated, see
|
|
8
14
|
# {Straddle::Models::Bridge::LinkBankAccountParams} for more details.
|
|
@@ -15,13 +21,13 @@ module Straddle
|
|
|
15
21
|
#
|
|
16
22
|
# @param account_number [String] Body param: The bank account number.
|
|
17
23
|
#
|
|
18
|
-
# @param account_type [Symbol, Straddle::Models::Bridge::LinkBankAccountParams::AccountType] Body param
|
|
24
|
+
# @param account_type [Symbol, Straddle::Models::Bridge::LinkBankAccountParams::AccountType] Body param
|
|
19
25
|
#
|
|
20
26
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
21
27
|
#
|
|
22
28
|
# @param routing_number [String] Body param: The routing number of the bank account.
|
|
23
29
|
#
|
|
24
|
-
# @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param
|
|
30
|
+
# @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param
|
|
25
31
|
#
|
|
26
32
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
27
33
|
#
|
|
@@ -72,7 +78,7 @@ module Straddle
|
|
|
72
78
|
#
|
|
73
79
|
# @param quiltt_token [String] Body param: Quiltt processor token generated by your application for use with th
|
|
74
80
|
#
|
|
75
|
-
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
81
|
+
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
76
82
|
#
|
|
77
83
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
78
84
|
#
|
|
@@ -115,7 +121,7 @@ module Straddle
|
|
|
115
121
|
#
|
|
116
122
|
# @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
117
123
|
#
|
|
118
|
-
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
124
|
+
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
119
125
|
#
|
|
120
126
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
121
127
|
#
|
|
@@ -123,7 +129,7 @@ module Straddle
|
|
|
123
129
|
#
|
|
124
130
|
# @param tan [String] Body param: Tokenized account number.
|
|
125
131
|
#
|
|
126
|
-
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
132
|
+
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
127
133
|
#
|
|
128
134
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
129
135
|
#
|
|
@@ -174,7 +180,7 @@ module Straddle
|
|
|
174
180
|
#
|
|
175
181
|
# @param plaid_token [String] Body param: Plaid processor token generated by your application for use with the
|
|
176
182
|
#
|
|
177
|
-
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
183
|
+
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
178
184
|
#
|
|
179
185
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
180
186
|
#
|
|
@@ -2,7 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
6
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
7
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
8
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
9
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
10
|
+
# bank accounts.
|
|
5
11
|
class Bridge
|
|
12
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
13
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
14
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
15
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
16
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
17
|
+
# bank accounts.
|
|
6
18
|
# @return [Straddle::Resources::Bridge::Link]
|
|
7
19
|
attr_reader :link
|
|
8
20
|
|
|
@@ -15,7 +27,7 @@ module Straddle
|
|
|
15
27
|
#
|
|
16
28
|
# @param customer_id [String] Body param: The Straddle generated unique identifier of the `customer` to create
|
|
17
29
|
#
|
|
18
|
-
# @param config [Straddle::Models::BridgeInitializeParams::Config] Body param
|
|
30
|
+
# @param config [Straddle::Models::BridgeInitializeParams::Config] Body param
|
|
19
31
|
#
|
|
20
32
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
21
33
|
#
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Charges represent attempts to debit money from a customer's bank account using a
|
|
6
|
+
# Paykey. Each charge includes automatic balance verification, real-time fraud
|
|
7
|
+
# screening, and multi-rail optimization and detailed status tracking throughout
|
|
8
|
+
# the payment lifecycle. Use charges to accept bank payments with confidence
|
|
9
|
+
# knowing every transaction is protected.
|
|
5
10
|
class Charges
|
|
6
11
|
# Some parameter documentations has been truncated, see
|
|
7
12
|
# {Straddle::Models::ChargeCreateParams} for more details.
|
|
@@ -12,15 +17,15 @@ module Straddle
|
|
|
12
17
|
#
|
|
13
18
|
# @param amount [Integer] Body param: The amount of the charge in cents.
|
|
14
19
|
#
|
|
15
|
-
# @param config [Straddle::Models::ChargeCreateParams::Config] Body param
|
|
20
|
+
# @param config [Straddle::Models::ChargeCreateParams::Config] Body param
|
|
16
21
|
#
|
|
17
22
|
# @param consent_type [Symbol, Straddle::Models::ChargeCreateParams::ConsentType] Body param: The channel or mechanism through which the payment was authorized. U
|
|
18
23
|
#
|
|
19
24
|
# @param currency [String] Body param: The currency of the charge. Only USD is supported.
|
|
20
25
|
#
|
|
21
|
-
# @param description [String] Body param: An arbitrary description for the charge.
|
|
26
|
+
# @param description [String, nil] Body param: An arbitrary description for the charge.
|
|
22
27
|
#
|
|
23
|
-
# @param device [Straddle::Models::DeviceInfoV1] Body param
|
|
28
|
+
# @param device [Straddle::Models::DeviceInfoV1] Body param
|
|
24
29
|
#
|
|
25
30
|
# @param external_id [String] Body param: Unique identifier for the charge in your database. This value must b
|
|
26
31
|
#
|
|
@@ -70,11 +75,11 @@ module Straddle
|
|
|
70
75
|
#
|
|
71
76
|
# @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
72
77
|
#
|
|
73
|
-
# @param id [String] Path param
|
|
78
|
+
# @param id [String] Path param
|
|
74
79
|
#
|
|
75
80
|
# @param amount [Integer] Body param: The amount of the charge in cents.
|
|
76
81
|
#
|
|
77
|
-
# @param description [String] Body param: An arbitrary description for the charge.
|
|
82
|
+
# @param description [String, nil] Body param: An arbitrary description for the charge.
|
|
78
83
|
#
|
|
79
84
|
# @param payment_date [Date] Body param: The desired date on which the payment should be occur. For charges,
|
|
80
85
|
#
|
|
@@ -120,7 +125,7 @@ module Straddle
|
|
|
120
125
|
#
|
|
121
126
|
# @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
122
127
|
#
|
|
123
|
-
# @param id [String] Path param
|
|
128
|
+
# @param id [String] Path param
|
|
124
129
|
#
|
|
125
130
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
126
131
|
#
|
|
@@ -197,7 +202,7 @@ module Straddle
|
|
|
197
202
|
#
|
|
198
203
|
# @overload hold(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
199
204
|
#
|
|
200
|
-
# @param id [String] Path param
|
|
205
|
+
# @param id [String] Path param
|
|
201
206
|
#
|
|
202
207
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
203
208
|
#
|
|
@@ -241,7 +246,7 @@ module Straddle
|
|
|
241
246
|
#
|
|
242
247
|
# @overload release(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
243
248
|
#
|
|
244
|
-
# @param id [String] Path param
|
|
249
|
+
# @param id [String] Path param
|
|
245
250
|
#
|
|
246
251
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
247
252
|
#
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Customers
|
|
6
|
+
# Customers represent the end users who send or receive payments through your
|
|
7
|
+
# integration. Each customer undergoes automatic identity verification and fraud
|
|
8
|
+
# screening upon creation. Use customers to track payment history, manage bank
|
|
9
|
+
# account connections, and maintain a secure record of all transactions associated
|
|
10
|
+
# with a user. Customers can be either individuals or businesses with appropriate
|
|
11
|
+
# compliance checks for each type.
|
|
6
12
|
class Review
|
|
7
13
|
# Some parameter documentations has been truncated, see
|
|
8
14
|
# {Straddle::Models::Customers::ReviewDecisionParams} for more details.
|
|
@@ -14,7 +20,7 @@ module Straddle
|
|
|
14
20
|
#
|
|
15
21
|
# @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
16
22
|
#
|
|
17
|
-
# @param id [String] Path param
|
|
23
|
+
# @param id [String] Path param
|
|
18
24
|
#
|
|
19
25
|
# @param status [Symbol, Straddle::Models::Customers::ReviewDecisionParams::Status] Body param: The final status of the customer review.
|
|
20
26
|
#
|