increase 1.90.0 → 1.91.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 +18 -0
- data/README.md +1 -1
- data/lib/increase/models/transaction.rb +1296 -173
- data/lib/increase/models/transaction_list_params.rb +3 -0
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/transaction.rbi +2282 -123
- data/rbi/increase/models/transaction_list_params.rbi +7 -0
- data/sig/increase/models/transaction.rbs +768 -0
- data/sig/increase/models/transaction_list_params.rbs +4 -0
- metadata +2 -2
@@ -366,6 +366,20 @@ module Increase
|
|
366
366
|
end
|
367
367
|
attr_writer :card_dispute_loss
|
368
368
|
|
369
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
370
|
+
# only if `category` is equal to `card_financial`. Card Financials are temporary
|
371
|
+
# holds placed on a customers funds with the intent to later clear a transaction.
|
372
|
+
sig { returns(T.nilable(Increase::Transaction::Source::CardFinancial)) }
|
373
|
+
attr_reader :card_financial
|
374
|
+
|
375
|
+
sig do
|
376
|
+
params(
|
377
|
+
card_financial:
|
378
|
+
T.nilable(Increase::Transaction::Source::CardFinancial::OrHash)
|
379
|
+
).void
|
380
|
+
end
|
381
|
+
attr_writer :card_financial
|
382
|
+
|
369
383
|
# A Card Push Transfer Acceptance object. This field will be present in the JSON
|
370
384
|
# response if and only if `category` is equal to `card_push_transfer_acceptance`.
|
371
385
|
# A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
|
@@ -931,6 +945,8 @@ module Increase
|
|
931
945
|
),
|
932
946
|
card_dispute_loss:
|
933
947
|
T.nilable(Increase::Transaction::Source::CardDisputeLoss::OrHash),
|
948
|
+
card_financial:
|
949
|
+
T.nilable(Increase::Transaction::Source::CardFinancial::OrHash),
|
934
950
|
card_push_transfer_acceptance:
|
935
951
|
T.nilable(
|
936
952
|
Increase::Transaction::Source::CardPushTransferAcceptance::OrHash
|
@@ -1065,6 +1081,10 @@ module Increase
|
|
1065
1081
|
# and only if `category` is equal to `card_dispute_loss`. Contains the details of
|
1066
1082
|
# a lost Card Dispute.
|
1067
1083
|
card_dispute_loss:,
|
1084
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
1085
|
+
# only if `category` is equal to `card_financial`. Card Financials are temporary
|
1086
|
+
# holds placed on a customers funds with the intent to later clear a transaction.
|
1087
|
+
card_financial:,
|
1068
1088
|
# A Card Push Transfer Acceptance object. This field will be present in the JSON
|
1069
1089
|
# response if and only if `category` is equal to `card_push_transfer_acceptance`.
|
1070
1090
|
# A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
|
@@ -1230,6 +1250,8 @@ module Increase
|
|
1230
1250
|
T.nilable(Increase::Transaction::Source::CardDisputeFinancial),
|
1231
1251
|
card_dispute_loss:
|
1232
1252
|
T.nilable(Increase::Transaction::Source::CardDisputeLoss),
|
1253
|
+
card_financial:
|
1254
|
+
T.nilable(Increase::Transaction::Source::CardFinancial),
|
1233
1255
|
card_push_transfer_acceptance:
|
1234
1256
|
T.nilable(
|
1235
1257
|
Increase::Transaction::Source::CardPushTransferAcceptance
|
@@ -2376,30 +2398,2024 @@ module Increase
|
|
2376
2398
|
def to_hash
|
2377
2399
|
end
|
2378
2400
|
|
2379
|
-
# The network that the Card Dispute is associated with.
|
2380
|
-
module Network
|
2401
|
+
# The network that the Card Dispute is associated with.
|
2402
|
+
module Network
|
2403
|
+
extend Increase::Internal::Type::Enum
|
2404
|
+
|
2405
|
+
TaggedSymbol =
|
2406
|
+
T.type_alias do
|
2407
|
+
T.all(
|
2408
|
+
Symbol,
|
2409
|
+
Increase::Transaction::Source::CardDisputeFinancial::Network
|
2410
|
+
)
|
2411
|
+
end
|
2412
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2413
|
+
|
2414
|
+
# Visa: details will be under the `visa` object.
|
2415
|
+
VISA =
|
2416
|
+
T.let(
|
2417
|
+
:visa,
|
2418
|
+
Increase::Transaction::Source::CardDisputeFinancial::Network::TaggedSymbol
|
2419
|
+
)
|
2420
|
+
|
2421
|
+
sig do
|
2422
|
+
override.returns(
|
2423
|
+
T::Array[
|
2424
|
+
Increase::Transaction::Source::CardDisputeFinancial::Network::TaggedSymbol
|
2425
|
+
]
|
2426
|
+
)
|
2427
|
+
end
|
2428
|
+
def self.values
|
2429
|
+
end
|
2430
|
+
end
|
2431
|
+
|
2432
|
+
class Visa < Increase::Internal::Type::BaseModel
|
2433
|
+
OrHash =
|
2434
|
+
T.type_alias do
|
2435
|
+
T.any(
|
2436
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa,
|
2437
|
+
Increase::Internal::AnyHash
|
2438
|
+
)
|
2439
|
+
end
|
2440
|
+
|
2441
|
+
# The type of card dispute financial event.
|
2442
|
+
sig do
|
2443
|
+
returns(
|
2444
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2445
|
+
)
|
2446
|
+
end
|
2447
|
+
attr_accessor :event_type
|
2448
|
+
|
2449
|
+
# Information for events related to card dispute for card payments processed over
|
2450
|
+
# Visa's network. This field will be present in the JSON response if and only if
|
2451
|
+
# `network` is equal to `visa`.
|
2452
|
+
sig do
|
2453
|
+
params(
|
2454
|
+
event_type:
|
2455
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::OrSymbol
|
2456
|
+
).returns(T.attached_class)
|
2457
|
+
end
|
2458
|
+
def self.new(
|
2459
|
+
# The type of card dispute financial event.
|
2460
|
+
event_type:
|
2461
|
+
)
|
2462
|
+
end
|
2463
|
+
|
2464
|
+
sig do
|
2465
|
+
override.returns(
|
2466
|
+
{
|
2467
|
+
event_type:
|
2468
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2469
|
+
}
|
2470
|
+
)
|
2471
|
+
end
|
2472
|
+
def to_hash
|
2473
|
+
end
|
2474
|
+
|
2475
|
+
# The type of card dispute financial event.
|
2476
|
+
module EventType
|
2477
|
+
extend Increase::Internal::Type::Enum
|
2478
|
+
|
2479
|
+
TaggedSymbol =
|
2480
|
+
T.type_alias do
|
2481
|
+
T.all(
|
2482
|
+
Symbol,
|
2483
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType
|
2484
|
+
)
|
2485
|
+
end
|
2486
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2487
|
+
|
2488
|
+
# The user's chargeback was submitted.
|
2489
|
+
CHARGEBACK_SUBMITTED =
|
2490
|
+
T.let(
|
2491
|
+
:chargeback_submitted,
|
2492
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2493
|
+
)
|
2494
|
+
|
2495
|
+
# The user declined the merchant's pre-arbitration submission.
|
2496
|
+
MERCHANT_PREARBITRATION_DECLINE_SUBMITTED =
|
2497
|
+
T.let(
|
2498
|
+
:merchant_prearbitration_decline_submitted,
|
2499
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2500
|
+
)
|
2501
|
+
|
2502
|
+
# The merchant's pre-arbitration submission was received.
|
2503
|
+
MERCHANT_PREARBITRATION_RECEIVED =
|
2504
|
+
T.let(
|
2505
|
+
:merchant_prearbitration_received,
|
2506
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2507
|
+
)
|
2508
|
+
|
2509
|
+
# The transaction was re-presented by the merchant.
|
2510
|
+
REPRESENTED =
|
2511
|
+
T.let(
|
2512
|
+
:represented,
|
2513
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2514
|
+
)
|
2515
|
+
|
2516
|
+
# The user's pre-arbitration was declined by the merchant.
|
2517
|
+
USER_PREARBITRATION_DECLINE_RECEIVED =
|
2518
|
+
T.let(
|
2519
|
+
:user_prearbitration_decline_received,
|
2520
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2521
|
+
)
|
2522
|
+
|
2523
|
+
# The user's pre-arbitration was submitted.
|
2524
|
+
USER_PREARBITRATION_SUBMITTED =
|
2525
|
+
T.let(
|
2526
|
+
:user_prearbitration_submitted,
|
2527
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2528
|
+
)
|
2529
|
+
|
2530
|
+
# The user withdrew from the dispute.
|
2531
|
+
USER_WITHDRAWAL_SUBMITTED =
|
2532
|
+
T.let(
|
2533
|
+
:user_withdrawal_submitted,
|
2534
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2535
|
+
)
|
2536
|
+
|
2537
|
+
sig do
|
2538
|
+
override.returns(
|
2539
|
+
T::Array[
|
2540
|
+
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2541
|
+
]
|
2542
|
+
)
|
2543
|
+
end
|
2544
|
+
def self.values
|
2545
|
+
end
|
2546
|
+
end
|
2547
|
+
end
|
2548
|
+
end
|
2549
|
+
|
2550
|
+
class CardDisputeLoss < Increase::Internal::Type::BaseModel
|
2551
|
+
OrHash =
|
2552
|
+
T.type_alias do
|
2553
|
+
T.any(
|
2554
|
+
Increase::Transaction::Source::CardDisputeLoss,
|
2555
|
+
Increase::Internal::AnyHash
|
2556
|
+
)
|
2557
|
+
end
|
2558
|
+
|
2559
|
+
# Why the Card Dispute was lost.
|
2560
|
+
sig { returns(String) }
|
2561
|
+
attr_accessor :explanation
|
2562
|
+
|
2563
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
2564
|
+
# the Card Dispute was lost.
|
2565
|
+
sig { returns(Time) }
|
2566
|
+
attr_accessor :lost_at
|
2567
|
+
|
2568
|
+
# The identifier of the Transaction that was created to debit the disputed funds
|
2569
|
+
# from your account.
|
2570
|
+
sig { returns(String) }
|
2571
|
+
attr_accessor :transaction_id
|
2572
|
+
|
2573
|
+
# A Card Dispute Loss object. This field will be present in the JSON response if
|
2574
|
+
# and only if `category` is equal to `card_dispute_loss`. Contains the details of
|
2575
|
+
# a lost Card Dispute.
|
2576
|
+
sig do
|
2577
|
+
params(
|
2578
|
+
explanation: String,
|
2579
|
+
lost_at: Time,
|
2580
|
+
transaction_id: String
|
2581
|
+
).returns(T.attached_class)
|
2582
|
+
end
|
2583
|
+
def self.new(
|
2584
|
+
# Why the Card Dispute was lost.
|
2585
|
+
explanation:,
|
2586
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
2587
|
+
# the Card Dispute was lost.
|
2588
|
+
lost_at:,
|
2589
|
+
# The identifier of the Transaction that was created to debit the disputed funds
|
2590
|
+
# from your account.
|
2591
|
+
transaction_id:
|
2592
|
+
)
|
2593
|
+
end
|
2594
|
+
|
2595
|
+
sig do
|
2596
|
+
override.returns(
|
2597
|
+
{ explanation: String, lost_at: Time, transaction_id: String }
|
2598
|
+
)
|
2599
|
+
end
|
2600
|
+
def to_hash
|
2601
|
+
end
|
2602
|
+
end
|
2603
|
+
|
2604
|
+
class CardFinancial < Increase::Internal::Type::BaseModel
|
2605
|
+
OrHash =
|
2606
|
+
T.type_alias do
|
2607
|
+
T.any(
|
2608
|
+
Increase::Transaction::Source::CardFinancial,
|
2609
|
+
Increase::Internal::AnyHash
|
2610
|
+
)
|
2611
|
+
end
|
2612
|
+
|
2613
|
+
# The Card Financial identifier.
|
2614
|
+
sig { returns(String) }
|
2615
|
+
attr_accessor :id
|
2616
|
+
|
2617
|
+
# Whether this financial was approved by Increase, the card network through
|
2618
|
+
# stand-in processing, or the user through a real-time decision.
|
2619
|
+
sig do
|
2620
|
+
returns(
|
2621
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol
|
2622
|
+
)
|
2623
|
+
end
|
2624
|
+
attr_accessor :actioner
|
2625
|
+
|
2626
|
+
# Additional amounts associated with the card authorization, such as ATM
|
2627
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
2628
|
+
# to provide more detailed information about the transaction.
|
2629
|
+
sig do
|
2630
|
+
returns(
|
2631
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts
|
2632
|
+
)
|
2633
|
+
end
|
2634
|
+
attr_reader :additional_amounts
|
2635
|
+
|
2636
|
+
sig do
|
2637
|
+
params(
|
2638
|
+
additional_amounts:
|
2639
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::OrHash
|
2640
|
+
).void
|
2641
|
+
end
|
2642
|
+
attr_writer :additional_amounts
|
2643
|
+
|
2644
|
+
# The pending amount in the minor unit of the transaction's currency. For dollars,
|
2645
|
+
# for example, this is cents.
|
2646
|
+
sig { returns(Integer) }
|
2647
|
+
attr_accessor :amount
|
2648
|
+
|
2649
|
+
# The ID of the Card Payment this transaction belongs to.
|
2650
|
+
sig { returns(String) }
|
2651
|
+
attr_accessor :card_payment_id
|
2652
|
+
|
2653
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
2654
|
+
# transaction's currency.
|
2655
|
+
sig do
|
2656
|
+
returns(
|
2657
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
2658
|
+
)
|
2659
|
+
end
|
2660
|
+
attr_accessor :currency
|
2661
|
+
|
2662
|
+
# If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
2663
|
+
# purchase), the identifier of the token that was used.
|
2664
|
+
sig { returns(T.nilable(String)) }
|
2665
|
+
attr_accessor :digital_wallet_token_id
|
2666
|
+
|
2667
|
+
# The direction describes the direction the funds will move, either from the
|
2668
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
2669
|
+
sig do
|
2670
|
+
returns(
|
2671
|
+
Increase::Transaction::Source::CardFinancial::Direction::TaggedSymbol
|
2672
|
+
)
|
2673
|
+
end
|
2674
|
+
attr_accessor :direction
|
2675
|
+
|
2676
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
2677
|
+
# is transacting with.
|
2678
|
+
sig { returns(String) }
|
2679
|
+
attr_accessor :merchant_acceptor_id
|
2680
|
+
|
2681
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
2682
|
+
# card is transacting with.
|
2683
|
+
sig { returns(String) }
|
2684
|
+
attr_accessor :merchant_category_code
|
2685
|
+
|
2686
|
+
# The city the merchant resides in.
|
2687
|
+
sig { returns(T.nilable(String)) }
|
2688
|
+
attr_accessor :merchant_city
|
2689
|
+
|
2690
|
+
# The country the merchant resides in.
|
2691
|
+
sig { returns(String) }
|
2692
|
+
attr_accessor :merchant_country
|
2693
|
+
|
2694
|
+
# The merchant descriptor of the merchant the card is transacting with.
|
2695
|
+
sig { returns(String) }
|
2696
|
+
attr_accessor :merchant_descriptor
|
2697
|
+
|
2698
|
+
# The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
2699
|
+
# ZIP code, where the first 5 and last 4 are separated by a dash.
|
2700
|
+
sig { returns(T.nilable(String)) }
|
2701
|
+
attr_accessor :merchant_postal_code
|
2702
|
+
|
2703
|
+
# The state the merchant resides in.
|
2704
|
+
sig { returns(T.nilable(String)) }
|
2705
|
+
attr_accessor :merchant_state
|
2706
|
+
|
2707
|
+
# Fields specific to the `network`.
|
2708
|
+
sig do
|
2709
|
+
returns(
|
2710
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails
|
2711
|
+
)
|
2712
|
+
end
|
2713
|
+
attr_reader :network_details
|
2714
|
+
|
2715
|
+
sig do
|
2716
|
+
params(
|
2717
|
+
network_details:
|
2718
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::OrHash
|
2719
|
+
).void
|
2720
|
+
end
|
2721
|
+
attr_writer :network_details
|
2722
|
+
|
2723
|
+
# Network-specific identifiers for a specific request or transaction.
|
2724
|
+
sig do
|
2725
|
+
returns(
|
2726
|
+
Increase::Transaction::Source::CardFinancial::NetworkIdentifiers
|
2727
|
+
)
|
2728
|
+
end
|
2729
|
+
attr_reader :network_identifiers
|
2730
|
+
|
2731
|
+
sig do
|
2732
|
+
params(
|
2733
|
+
network_identifiers:
|
2734
|
+
Increase::Transaction::Source::CardFinancial::NetworkIdentifiers::OrHash
|
2735
|
+
).void
|
2736
|
+
end
|
2737
|
+
attr_writer :network_identifiers
|
2738
|
+
|
2739
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
2740
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
2741
|
+
sig { returns(T.nilable(Integer)) }
|
2742
|
+
attr_accessor :network_risk_score
|
2743
|
+
|
2744
|
+
# If the authorization was made in-person with a physical card, the Physical Card
|
2745
|
+
# that was used.
|
2746
|
+
sig { returns(T.nilable(String)) }
|
2747
|
+
attr_accessor :physical_card_id
|
2748
|
+
|
2749
|
+
# The pending amount in the minor unit of the transaction's presentment currency.
|
2750
|
+
sig { returns(Integer) }
|
2751
|
+
attr_accessor :presentment_amount
|
2752
|
+
|
2753
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
2754
|
+
# transaction's presentment currency.
|
2755
|
+
sig { returns(String) }
|
2756
|
+
attr_accessor :presentment_currency
|
2757
|
+
|
2758
|
+
# The processing category describes the intent behind the financial, such as
|
2759
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
2760
|
+
sig do
|
2761
|
+
returns(
|
2762
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
2763
|
+
)
|
2764
|
+
end
|
2765
|
+
attr_accessor :processing_category
|
2766
|
+
|
2767
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
2768
|
+
# transaction.
|
2769
|
+
sig { returns(T.nilable(String)) }
|
2770
|
+
attr_accessor :real_time_decision_id
|
2771
|
+
|
2772
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
2773
|
+
# is transacting with.
|
2774
|
+
sig { returns(T.nilable(String)) }
|
2775
|
+
attr_accessor :terminal_id
|
2776
|
+
|
2777
|
+
# The identifier of the Transaction associated with this Transaction.
|
2778
|
+
sig { returns(String) }
|
2779
|
+
attr_accessor :transaction_id
|
2780
|
+
|
2781
|
+
# A constant representing the object's type. For this resource it will always be
|
2782
|
+
# `card_financial`.
|
2783
|
+
sig do
|
2784
|
+
returns(
|
2785
|
+
Increase::Transaction::Source::CardFinancial::Type::TaggedSymbol
|
2786
|
+
)
|
2787
|
+
end
|
2788
|
+
attr_accessor :type
|
2789
|
+
|
2790
|
+
# Fields related to verification of cardholder-provided values.
|
2791
|
+
sig do
|
2792
|
+
returns(Increase::Transaction::Source::CardFinancial::Verification)
|
2793
|
+
end
|
2794
|
+
attr_reader :verification
|
2795
|
+
|
2796
|
+
sig do
|
2797
|
+
params(
|
2798
|
+
verification:
|
2799
|
+
Increase::Transaction::Source::CardFinancial::Verification::OrHash
|
2800
|
+
).void
|
2801
|
+
end
|
2802
|
+
attr_writer :verification
|
2803
|
+
|
2804
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
2805
|
+
# only if `category` is equal to `card_financial`. Card Financials are temporary
|
2806
|
+
# holds placed on a customers funds with the intent to later clear a transaction.
|
2807
|
+
sig do
|
2808
|
+
params(
|
2809
|
+
id: String,
|
2810
|
+
actioner:
|
2811
|
+
Increase::Transaction::Source::CardFinancial::Actioner::OrSymbol,
|
2812
|
+
additional_amounts:
|
2813
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::OrHash,
|
2814
|
+
amount: Integer,
|
2815
|
+
card_payment_id: String,
|
2816
|
+
currency:
|
2817
|
+
Increase::Transaction::Source::CardFinancial::Currency::OrSymbol,
|
2818
|
+
digital_wallet_token_id: T.nilable(String),
|
2819
|
+
direction:
|
2820
|
+
Increase::Transaction::Source::CardFinancial::Direction::OrSymbol,
|
2821
|
+
merchant_acceptor_id: String,
|
2822
|
+
merchant_category_code: String,
|
2823
|
+
merchant_city: T.nilable(String),
|
2824
|
+
merchant_country: String,
|
2825
|
+
merchant_descriptor: String,
|
2826
|
+
merchant_postal_code: T.nilable(String),
|
2827
|
+
merchant_state: T.nilable(String),
|
2828
|
+
network_details:
|
2829
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::OrHash,
|
2830
|
+
network_identifiers:
|
2831
|
+
Increase::Transaction::Source::CardFinancial::NetworkIdentifiers::OrHash,
|
2832
|
+
network_risk_score: T.nilable(Integer),
|
2833
|
+
physical_card_id: T.nilable(String),
|
2834
|
+
presentment_amount: Integer,
|
2835
|
+
presentment_currency: String,
|
2836
|
+
processing_category:
|
2837
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::OrSymbol,
|
2838
|
+
real_time_decision_id: T.nilable(String),
|
2839
|
+
terminal_id: T.nilable(String),
|
2840
|
+
transaction_id: String,
|
2841
|
+
type:
|
2842
|
+
Increase::Transaction::Source::CardFinancial::Type::OrSymbol,
|
2843
|
+
verification:
|
2844
|
+
Increase::Transaction::Source::CardFinancial::Verification::OrHash
|
2845
|
+
).returns(T.attached_class)
|
2846
|
+
end
|
2847
|
+
def self.new(
|
2848
|
+
# The Card Financial identifier.
|
2849
|
+
id:,
|
2850
|
+
# Whether this financial was approved by Increase, the card network through
|
2851
|
+
# stand-in processing, or the user through a real-time decision.
|
2852
|
+
actioner:,
|
2853
|
+
# Additional amounts associated with the card authorization, such as ATM
|
2854
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
2855
|
+
# to provide more detailed information about the transaction.
|
2856
|
+
additional_amounts:,
|
2857
|
+
# The pending amount in the minor unit of the transaction's currency. For dollars,
|
2858
|
+
# for example, this is cents.
|
2859
|
+
amount:,
|
2860
|
+
# The ID of the Card Payment this transaction belongs to.
|
2861
|
+
card_payment_id:,
|
2862
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
2863
|
+
# transaction's currency.
|
2864
|
+
currency:,
|
2865
|
+
# If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
2866
|
+
# purchase), the identifier of the token that was used.
|
2867
|
+
digital_wallet_token_id:,
|
2868
|
+
# The direction describes the direction the funds will move, either from the
|
2869
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
2870
|
+
direction:,
|
2871
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
2872
|
+
# is transacting with.
|
2873
|
+
merchant_acceptor_id:,
|
2874
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
2875
|
+
# card is transacting with.
|
2876
|
+
merchant_category_code:,
|
2877
|
+
# The city the merchant resides in.
|
2878
|
+
merchant_city:,
|
2879
|
+
# The country the merchant resides in.
|
2880
|
+
merchant_country:,
|
2881
|
+
# The merchant descriptor of the merchant the card is transacting with.
|
2882
|
+
merchant_descriptor:,
|
2883
|
+
# The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
2884
|
+
# ZIP code, where the first 5 and last 4 are separated by a dash.
|
2885
|
+
merchant_postal_code:,
|
2886
|
+
# The state the merchant resides in.
|
2887
|
+
merchant_state:,
|
2888
|
+
# Fields specific to the `network`.
|
2889
|
+
network_details:,
|
2890
|
+
# Network-specific identifiers for a specific request or transaction.
|
2891
|
+
network_identifiers:,
|
2892
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
2893
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
2894
|
+
network_risk_score:,
|
2895
|
+
# If the authorization was made in-person with a physical card, the Physical Card
|
2896
|
+
# that was used.
|
2897
|
+
physical_card_id:,
|
2898
|
+
# The pending amount in the minor unit of the transaction's presentment currency.
|
2899
|
+
presentment_amount:,
|
2900
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
2901
|
+
# transaction's presentment currency.
|
2902
|
+
presentment_currency:,
|
2903
|
+
# The processing category describes the intent behind the financial, such as
|
2904
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
2905
|
+
processing_category:,
|
2906
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
2907
|
+
# transaction.
|
2908
|
+
real_time_decision_id:,
|
2909
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
2910
|
+
# is transacting with.
|
2911
|
+
terminal_id:,
|
2912
|
+
# The identifier of the Transaction associated with this Transaction.
|
2913
|
+
transaction_id:,
|
2914
|
+
# A constant representing the object's type. For this resource it will always be
|
2915
|
+
# `card_financial`.
|
2916
|
+
type:,
|
2917
|
+
# Fields related to verification of cardholder-provided values.
|
2918
|
+
verification:
|
2919
|
+
)
|
2920
|
+
end
|
2921
|
+
|
2922
|
+
sig do
|
2923
|
+
override.returns(
|
2924
|
+
{
|
2925
|
+
id: String,
|
2926
|
+
actioner:
|
2927
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol,
|
2928
|
+
additional_amounts:
|
2929
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts,
|
2930
|
+
amount: Integer,
|
2931
|
+
card_payment_id: String,
|
2932
|
+
currency:
|
2933
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol,
|
2934
|
+
digital_wallet_token_id: T.nilable(String),
|
2935
|
+
direction:
|
2936
|
+
Increase::Transaction::Source::CardFinancial::Direction::TaggedSymbol,
|
2937
|
+
merchant_acceptor_id: String,
|
2938
|
+
merchant_category_code: String,
|
2939
|
+
merchant_city: T.nilable(String),
|
2940
|
+
merchant_country: String,
|
2941
|
+
merchant_descriptor: String,
|
2942
|
+
merchant_postal_code: T.nilable(String),
|
2943
|
+
merchant_state: T.nilable(String),
|
2944
|
+
network_details:
|
2945
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails,
|
2946
|
+
network_identifiers:
|
2947
|
+
Increase::Transaction::Source::CardFinancial::NetworkIdentifiers,
|
2948
|
+
network_risk_score: T.nilable(Integer),
|
2949
|
+
physical_card_id: T.nilable(String),
|
2950
|
+
presentment_amount: Integer,
|
2951
|
+
presentment_currency: String,
|
2952
|
+
processing_category:
|
2953
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol,
|
2954
|
+
real_time_decision_id: T.nilable(String),
|
2955
|
+
terminal_id: T.nilable(String),
|
2956
|
+
transaction_id: String,
|
2957
|
+
type:
|
2958
|
+
Increase::Transaction::Source::CardFinancial::Type::TaggedSymbol,
|
2959
|
+
verification:
|
2960
|
+
Increase::Transaction::Source::CardFinancial::Verification
|
2961
|
+
}
|
2962
|
+
)
|
2963
|
+
end
|
2964
|
+
def to_hash
|
2965
|
+
end
|
2966
|
+
|
2967
|
+
# Whether this financial was approved by Increase, the card network through
|
2968
|
+
# stand-in processing, or the user through a real-time decision.
|
2969
|
+
module Actioner
|
2970
|
+
extend Increase::Internal::Type::Enum
|
2971
|
+
|
2972
|
+
TaggedSymbol =
|
2973
|
+
T.type_alias do
|
2974
|
+
T.all(
|
2975
|
+
Symbol,
|
2976
|
+
Increase::Transaction::Source::CardFinancial::Actioner
|
2977
|
+
)
|
2978
|
+
end
|
2979
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2980
|
+
|
2981
|
+
# This object was actioned by the user through a real-time decision.
|
2982
|
+
USER =
|
2983
|
+
T.let(
|
2984
|
+
:user,
|
2985
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol
|
2986
|
+
)
|
2987
|
+
|
2988
|
+
# This object was actioned by Increase without user intervention.
|
2989
|
+
INCREASE =
|
2990
|
+
T.let(
|
2991
|
+
:increase,
|
2992
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol
|
2993
|
+
)
|
2994
|
+
|
2995
|
+
# This object was actioned by the network, through stand-in processing.
|
2996
|
+
NETWORK =
|
2997
|
+
T.let(
|
2998
|
+
:network,
|
2999
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol
|
3000
|
+
)
|
3001
|
+
|
3002
|
+
sig do
|
3003
|
+
override.returns(
|
3004
|
+
T::Array[
|
3005
|
+
Increase::Transaction::Source::CardFinancial::Actioner::TaggedSymbol
|
3006
|
+
]
|
3007
|
+
)
|
3008
|
+
end
|
3009
|
+
def self.values
|
3010
|
+
end
|
3011
|
+
end
|
3012
|
+
|
3013
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
3014
|
+
OrHash =
|
3015
|
+
T.type_alias do
|
3016
|
+
T.any(
|
3017
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts,
|
3018
|
+
Increase::Internal::AnyHash
|
3019
|
+
)
|
3020
|
+
end
|
3021
|
+
|
3022
|
+
# The part of this transaction amount that was for clinic-related services.
|
3023
|
+
sig do
|
3024
|
+
returns(
|
3025
|
+
T.nilable(
|
3026
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic
|
3027
|
+
)
|
3028
|
+
)
|
3029
|
+
end
|
3030
|
+
attr_reader :clinic
|
3031
|
+
|
3032
|
+
sig do
|
3033
|
+
params(
|
3034
|
+
clinic:
|
3035
|
+
T.nilable(
|
3036
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic::OrHash
|
3037
|
+
)
|
3038
|
+
).void
|
3039
|
+
end
|
3040
|
+
attr_writer :clinic
|
3041
|
+
|
3042
|
+
# The part of this transaction amount that was for dental-related services.
|
3043
|
+
sig do
|
3044
|
+
returns(
|
3045
|
+
T.nilable(
|
3046
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental
|
3047
|
+
)
|
3048
|
+
)
|
3049
|
+
end
|
3050
|
+
attr_reader :dental
|
3051
|
+
|
3052
|
+
sig do
|
3053
|
+
params(
|
3054
|
+
dental:
|
3055
|
+
T.nilable(
|
3056
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental::OrHash
|
3057
|
+
)
|
3058
|
+
).void
|
3059
|
+
end
|
3060
|
+
attr_writer :dental
|
3061
|
+
|
3062
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
3063
|
+
sig do
|
3064
|
+
returns(
|
3065
|
+
T.nilable(
|
3066
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription
|
3067
|
+
)
|
3068
|
+
)
|
3069
|
+
end
|
3070
|
+
attr_reader :prescription
|
3071
|
+
|
3072
|
+
sig do
|
3073
|
+
params(
|
3074
|
+
prescription:
|
3075
|
+
T.nilable(
|
3076
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription::OrHash
|
3077
|
+
)
|
3078
|
+
).void
|
3079
|
+
end
|
3080
|
+
attr_writer :prescription
|
3081
|
+
|
3082
|
+
# The surcharge amount charged for this transaction by the merchant.
|
3083
|
+
sig do
|
3084
|
+
returns(
|
3085
|
+
T.nilable(
|
3086
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge
|
3087
|
+
)
|
3088
|
+
)
|
3089
|
+
end
|
3090
|
+
attr_reader :surcharge
|
3091
|
+
|
3092
|
+
sig do
|
3093
|
+
params(
|
3094
|
+
surcharge:
|
3095
|
+
T.nilable(
|
3096
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge::OrHash
|
3097
|
+
)
|
3098
|
+
).void
|
3099
|
+
end
|
3100
|
+
attr_writer :surcharge
|
3101
|
+
|
3102
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
3103
|
+
sig do
|
3104
|
+
returns(
|
3105
|
+
T.nilable(
|
3106
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative
|
3107
|
+
)
|
3108
|
+
)
|
3109
|
+
end
|
3110
|
+
attr_reader :total_cumulative
|
3111
|
+
|
3112
|
+
sig do
|
3113
|
+
params(
|
3114
|
+
total_cumulative:
|
3115
|
+
T.nilable(
|
3116
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative::OrHash
|
3117
|
+
)
|
3118
|
+
).void
|
3119
|
+
end
|
3120
|
+
attr_writer :total_cumulative
|
3121
|
+
|
3122
|
+
# The total amount of healthcare-related additional amounts.
|
3123
|
+
sig do
|
3124
|
+
returns(
|
3125
|
+
T.nilable(
|
3126
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare
|
3127
|
+
)
|
3128
|
+
)
|
3129
|
+
end
|
3130
|
+
attr_reader :total_healthcare
|
3131
|
+
|
3132
|
+
sig do
|
3133
|
+
params(
|
3134
|
+
total_healthcare:
|
3135
|
+
T.nilable(
|
3136
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare::OrHash
|
3137
|
+
)
|
3138
|
+
).void
|
3139
|
+
end
|
3140
|
+
attr_writer :total_healthcare
|
3141
|
+
|
3142
|
+
# The part of this transaction amount that was for transit-related services.
|
3143
|
+
sig do
|
3144
|
+
returns(
|
3145
|
+
T.nilable(
|
3146
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit
|
3147
|
+
)
|
3148
|
+
)
|
3149
|
+
end
|
3150
|
+
attr_reader :transit
|
3151
|
+
|
3152
|
+
sig do
|
3153
|
+
params(
|
3154
|
+
transit:
|
3155
|
+
T.nilable(
|
3156
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit::OrHash
|
3157
|
+
)
|
3158
|
+
).void
|
3159
|
+
end
|
3160
|
+
attr_writer :transit
|
3161
|
+
|
3162
|
+
# An unknown additional amount.
|
3163
|
+
sig do
|
3164
|
+
returns(
|
3165
|
+
T.nilable(
|
3166
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown
|
3167
|
+
)
|
3168
|
+
)
|
3169
|
+
end
|
3170
|
+
attr_reader :unknown
|
3171
|
+
|
3172
|
+
sig do
|
3173
|
+
params(
|
3174
|
+
unknown:
|
3175
|
+
T.nilable(
|
3176
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown::OrHash
|
3177
|
+
)
|
3178
|
+
).void
|
3179
|
+
end
|
3180
|
+
attr_writer :unknown
|
3181
|
+
|
3182
|
+
# The part of this transaction amount that was for vision-related services.
|
3183
|
+
sig do
|
3184
|
+
returns(
|
3185
|
+
T.nilable(
|
3186
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision
|
3187
|
+
)
|
3188
|
+
)
|
3189
|
+
end
|
3190
|
+
attr_reader :vision
|
3191
|
+
|
3192
|
+
sig do
|
3193
|
+
params(
|
3194
|
+
vision:
|
3195
|
+
T.nilable(
|
3196
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision::OrHash
|
3197
|
+
)
|
3198
|
+
).void
|
3199
|
+
end
|
3200
|
+
attr_writer :vision
|
3201
|
+
|
3202
|
+
# Additional amounts associated with the card authorization, such as ATM
|
3203
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
3204
|
+
# to provide more detailed information about the transaction.
|
3205
|
+
sig do
|
3206
|
+
params(
|
3207
|
+
clinic:
|
3208
|
+
T.nilable(
|
3209
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic::OrHash
|
3210
|
+
),
|
3211
|
+
dental:
|
3212
|
+
T.nilable(
|
3213
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental::OrHash
|
3214
|
+
),
|
3215
|
+
prescription:
|
3216
|
+
T.nilable(
|
3217
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription::OrHash
|
3218
|
+
),
|
3219
|
+
surcharge:
|
3220
|
+
T.nilable(
|
3221
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge::OrHash
|
3222
|
+
),
|
3223
|
+
total_cumulative:
|
3224
|
+
T.nilable(
|
3225
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative::OrHash
|
3226
|
+
),
|
3227
|
+
total_healthcare:
|
3228
|
+
T.nilable(
|
3229
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare::OrHash
|
3230
|
+
),
|
3231
|
+
transit:
|
3232
|
+
T.nilable(
|
3233
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit::OrHash
|
3234
|
+
),
|
3235
|
+
unknown:
|
3236
|
+
T.nilable(
|
3237
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown::OrHash
|
3238
|
+
),
|
3239
|
+
vision:
|
3240
|
+
T.nilable(
|
3241
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision::OrHash
|
3242
|
+
)
|
3243
|
+
).returns(T.attached_class)
|
3244
|
+
end
|
3245
|
+
def self.new(
|
3246
|
+
# The part of this transaction amount that was for clinic-related services.
|
3247
|
+
clinic:,
|
3248
|
+
# The part of this transaction amount that was for dental-related services.
|
3249
|
+
dental:,
|
3250
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
3251
|
+
prescription:,
|
3252
|
+
# The surcharge amount charged for this transaction by the merchant.
|
3253
|
+
surcharge:,
|
3254
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
3255
|
+
total_cumulative:,
|
3256
|
+
# The total amount of healthcare-related additional amounts.
|
3257
|
+
total_healthcare:,
|
3258
|
+
# The part of this transaction amount that was for transit-related services.
|
3259
|
+
transit:,
|
3260
|
+
# An unknown additional amount.
|
3261
|
+
unknown:,
|
3262
|
+
# The part of this transaction amount that was for vision-related services.
|
3263
|
+
vision:
|
3264
|
+
)
|
3265
|
+
end
|
3266
|
+
|
3267
|
+
sig do
|
3268
|
+
override.returns(
|
3269
|
+
{
|
3270
|
+
clinic:
|
3271
|
+
T.nilable(
|
3272
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic
|
3273
|
+
),
|
3274
|
+
dental:
|
3275
|
+
T.nilable(
|
3276
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental
|
3277
|
+
),
|
3278
|
+
prescription:
|
3279
|
+
T.nilable(
|
3280
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription
|
3281
|
+
),
|
3282
|
+
surcharge:
|
3283
|
+
T.nilable(
|
3284
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge
|
3285
|
+
),
|
3286
|
+
total_cumulative:
|
3287
|
+
T.nilable(
|
3288
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative
|
3289
|
+
),
|
3290
|
+
total_healthcare:
|
3291
|
+
T.nilable(
|
3292
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare
|
3293
|
+
),
|
3294
|
+
transit:
|
3295
|
+
T.nilable(
|
3296
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit
|
3297
|
+
),
|
3298
|
+
unknown:
|
3299
|
+
T.nilable(
|
3300
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown
|
3301
|
+
),
|
3302
|
+
vision:
|
3303
|
+
T.nilable(
|
3304
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision
|
3305
|
+
)
|
3306
|
+
}
|
3307
|
+
)
|
3308
|
+
end
|
3309
|
+
def to_hash
|
3310
|
+
end
|
3311
|
+
|
3312
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
3313
|
+
OrHash =
|
3314
|
+
T.type_alias do
|
3315
|
+
T.any(
|
3316
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic,
|
3317
|
+
Increase::Internal::AnyHash
|
3318
|
+
)
|
3319
|
+
end
|
3320
|
+
|
3321
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3322
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3323
|
+
# subtracted from the amount (such as a discount).
|
3324
|
+
sig { returns(Integer) }
|
3325
|
+
attr_accessor :amount
|
3326
|
+
|
3327
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3328
|
+
# amount's currency.
|
3329
|
+
sig { returns(String) }
|
3330
|
+
attr_accessor :currency
|
3331
|
+
|
3332
|
+
# The part of this transaction amount that was for clinic-related services.
|
3333
|
+
sig do
|
3334
|
+
params(amount: Integer, currency: String).returns(
|
3335
|
+
T.attached_class
|
3336
|
+
)
|
3337
|
+
end
|
3338
|
+
def self.new(
|
3339
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3340
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3341
|
+
# subtracted from the amount (such as a discount).
|
3342
|
+
amount:,
|
3343
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3344
|
+
# amount's currency.
|
3345
|
+
currency:
|
3346
|
+
)
|
3347
|
+
end
|
3348
|
+
|
3349
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3350
|
+
def to_hash
|
3351
|
+
end
|
3352
|
+
end
|
3353
|
+
|
3354
|
+
class Dental < Increase::Internal::Type::BaseModel
|
3355
|
+
OrHash =
|
3356
|
+
T.type_alias do
|
3357
|
+
T.any(
|
3358
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental,
|
3359
|
+
Increase::Internal::AnyHash
|
3360
|
+
)
|
3361
|
+
end
|
3362
|
+
|
3363
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3364
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3365
|
+
# subtracted from the amount (such as a discount).
|
3366
|
+
sig { returns(Integer) }
|
3367
|
+
attr_accessor :amount
|
3368
|
+
|
3369
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3370
|
+
# amount's currency.
|
3371
|
+
sig { returns(String) }
|
3372
|
+
attr_accessor :currency
|
3373
|
+
|
3374
|
+
# The part of this transaction amount that was for dental-related services.
|
3375
|
+
sig do
|
3376
|
+
params(amount: Integer, currency: String).returns(
|
3377
|
+
T.attached_class
|
3378
|
+
)
|
3379
|
+
end
|
3380
|
+
def self.new(
|
3381
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3382
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3383
|
+
# subtracted from the amount (such as a discount).
|
3384
|
+
amount:,
|
3385
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3386
|
+
# amount's currency.
|
3387
|
+
currency:
|
3388
|
+
)
|
3389
|
+
end
|
3390
|
+
|
3391
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3392
|
+
def to_hash
|
3393
|
+
end
|
3394
|
+
end
|
3395
|
+
|
3396
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
3397
|
+
OrHash =
|
3398
|
+
T.type_alias do
|
3399
|
+
T.any(
|
3400
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription,
|
3401
|
+
Increase::Internal::AnyHash
|
3402
|
+
)
|
3403
|
+
end
|
3404
|
+
|
3405
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3406
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3407
|
+
# subtracted from the amount (such as a discount).
|
3408
|
+
sig { returns(Integer) }
|
3409
|
+
attr_accessor :amount
|
3410
|
+
|
3411
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3412
|
+
# amount's currency.
|
3413
|
+
sig { returns(String) }
|
3414
|
+
attr_accessor :currency
|
3415
|
+
|
3416
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
3417
|
+
sig do
|
3418
|
+
params(amount: Integer, currency: String).returns(
|
3419
|
+
T.attached_class
|
3420
|
+
)
|
3421
|
+
end
|
3422
|
+
def self.new(
|
3423
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3424
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3425
|
+
# subtracted from the amount (such as a discount).
|
3426
|
+
amount:,
|
3427
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3428
|
+
# amount's currency.
|
3429
|
+
currency:
|
3430
|
+
)
|
3431
|
+
end
|
3432
|
+
|
3433
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3434
|
+
def to_hash
|
3435
|
+
end
|
3436
|
+
end
|
3437
|
+
|
3438
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
3439
|
+
OrHash =
|
3440
|
+
T.type_alias do
|
3441
|
+
T.any(
|
3442
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge,
|
3443
|
+
Increase::Internal::AnyHash
|
3444
|
+
)
|
3445
|
+
end
|
3446
|
+
|
3447
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3448
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3449
|
+
# subtracted from the amount (such as a discount).
|
3450
|
+
sig { returns(Integer) }
|
3451
|
+
attr_accessor :amount
|
3452
|
+
|
3453
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3454
|
+
# amount's currency.
|
3455
|
+
sig { returns(String) }
|
3456
|
+
attr_accessor :currency
|
3457
|
+
|
3458
|
+
# The surcharge amount charged for this transaction by the merchant.
|
3459
|
+
sig do
|
3460
|
+
params(amount: Integer, currency: String).returns(
|
3461
|
+
T.attached_class
|
3462
|
+
)
|
3463
|
+
end
|
3464
|
+
def self.new(
|
3465
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3466
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3467
|
+
# subtracted from the amount (such as a discount).
|
3468
|
+
amount:,
|
3469
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3470
|
+
# amount's currency.
|
3471
|
+
currency:
|
3472
|
+
)
|
3473
|
+
end
|
3474
|
+
|
3475
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3476
|
+
def to_hash
|
3477
|
+
end
|
3478
|
+
end
|
3479
|
+
|
3480
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
3481
|
+
OrHash =
|
3482
|
+
T.type_alias do
|
3483
|
+
T.any(
|
3484
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative,
|
3485
|
+
Increase::Internal::AnyHash
|
3486
|
+
)
|
3487
|
+
end
|
3488
|
+
|
3489
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3490
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3491
|
+
# subtracted from the amount (such as a discount).
|
3492
|
+
sig { returns(Integer) }
|
3493
|
+
attr_accessor :amount
|
3494
|
+
|
3495
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3496
|
+
# amount's currency.
|
3497
|
+
sig { returns(String) }
|
3498
|
+
attr_accessor :currency
|
3499
|
+
|
3500
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
3501
|
+
sig do
|
3502
|
+
params(amount: Integer, currency: String).returns(
|
3503
|
+
T.attached_class
|
3504
|
+
)
|
3505
|
+
end
|
3506
|
+
def self.new(
|
3507
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3508
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3509
|
+
# subtracted from the amount (such as a discount).
|
3510
|
+
amount:,
|
3511
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3512
|
+
# amount's currency.
|
3513
|
+
currency:
|
3514
|
+
)
|
3515
|
+
end
|
3516
|
+
|
3517
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3518
|
+
def to_hash
|
3519
|
+
end
|
3520
|
+
end
|
3521
|
+
|
3522
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
3523
|
+
OrHash =
|
3524
|
+
T.type_alias do
|
3525
|
+
T.any(
|
3526
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare,
|
3527
|
+
Increase::Internal::AnyHash
|
3528
|
+
)
|
3529
|
+
end
|
3530
|
+
|
3531
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3532
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3533
|
+
# subtracted from the amount (such as a discount).
|
3534
|
+
sig { returns(Integer) }
|
3535
|
+
attr_accessor :amount
|
3536
|
+
|
3537
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3538
|
+
# amount's currency.
|
3539
|
+
sig { returns(String) }
|
3540
|
+
attr_accessor :currency
|
3541
|
+
|
3542
|
+
# The total amount of healthcare-related additional amounts.
|
3543
|
+
sig do
|
3544
|
+
params(amount: Integer, currency: String).returns(
|
3545
|
+
T.attached_class
|
3546
|
+
)
|
3547
|
+
end
|
3548
|
+
def self.new(
|
3549
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3550
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3551
|
+
# subtracted from the amount (such as a discount).
|
3552
|
+
amount:,
|
3553
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3554
|
+
# amount's currency.
|
3555
|
+
currency:
|
3556
|
+
)
|
3557
|
+
end
|
3558
|
+
|
3559
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3560
|
+
def to_hash
|
3561
|
+
end
|
3562
|
+
end
|
3563
|
+
|
3564
|
+
class Transit < Increase::Internal::Type::BaseModel
|
3565
|
+
OrHash =
|
3566
|
+
T.type_alias do
|
3567
|
+
T.any(
|
3568
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit,
|
3569
|
+
Increase::Internal::AnyHash
|
3570
|
+
)
|
3571
|
+
end
|
3572
|
+
|
3573
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3574
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3575
|
+
# subtracted from the amount (such as a discount).
|
3576
|
+
sig { returns(Integer) }
|
3577
|
+
attr_accessor :amount
|
3578
|
+
|
3579
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3580
|
+
# amount's currency.
|
3581
|
+
sig { returns(String) }
|
3582
|
+
attr_accessor :currency
|
3583
|
+
|
3584
|
+
# The part of this transaction amount that was for transit-related services.
|
3585
|
+
sig do
|
3586
|
+
params(amount: Integer, currency: String).returns(
|
3587
|
+
T.attached_class
|
3588
|
+
)
|
3589
|
+
end
|
3590
|
+
def self.new(
|
3591
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3592
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3593
|
+
# subtracted from the amount (such as a discount).
|
3594
|
+
amount:,
|
3595
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3596
|
+
# amount's currency.
|
3597
|
+
currency:
|
3598
|
+
)
|
3599
|
+
end
|
3600
|
+
|
3601
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3602
|
+
def to_hash
|
3603
|
+
end
|
3604
|
+
end
|
3605
|
+
|
3606
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
3607
|
+
OrHash =
|
3608
|
+
T.type_alias do
|
3609
|
+
T.any(
|
3610
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown,
|
3611
|
+
Increase::Internal::AnyHash
|
3612
|
+
)
|
3613
|
+
end
|
3614
|
+
|
3615
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3616
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3617
|
+
# subtracted from the amount (such as a discount).
|
3618
|
+
sig { returns(Integer) }
|
3619
|
+
attr_accessor :amount
|
3620
|
+
|
3621
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3622
|
+
# amount's currency.
|
3623
|
+
sig { returns(String) }
|
3624
|
+
attr_accessor :currency
|
3625
|
+
|
3626
|
+
# An unknown additional amount.
|
3627
|
+
sig do
|
3628
|
+
params(amount: Integer, currency: String).returns(
|
3629
|
+
T.attached_class
|
3630
|
+
)
|
3631
|
+
end
|
3632
|
+
def self.new(
|
3633
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3634
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3635
|
+
# subtracted from the amount (such as a discount).
|
3636
|
+
amount:,
|
3637
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3638
|
+
# amount's currency.
|
3639
|
+
currency:
|
3640
|
+
)
|
3641
|
+
end
|
3642
|
+
|
3643
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3644
|
+
def to_hash
|
3645
|
+
end
|
3646
|
+
end
|
3647
|
+
|
3648
|
+
class Vision < Increase::Internal::Type::BaseModel
|
3649
|
+
OrHash =
|
3650
|
+
T.type_alias do
|
3651
|
+
T.any(
|
3652
|
+
Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision,
|
3653
|
+
Increase::Internal::AnyHash
|
3654
|
+
)
|
3655
|
+
end
|
3656
|
+
|
3657
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3658
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3659
|
+
# subtracted from the amount (such as a discount).
|
3660
|
+
sig { returns(Integer) }
|
3661
|
+
attr_accessor :amount
|
3662
|
+
|
3663
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3664
|
+
# amount's currency.
|
3665
|
+
sig { returns(String) }
|
3666
|
+
attr_accessor :currency
|
3667
|
+
|
3668
|
+
# The part of this transaction amount that was for vision-related services.
|
3669
|
+
sig do
|
3670
|
+
params(amount: Integer, currency: String).returns(
|
3671
|
+
T.attached_class
|
3672
|
+
)
|
3673
|
+
end
|
3674
|
+
def self.new(
|
3675
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
3676
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
3677
|
+
# subtracted from the amount (such as a discount).
|
3678
|
+
amount:,
|
3679
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3680
|
+
# amount's currency.
|
3681
|
+
currency:
|
3682
|
+
)
|
3683
|
+
end
|
3684
|
+
|
3685
|
+
sig { override.returns({ amount: Integer, currency: String }) }
|
3686
|
+
def to_hash
|
3687
|
+
end
|
3688
|
+
end
|
3689
|
+
end
|
3690
|
+
|
3691
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
3692
|
+
# transaction's currency.
|
3693
|
+
module Currency
|
3694
|
+
extend Increase::Internal::Type::Enum
|
3695
|
+
|
3696
|
+
TaggedSymbol =
|
3697
|
+
T.type_alias do
|
3698
|
+
T.all(
|
3699
|
+
Symbol,
|
3700
|
+
Increase::Transaction::Source::CardFinancial::Currency
|
3701
|
+
)
|
3702
|
+
end
|
3703
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3704
|
+
|
3705
|
+
# Canadian Dollar (CAD)
|
3706
|
+
CAD =
|
3707
|
+
T.let(
|
3708
|
+
:CAD,
|
3709
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3710
|
+
)
|
3711
|
+
|
3712
|
+
# Swiss Franc (CHF)
|
3713
|
+
CHF =
|
3714
|
+
T.let(
|
3715
|
+
:CHF,
|
3716
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3717
|
+
)
|
3718
|
+
|
3719
|
+
# Euro (EUR)
|
3720
|
+
EUR =
|
3721
|
+
T.let(
|
3722
|
+
:EUR,
|
3723
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3724
|
+
)
|
3725
|
+
|
3726
|
+
# British Pound (GBP)
|
3727
|
+
GBP =
|
3728
|
+
T.let(
|
3729
|
+
:GBP,
|
3730
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3731
|
+
)
|
3732
|
+
|
3733
|
+
# Japanese Yen (JPY)
|
3734
|
+
JPY =
|
3735
|
+
T.let(
|
3736
|
+
:JPY,
|
3737
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3738
|
+
)
|
3739
|
+
|
3740
|
+
# US Dollar (USD)
|
3741
|
+
USD =
|
3742
|
+
T.let(
|
3743
|
+
:USD,
|
3744
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3745
|
+
)
|
3746
|
+
|
3747
|
+
sig do
|
3748
|
+
override.returns(
|
3749
|
+
T::Array[
|
3750
|
+
Increase::Transaction::Source::CardFinancial::Currency::TaggedSymbol
|
3751
|
+
]
|
3752
|
+
)
|
3753
|
+
end
|
3754
|
+
def self.values
|
3755
|
+
end
|
3756
|
+
end
|
3757
|
+
|
3758
|
+
# The direction describes the direction the funds will move, either from the
|
3759
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
3760
|
+
module Direction
|
3761
|
+
extend Increase::Internal::Type::Enum
|
3762
|
+
|
3763
|
+
TaggedSymbol =
|
3764
|
+
T.type_alias do
|
3765
|
+
T.all(
|
3766
|
+
Symbol,
|
3767
|
+
Increase::Transaction::Source::CardFinancial::Direction
|
3768
|
+
)
|
3769
|
+
end
|
3770
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3771
|
+
|
3772
|
+
# A regular card authorization where funds are debited from the cardholder.
|
3773
|
+
SETTLEMENT =
|
3774
|
+
T.let(
|
3775
|
+
:settlement,
|
3776
|
+
Increase::Transaction::Source::CardFinancial::Direction::TaggedSymbol
|
3777
|
+
)
|
3778
|
+
|
3779
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
3780
|
+
REFUND =
|
3781
|
+
T.let(
|
3782
|
+
:refund,
|
3783
|
+
Increase::Transaction::Source::CardFinancial::Direction::TaggedSymbol
|
3784
|
+
)
|
3785
|
+
|
3786
|
+
sig do
|
3787
|
+
override.returns(
|
3788
|
+
T::Array[
|
3789
|
+
Increase::Transaction::Source::CardFinancial::Direction::TaggedSymbol
|
3790
|
+
]
|
3791
|
+
)
|
3792
|
+
end
|
3793
|
+
def self.values
|
3794
|
+
end
|
3795
|
+
end
|
3796
|
+
|
3797
|
+
class NetworkDetails < Increase::Internal::Type::BaseModel
|
3798
|
+
OrHash =
|
3799
|
+
T.type_alias do
|
3800
|
+
T.any(
|
3801
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails,
|
3802
|
+
Increase::Internal::AnyHash
|
3803
|
+
)
|
3804
|
+
end
|
3805
|
+
|
3806
|
+
# The payment network used to process this card authorization.
|
3807
|
+
sig do
|
3808
|
+
returns(
|
3809
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category::TaggedSymbol
|
3810
|
+
)
|
3811
|
+
end
|
3812
|
+
attr_accessor :category
|
3813
|
+
|
3814
|
+
# Fields specific to the `visa` network.
|
3815
|
+
sig do
|
3816
|
+
returns(
|
3817
|
+
T.nilable(
|
3818
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa
|
3819
|
+
)
|
3820
|
+
)
|
3821
|
+
end
|
3822
|
+
attr_reader :visa
|
3823
|
+
|
3824
|
+
sig do
|
3825
|
+
params(
|
3826
|
+
visa:
|
3827
|
+
T.nilable(
|
3828
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::OrHash
|
3829
|
+
)
|
3830
|
+
).void
|
3831
|
+
end
|
3832
|
+
attr_writer :visa
|
3833
|
+
|
3834
|
+
# Fields specific to the `network`.
|
3835
|
+
sig do
|
3836
|
+
params(
|
3837
|
+
category:
|
3838
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category::OrSymbol,
|
3839
|
+
visa:
|
3840
|
+
T.nilable(
|
3841
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::OrHash
|
3842
|
+
)
|
3843
|
+
).returns(T.attached_class)
|
3844
|
+
end
|
3845
|
+
def self.new(
|
3846
|
+
# The payment network used to process this card authorization.
|
3847
|
+
category:,
|
3848
|
+
# Fields specific to the `visa` network.
|
3849
|
+
visa:
|
3850
|
+
)
|
3851
|
+
end
|
3852
|
+
|
3853
|
+
sig do
|
3854
|
+
override.returns(
|
3855
|
+
{
|
3856
|
+
category:
|
3857
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category::TaggedSymbol,
|
3858
|
+
visa:
|
3859
|
+
T.nilable(
|
3860
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa
|
3861
|
+
)
|
3862
|
+
}
|
3863
|
+
)
|
3864
|
+
end
|
3865
|
+
def to_hash
|
3866
|
+
end
|
3867
|
+
|
3868
|
+
# The payment network used to process this card authorization.
|
3869
|
+
module Category
|
3870
|
+
extend Increase::Internal::Type::Enum
|
3871
|
+
|
3872
|
+
TaggedSymbol =
|
3873
|
+
T.type_alias do
|
3874
|
+
T.all(
|
3875
|
+
Symbol,
|
3876
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category
|
3877
|
+
)
|
3878
|
+
end
|
3879
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3880
|
+
|
3881
|
+
# Visa
|
3882
|
+
VISA =
|
3883
|
+
T.let(
|
3884
|
+
:visa,
|
3885
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category::TaggedSymbol
|
3886
|
+
)
|
3887
|
+
|
3888
|
+
sig do
|
3889
|
+
override.returns(
|
3890
|
+
T::Array[
|
3891
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Category::TaggedSymbol
|
3892
|
+
]
|
3893
|
+
)
|
3894
|
+
end
|
3895
|
+
def self.values
|
3896
|
+
end
|
3897
|
+
end
|
3898
|
+
|
3899
|
+
class Visa < Increase::Internal::Type::BaseModel
|
3900
|
+
OrHash =
|
3901
|
+
T.type_alias do
|
3902
|
+
T.any(
|
3903
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa,
|
3904
|
+
Increase::Internal::AnyHash
|
3905
|
+
)
|
3906
|
+
end
|
3907
|
+
|
3908
|
+
# For electronic commerce transactions, this identifies the level of security used
|
3909
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
3910
|
+
# transactions, identifies the type of mail or telephone order.
|
3911
|
+
sig do
|
3912
|
+
returns(
|
3913
|
+
T.nilable(
|
3914
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
3915
|
+
)
|
3916
|
+
)
|
3917
|
+
end
|
3918
|
+
attr_accessor :electronic_commerce_indicator
|
3919
|
+
|
3920
|
+
# The method used to enter the cardholder's primary account number and card
|
3921
|
+
# expiration date.
|
3922
|
+
sig do
|
3923
|
+
returns(
|
3924
|
+
T.nilable(
|
3925
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
3926
|
+
)
|
3927
|
+
)
|
3928
|
+
end
|
3929
|
+
attr_accessor :point_of_service_entry_mode
|
3930
|
+
|
3931
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
3932
|
+
# approved or declined by Visa through stand-in processing.
|
3933
|
+
sig do
|
3934
|
+
returns(
|
3935
|
+
T.nilable(
|
3936
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
3937
|
+
)
|
3938
|
+
)
|
3939
|
+
end
|
3940
|
+
attr_accessor :stand_in_processing_reason
|
3941
|
+
|
3942
|
+
# Fields specific to the `visa` network.
|
3943
|
+
sig do
|
3944
|
+
params(
|
3945
|
+
electronic_commerce_indicator:
|
3946
|
+
T.nilable(
|
3947
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::OrSymbol
|
3948
|
+
),
|
3949
|
+
point_of_service_entry_mode:
|
3950
|
+
T.nilable(
|
3951
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::OrSymbol
|
3952
|
+
),
|
3953
|
+
stand_in_processing_reason:
|
3954
|
+
T.nilable(
|
3955
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::OrSymbol
|
3956
|
+
)
|
3957
|
+
).returns(T.attached_class)
|
3958
|
+
end
|
3959
|
+
def self.new(
|
3960
|
+
# For electronic commerce transactions, this identifies the level of security used
|
3961
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
3962
|
+
# transactions, identifies the type of mail or telephone order.
|
3963
|
+
electronic_commerce_indicator:,
|
3964
|
+
# The method used to enter the cardholder's primary account number and card
|
3965
|
+
# expiration date.
|
3966
|
+
point_of_service_entry_mode:,
|
3967
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
3968
|
+
# approved or declined by Visa through stand-in processing.
|
3969
|
+
stand_in_processing_reason:
|
3970
|
+
)
|
3971
|
+
end
|
3972
|
+
|
3973
|
+
sig do
|
3974
|
+
override.returns(
|
3975
|
+
{
|
3976
|
+
electronic_commerce_indicator:
|
3977
|
+
T.nilable(
|
3978
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
3979
|
+
),
|
3980
|
+
point_of_service_entry_mode:
|
3981
|
+
T.nilable(
|
3982
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
3983
|
+
),
|
3984
|
+
stand_in_processing_reason:
|
3985
|
+
T.nilable(
|
3986
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
3987
|
+
)
|
3988
|
+
}
|
3989
|
+
)
|
3990
|
+
end
|
3991
|
+
def to_hash
|
3992
|
+
end
|
3993
|
+
|
3994
|
+
# For electronic commerce transactions, this identifies the level of security used
|
3995
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
3996
|
+
# transactions, identifies the type of mail or telephone order.
|
3997
|
+
module ElectronicCommerceIndicator
|
3998
|
+
extend Increase::Internal::Type::Enum
|
3999
|
+
|
4000
|
+
TaggedSymbol =
|
4001
|
+
T.type_alias do
|
4002
|
+
T.all(
|
4003
|
+
Symbol,
|
4004
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator
|
4005
|
+
)
|
4006
|
+
end
|
4007
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4008
|
+
|
4009
|
+
# Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.
|
4010
|
+
MAIL_PHONE_ORDER =
|
4011
|
+
T.let(
|
4012
|
+
:mail_phone_order,
|
4013
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4014
|
+
)
|
4015
|
+
|
4016
|
+
# Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.
|
4017
|
+
RECURRING =
|
4018
|
+
T.let(
|
4019
|
+
:recurring,
|
4020
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4021
|
+
)
|
4022
|
+
|
4023
|
+
# Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.
|
4024
|
+
INSTALLMENT =
|
4025
|
+
T.let(
|
4026
|
+
:installment,
|
4027
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4028
|
+
)
|
4029
|
+
|
4030
|
+
# Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.
|
4031
|
+
UNKNOWN_MAIL_PHONE_ORDER =
|
4032
|
+
T.let(
|
4033
|
+
:unknown_mail_phone_order,
|
4034
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4035
|
+
)
|
4036
|
+
|
4037
|
+
# Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure
|
4038
|
+
SECURE_ELECTRONIC_COMMERCE =
|
4039
|
+
T.let(
|
4040
|
+
:secure_electronic_commerce,
|
4041
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4042
|
+
)
|
4043
|
+
|
4044
|
+
# Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.
|
4045
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
|
4046
|
+
T.let(
|
4047
|
+
:non_authenticated_security_transaction_at_3ds_capable_merchant,
|
4048
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4049
|
+
)
|
4050
|
+
|
4051
|
+
# Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure.
|
4052
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION =
|
4053
|
+
T.let(
|
4054
|
+
:non_authenticated_security_transaction,
|
4055
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4056
|
+
)
|
4057
|
+
|
4058
|
+
# Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.
|
4059
|
+
NON_SECURE_TRANSACTION =
|
4060
|
+
T.let(
|
4061
|
+
:non_secure_transaction,
|
4062
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4063
|
+
)
|
4064
|
+
|
4065
|
+
sig do
|
4066
|
+
override.returns(
|
4067
|
+
T::Array[
|
4068
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
|
4069
|
+
]
|
4070
|
+
)
|
4071
|
+
end
|
4072
|
+
def self.values
|
4073
|
+
end
|
4074
|
+
end
|
4075
|
+
|
4076
|
+
# The method used to enter the cardholder's primary account number and card
|
4077
|
+
# expiration date.
|
4078
|
+
module PointOfServiceEntryMode
|
4079
|
+
extend Increase::Internal::Type::Enum
|
4080
|
+
|
4081
|
+
TaggedSymbol =
|
4082
|
+
T.type_alias do
|
4083
|
+
T.all(
|
4084
|
+
Symbol,
|
4085
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode
|
4086
|
+
)
|
4087
|
+
end
|
4088
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4089
|
+
|
4090
|
+
# Unknown
|
4091
|
+
UNKNOWN =
|
4092
|
+
T.let(
|
4093
|
+
:unknown,
|
4094
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4095
|
+
)
|
4096
|
+
|
4097
|
+
# Manual key entry
|
4098
|
+
MANUAL =
|
4099
|
+
T.let(
|
4100
|
+
:manual,
|
4101
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4102
|
+
)
|
4103
|
+
|
4104
|
+
# Magnetic stripe read, without card verification value
|
4105
|
+
MAGNETIC_STRIPE_NO_CVV =
|
4106
|
+
T.let(
|
4107
|
+
:magnetic_stripe_no_cvv,
|
4108
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4109
|
+
)
|
4110
|
+
|
4111
|
+
# Optical code
|
4112
|
+
OPTICAL_CODE =
|
4113
|
+
T.let(
|
4114
|
+
:optical_code,
|
4115
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4116
|
+
)
|
4117
|
+
|
4118
|
+
# Contact chip card
|
4119
|
+
INTEGRATED_CIRCUIT_CARD =
|
4120
|
+
T.let(
|
4121
|
+
:integrated_circuit_card,
|
4122
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4123
|
+
)
|
4124
|
+
|
4125
|
+
# Contactless read of chip card
|
4126
|
+
CONTACTLESS =
|
4127
|
+
T.let(
|
4128
|
+
:contactless,
|
4129
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4130
|
+
)
|
4131
|
+
|
4132
|
+
# Transaction initiated using a credential that has previously been stored on file
|
4133
|
+
CREDENTIAL_ON_FILE =
|
4134
|
+
T.let(
|
4135
|
+
:credential_on_file,
|
4136
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4137
|
+
)
|
4138
|
+
|
4139
|
+
# Magnetic stripe read
|
4140
|
+
MAGNETIC_STRIPE =
|
4141
|
+
T.let(
|
4142
|
+
:magnetic_stripe,
|
4143
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4144
|
+
)
|
4145
|
+
|
4146
|
+
# Contactless read of magnetic stripe data
|
4147
|
+
CONTACTLESS_MAGNETIC_STRIPE =
|
4148
|
+
T.let(
|
4149
|
+
:contactless_magnetic_stripe,
|
4150
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4151
|
+
)
|
4152
|
+
|
4153
|
+
# Contact chip card, without card verification value
|
4154
|
+
INTEGRATED_CIRCUIT_CARD_NO_CVV =
|
4155
|
+
T.let(
|
4156
|
+
:integrated_circuit_card_no_cvv,
|
4157
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4158
|
+
)
|
4159
|
+
|
4160
|
+
sig do
|
4161
|
+
override.returns(
|
4162
|
+
T::Array[
|
4163
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
|
4164
|
+
]
|
4165
|
+
)
|
4166
|
+
end
|
4167
|
+
def self.values
|
4168
|
+
end
|
4169
|
+
end
|
4170
|
+
|
4171
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
4172
|
+
# approved or declined by Visa through stand-in processing.
|
4173
|
+
module StandInProcessingReason
|
4174
|
+
extend Increase::Internal::Type::Enum
|
4175
|
+
|
4176
|
+
TaggedSymbol =
|
4177
|
+
T.type_alias do
|
4178
|
+
T.all(
|
4179
|
+
Symbol,
|
4180
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason
|
4181
|
+
)
|
4182
|
+
end
|
4183
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4184
|
+
|
4185
|
+
# Increase failed to process the authorization in a timely manner.
|
4186
|
+
ISSUER_ERROR =
|
4187
|
+
T.let(
|
4188
|
+
:issuer_error,
|
4189
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4190
|
+
)
|
4191
|
+
|
4192
|
+
# The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
|
4193
|
+
INVALID_PHYSICAL_CARD =
|
4194
|
+
T.let(
|
4195
|
+
:invalid_physical_card,
|
4196
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4197
|
+
)
|
4198
|
+
|
4199
|
+
# The 3DS cardholder authentication verification value was invalid.
|
4200
|
+
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
|
4201
|
+
T.let(
|
4202
|
+
:invalid_cardholder_authentication_verification_value,
|
4203
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4204
|
+
)
|
4205
|
+
|
4206
|
+
# An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
|
4207
|
+
INTERNAL_VISA_ERROR =
|
4208
|
+
T.let(
|
4209
|
+
:internal_visa_error,
|
4210
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4211
|
+
)
|
4212
|
+
|
4213
|
+
# The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.
|
4214
|
+
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
|
4215
|
+
T.let(
|
4216
|
+
:merchant_transaction_advisory_service_authentication_required,
|
4217
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4218
|
+
)
|
4219
|
+
|
4220
|
+
# The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
|
4221
|
+
PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK =
|
4222
|
+
T.let(
|
4223
|
+
:payment_fraud_disruption_acquirer_block,
|
4224
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4225
|
+
)
|
4226
|
+
|
4227
|
+
# An unspecific reason for stand-in processing.
|
4228
|
+
OTHER =
|
4229
|
+
T.let(
|
4230
|
+
:other,
|
4231
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4232
|
+
)
|
4233
|
+
|
4234
|
+
sig do
|
4235
|
+
override.returns(
|
4236
|
+
T::Array[
|
4237
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
|
4238
|
+
]
|
4239
|
+
)
|
4240
|
+
end
|
4241
|
+
def self.values
|
4242
|
+
end
|
4243
|
+
end
|
4244
|
+
end
|
4245
|
+
end
|
4246
|
+
|
4247
|
+
class NetworkIdentifiers < Increase::Internal::Type::BaseModel
|
4248
|
+
OrHash =
|
4249
|
+
T.type_alias do
|
4250
|
+
T.any(
|
4251
|
+
Increase::Transaction::Source::CardFinancial::NetworkIdentifiers,
|
4252
|
+
Increase::Internal::AnyHash
|
4253
|
+
)
|
4254
|
+
end
|
4255
|
+
|
4256
|
+
# A life-cycle identifier used across e.g., an authorization and a reversal.
|
4257
|
+
# Expected to be unique per acquirer within a window of time. For some card
|
4258
|
+
# networks the retrieval reference number includes the trace counter.
|
4259
|
+
sig { returns(T.nilable(String)) }
|
4260
|
+
attr_accessor :retrieval_reference_number
|
4261
|
+
|
4262
|
+
# A counter used to verify an individual authorization. Expected to be unique per
|
4263
|
+
# acquirer within a window of time.
|
4264
|
+
sig { returns(T.nilable(String)) }
|
4265
|
+
attr_accessor :trace_number
|
4266
|
+
|
4267
|
+
# A globally unique transaction identifier provided by the card network, used
|
4268
|
+
# across multiple life-cycle requests.
|
4269
|
+
sig { returns(T.nilable(String)) }
|
4270
|
+
attr_accessor :transaction_id
|
4271
|
+
|
4272
|
+
# Network-specific identifiers for a specific request or transaction.
|
4273
|
+
sig do
|
4274
|
+
params(
|
4275
|
+
retrieval_reference_number: T.nilable(String),
|
4276
|
+
trace_number: T.nilable(String),
|
4277
|
+
transaction_id: T.nilable(String)
|
4278
|
+
).returns(T.attached_class)
|
4279
|
+
end
|
4280
|
+
def self.new(
|
4281
|
+
# A life-cycle identifier used across e.g., an authorization and a reversal.
|
4282
|
+
# Expected to be unique per acquirer within a window of time. For some card
|
4283
|
+
# networks the retrieval reference number includes the trace counter.
|
4284
|
+
retrieval_reference_number:,
|
4285
|
+
# A counter used to verify an individual authorization. Expected to be unique per
|
4286
|
+
# acquirer within a window of time.
|
4287
|
+
trace_number:,
|
4288
|
+
# A globally unique transaction identifier provided by the card network, used
|
4289
|
+
# across multiple life-cycle requests.
|
4290
|
+
transaction_id:
|
4291
|
+
)
|
4292
|
+
end
|
4293
|
+
|
4294
|
+
sig do
|
4295
|
+
override.returns(
|
4296
|
+
{
|
4297
|
+
retrieval_reference_number: T.nilable(String),
|
4298
|
+
trace_number: T.nilable(String),
|
4299
|
+
transaction_id: T.nilable(String)
|
4300
|
+
}
|
4301
|
+
)
|
4302
|
+
end
|
4303
|
+
def to_hash
|
4304
|
+
end
|
4305
|
+
end
|
4306
|
+
|
4307
|
+
# The processing category describes the intent behind the financial, such as
|
4308
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
4309
|
+
module ProcessingCategory
|
4310
|
+
extend Increase::Internal::Type::Enum
|
4311
|
+
|
4312
|
+
TaggedSymbol =
|
4313
|
+
T.type_alias do
|
4314
|
+
T.all(
|
4315
|
+
Symbol,
|
4316
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory
|
4317
|
+
)
|
4318
|
+
end
|
4319
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4320
|
+
|
4321
|
+
# Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.
|
4322
|
+
ACCOUNT_FUNDING =
|
4323
|
+
T.let(
|
4324
|
+
:account_funding,
|
4325
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4326
|
+
)
|
4327
|
+
|
4328
|
+
# Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.
|
4329
|
+
AUTOMATIC_FUEL_DISPENSER =
|
4330
|
+
T.let(
|
4331
|
+
:automatic_fuel_dispenser,
|
4332
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4333
|
+
)
|
4334
|
+
|
4335
|
+
# A transaction used to pay a bill.
|
4336
|
+
BILL_PAYMENT =
|
4337
|
+
T.let(
|
4338
|
+
:bill_payment,
|
4339
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4340
|
+
)
|
4341
|
+
|
4342
|
+
# Original credit transactions are used to send money to a cardholder.
|
4343
|
+
ORIGINAL_CREDIT =
|
4344
|
+
T.let(
|
4345
|
+
:original_credit,
|
4346
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4347
|
+
)
|
4348
|
+
|
4349
|
+
# A regular purchase.
|
4350
|
+
PURCHASE =
|
4351
|
+
T.let(
|
4352
|
+
:purchase,
|
4353
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4354
|
+
)
|
4355
|
+
|
4356
|
+
# Quasi-cash transactions represent purchases of items which may be convertible to cash.
|
4357
|
+
QUASI_CASH =
|
4358
|
+
T.let(
|
4359
|
+
:quasi_cash,
|
4360
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4361
|
+
)
|
4362
|
+
|
4363
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
4364
|
+
REFUND =
|
4365
|
+
T.let(
|
4366
|
+
:refund,
|
4367
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4368
|
+
)
|
4369
|
+
|
4370
|
+
# Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
|
4371
|
+
CASH_DISBURSEMENT =
|
4372
|
+
T.let(
|
4373
|
+
:cash_disbursement,
|
4374
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4375
|
+
)
|
4376
|
+
|
4377
|
+
# The processing category is unknown.
|
4378
|
+
UNKNOWN =
|
4379
|
+
T.let(
|
4380
|
+
:unknown,
|
4381
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4382
|
+
)
|
4383
|
+
|
4384
|
+
sig do
|
4385
|
+
override.returns(
|
4386
|
+
T::Array[
|
4387
|
+
Increase::Transaction::Source::CardFinancial::ProcessingCategory::TaggedSymbol
|
4388
|
+
]
|
4389
|
+
)
|
4390
|
+
end
|
4391
|
+
def self.values
|
4392
|
+
end
|
4393
|
+
end
|
4394
|
+
|
4395
|
+
# A constant representing the object's type. For this resource it will always be
|
4396
|
+
# `card_financial`.
|
4397
|
+
module Type
|
2381
4398
|
extend Increase::Internal::Type::Enum
|
2382
4399
|
|
2383
4400
|
TaggedSymbol =
|
2384
4401
|
T.type_alias do
|
2385
4402
|
T.all(
|
2386
4403
|
Symbol,
|
2387
|
-
Increase::Transaction::Source::
|
4404
|
+
Increase::Transaction::Source::CardFinancial::Type
|
2388
4405
|
)
|
2389
4406
|
end
|
2390
4407
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2391
4408
|
|
2392
|
-
|
2393
|
-
VISA =
|
4409
|
+
CARD_FINANCIAL =
|
2394
4410
|
T.let(
|
2395
|
-
:
|
2396
|
-
Increase::Transaction::Source::
|
4411
|
+
:card_financial,
|
4412
|
+
Increase::Transaction::Source::CardFinancial::Type::TaggedSymbol
|
2397
4413
|
)
|
2398
4414
|
|
2399
4415
|
sig do
|
2400
4416
|
override.returns(
|
2401
4417
|
T::Array[
|
2402
|
-
Increase::Transaction::Source::
|
4418
|
+
Increase::Transaction::Source::CardFinancial::Type::TaggedSymbol
|
2403
4419
|
]
|
2404
4420
|
)
|
2405
4421
|
end
|
@@ -2407,175 +4423,311 @@ module Increase
|
|
2407
4423
|
end
|
2408
4424
|
end
|
2409
4425
|
|
2410
|
-
class
|
4426
|
+
class Verification < Increase::Internal::Type::BaseModel
|
2411
4427
|
OrHash =
|
2412
4428
|
T.type_alias do
|
2413
4429
|
T.any(
|
2414
|
-
Increase::Transaction::Source::
|
4430
|
+
Increase::Transaction::Source::CardFinancial::Verification,
|
2415
4431
|
Increase::Internal::AnyHash
|
2416
4432
|
)
|
2417
4433
|
end
|
2418
4434
|
|
2419
|
-
#
|
4435
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
4436
|
+
# the back of the card.
|
2420
4437
|
sig do
|
2421
4438
|
returns(
|
2422
|
-
Increase::Transaction::Source::
|
4439
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode
|
2423
4440
|
)
|
2424
4441
|
end
|
2425
|
-
|
4442
|
+
attr_reader :card_verification_code
|
2426
4443
|
|
2427
|
-
# Information for events related to card dispute for card payments processed over
|
2428
|
-
# Visa's network. This field will be present in the JSON response if and only if
|
2429
|
-
# `network` is equal to `visa`.
|
2430
4444
|
sig do
|
2431
4445
|
params(
|
2432
|
-
|
2433
|
-
Increase::Transaction::Source::
|
4446
|
+
card_verification_code:
|
4447
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::OrHash
|
4448
|
+
).void
|
4449
|
+
end
|
4450
|
+
attr_writer :card_verification_code
|
4451
|
+
|
4452
|
+
# Cardholder address provided in the authorization request and the address on file
|
4453
|
+
# we verified it against.
|
4454
|
+
sig do
|
4455
|
+
returns(
|
4456
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress
|
4457
|
+
)
|
4458
|
+
end
|
4459
|
+
attr_reader :cardholder_address
|
4460
|
+
|
4461
|
+
sig do
|
4462
|
+
params(
|
4463
|
+
cardholder_address:
|
4464
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::OrHash
|
4465
|
+
).void
|
4466
|
+
end
|
4467
|
+
attr_writer :cardholder_address
|
4468
|
+
|
4469
|
+
# Fields related to verification of cardholder-provided values.
|
4470
|
+
sig do
|
4471
|
+
params(
|
4472
|
+
card_verification_code:
|
4473
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::OrHash,
|
4474
|
+
cardholder_address:
|
4475
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::OrHash
|
2434
4476
|
).returns(T.attached_class)
|
2435
4477
|
end
|
2436
4478
|
def self.new(
|
2437
|
-
#
|
2438
|
-
|
4479
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
4480
|
+
# the back of the card.
|
4481
|
+
card_verification_code:,
|
4482
|
+
# Cardholder address provided in the authorization request and the address on file
|
4483
|
+
# we verified it against.
|
4484
|
+
cardholder_address:
|
2439
4485
|
)
|
2440
4486
|
end
|
2441
4487
|
|
2442
4488
|
sig do
|
2443
4489
|
override.returns(
|
2444
4490
|
{
|
2445
|
-
|
2446
|
-
Increase::Transaction::Source::
|
4491
|
+
card_verification_code:
|
4492
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode,
|
4493
|
+
cardholder_address:
|
4494
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress
|
2447
4495
|
}
|
2448
4496
|
)
|
2449
4497
|
end
|
2450
4498
|
def to_hash
|
2451
4499
|
end
|
2452
4500
|
|
2453
|
-
|
2454
|
-
|
2455
|
-
extend Increase::Internal::Type::Enum
|
2456
|
-
|
2457
|
-
TaggedSymbol =
|
4501
|
+
class CardVerificationCode < Increase::Internal::Type::BaseModel
|
4502
|
+
OrHash =
|
2458
4503
|
T.type_alias do
|
2459
|
-
T.
|
2460
|
-
|
2461
|
-
Increase::
|
4504
|
+
T.any(
|
4505
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode,
|
4506
|
+
Increase::Internal::AnyHash
|
2462
4507
|
)
|
2463
4508
|
end
|
2464
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2465
4509
|
|
2466
|
-
# The
|
2467
|
-
|
2468
|
-
|
2469
|
-
|
2470
|
-
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
4510
|
+
# The result of verifying the Card Verification Code.
|
4511
|
+
sig do
|
4512
|
+
returns(
|
4513
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
2471
4514
|
)
|
4515
|
+
end
|
4516
|
+
attr_accessor :result
|
2472
4517
|
|
2473
|
-
#
|
2474
|
-
|
2475
|
-
|
2476
|
-
|
2477
|
-
|
2478
|
-
|
4518
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
4519
|
+
# the back of the card.
|
4520
|
+
sig do
|
4521
|
+
params(
|
4522
|
+
result:
|
4523
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::OrSymbol
|
4524
|
+
).returns(T.attached_class)
|
4525
|
+
end
|
4526
|
+
def self.new(
|
4527
|
+
# The result of verifying the Card Verification Code.
|
4528
|
+
result:
|
4529
|
+
)
|
4530
|
+
end
|
2479
4531
|
|
2480
|
-
|
2481
|
-
|
2482
|
-
|
2483
|
-
|
2484
|
-
|
4532
|
+
sig do
|
4533
|
+
override.returns(
|
4534
|
+
{
|
4535
|
+
result:
|
4536
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
4537
|
+
}
|
2485
4538
|
)
|
4539
|
+
end
|
4540
|
+
def to_hash
|
4541
|
+
end
|
2486
4542
|
|
2487
|
-
# The
|
2488
|
-
|
2489
|
-
|
2490
|
-
:represented,
|
2491
|
-
Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType::TaggedSymbol
|
2492
|
-
)
|
4543
|
+
# The result of verifying the Card Verification Code.
|
4544
|
+
module Result
|
4545
|
+
extend Increase::Internal::Type::Enum
|
2493
4546
|
|
2494
|
-
|
2495
|
-
|
2496
|
-
|
2497
|
-
|
2498
|
-
|
2499
|
-
|
4547
|
+
TaggedSymbol =
|
4548
|
+
T.type_alias do
|
4549
|
+
T.all(
|
4550
|
+
Symbol,
|
4551
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result
|
4552
|
+
)
|
4553
|
+
end
|
4554
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2500
4555
|
|
2501
|
-
|
2502
|
-
|
2503
|
-
|
2504
|
-
|
2505
|
-
|
2506
|
-
|
4556
|
+
# No card verification code was provided in the authorization request.
|
4557
|
+
NOT_CHECKED =
|
4558
|
+
T.let(
|
4559
|
+
:not_checked,
|
4560
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
4561
|
+
)
|
2507
4562
|
|
2508
|
-
|
2509
|
-
|
2510
|
-
|
2511
|
-
|
2512
|
-
|
4563
|
+
# The card verification code matched the one on file.
|
4564
|
+
MATCH =
|
4565
|
+
T.let(
|
4566
|
+
:match,
|
4567
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
4568
|
+
)
|
4569
|
+
|
4570
|
+
# The card verification code did not match the one on file.
|
4571
|
+
NO_MATCH =
|
4572
|
+
T.let(
|
4573
|
+
:no_match,
|
4574
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
4575
|
+
)
|
4576
|
+
|
4577
|
+
sig do
|
4578
|
+
override.returns(
|
4579
|
+
T::Array[
|
4580
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result::TaggedSymbol
|
4581
|
+
]
|
4582
|
+
)
|
4583
|
+
end
|
4584
|
+
def self.values
|
4585
|
+
end
|
4586
|
+
end
|
4587
|
+
end
|
4588
|
+
|
4589
|
+
class CardholderAddress < Increase::Internal::Type::BaseModel
|
4590
|
+
OrHash =
|
4591
|
+
T.type_alias do
|
4592
|
+
T.any(
|
4593
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress,
|
4594
|
+
Increase::Internal::AnyHash
|
4595
|
+
)
|
4596
|
+
end
|
4597
|
+
|
4598
|
+
# Line 1 of the address on file for the cardholder.
|
4599
|
+
sig { returns(T.nilable(String)) }
|
4600
|
+
attr_accessor :actual_line1
|
4601
|
+
|
4602
|
+
# The postal code of the address on file for the cardholder.
|
4603
|
+
sig { returns(T.nilable(String)) }
|
4604
|
+
attr_accessor :actual_postal_code
|
4605
|
+
|
4606
|
+
# The cardholder address line 1 provided for verification in the authorization
|
4607
|
+
# request.
|
4608
|
+
sig { returns(T.nilable(String)) }
|
4609
|
+
attr_accessor :provided_line1
|
4610
|
+
|
4611
|
+
# The postal code provided for verification in the authorization request.
|
4612
|
+
sig { returns(T.nilable(String)) }
|
4613
|
+
attr_accessor :provided_postal_code
|
4614
|
+
|
4615
|
+
# The address verification result returned to the card network.
|
4616
|
+
sig do
|
4617
|
+
returns(
|
4618
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
2513
4619
|
)
|
4620
|
+
end
|
4621
|
+
attr_accessor :result
|
4622
|
+
|
4623
|
+
# Cardholder address provided in the authorization request and the address on file
|
4624
|
+
# we verified it against.
|
4625
|
+
sig do
|
4626
|
+
params(
|
4627
|
+
actual_line1: T.nilable(String),
|
4628
|
+
actual_postal_code: T.nilable(String),
|
4629
|
+
provided_line1: T.nilable(String),
|
4630
|
+
provided_postal_code: T.nilable(String),
|
4631
|
+
result:
|
4632
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::OrSymbol
|
4633
|
+
).returns(T.attached_class)
|
4634
|
+
end
|
4635
|
+
def self.new(
|
4636
|
+
# Line 1 of the address on file for the cardholder.
|
4637
|
+
actual_line1:,
|
4638
|
+
# The postal code of the address on file for the cardholder.
|
4639
|
+
actual_postal_code:,
|
4640
|
+
# The cardholder address line 1 provided for verification in the authorization
|
4641
|
+
# request.
|
4642
|
+
provided_line1:,
|
4643
|
+
# The postal code provided for verification in the authorization request.
|
4644
|
+
provided_postal_code:,
|
4645
|
+
# The address verification result returned to the card network.
|
4646
|
+
result:
|
4647
|
+
)
|
4648
|
+
end
|
2514
4649
|
|
2515
4650
|
sig do
|
2516
4651
|
override.returns(
|
2517
|
-
|
2518
|
-
|
2519
|
-
|
4652
|
+
{
|
4653
|
+
actual_line1: T.nilable(String),
|
4654
|
+
actual_postal_code: T.nilable(String),
|
4655
|
+
provided_line1: T.nilable(String),
|
4656
|
+
provided_postal_code: T.nilable(String),
|
4657
|
+
result:
|
4658
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4659
|
+
}
|
2520
4660
|
)
|
2521
4661
|
end
|
2522
|
-
def
|
4662
|
+
def to_hash
|
2523
4663
|
end
|
2524
|
-
end
|
2525
|
-
end
|
2526
|
-
end
|
2527
4664
|
|
2528
|
-
|
2529
|
-
|
2530
|
-
|
2531
|
-
T.any(
|
2532
|
-
Increase::Transaction::Source::CardDisputeLoss,
|
2533
|
-
Increase::Internal::AnyHash
|
2534
|
-
)
|
2535
|
-
end
|
4665
|
+
# The address verification result returned to the card network.
|
4666
|
+
module Result
|
4667
|
+
extend Increase::Internal::Type::Enum
|
2536
4668
|
|
2537
|
-
|
2538
|
-
|
2539
|
-
|
4669
|
+
TaggedSymbol =
|
4670
|
+
T.type_alias do
|
4671
|
+
T.all(
|
4672
|
+
Symbol,
|
4673
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result
|
4674
|
+
)
|
4675
|
+
end
|
4676
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2540
4677
|
|
2541
|
-
|
2542
|
-
|
2543
|
-
|
2544
|
-
|
4678
|
+
# No address information was provided in the authorization request.
|
4679
|
+
NOT_CHECKED =
|
4680
|
+
T.let(
|
4681
|
+
:not_checked,
|
4682
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4683
|
+
)
|
2545
4684
|
|
2546
|
-
|
2547
|
-
|
2548
|
-
|
2549
|
-
|
4685
|
+
# Postal code matches, but the street address does not match or was not provided.
|
4686
|
+
POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
|
4687
|
+
T.let(
|
4688
|
+
:postal_code_match_address_no_match,
|
4689
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4690
|
+
)
|
2550
4691
|
|
2551
|
-
|
2552
|
-
|
2553
|
-
|
2554
|
-
|
2555
|
-
|
2556
|
-
|
2557
|
-
lost_at: Time,
|
2558
|
-
transaction_id: String
|
2559
|
-
).returns(T.attached_class)
|
2560
|
-
end
|
2561
|
-
def self.new(
|
2562
|
-
# Why the Card Dispute was lost.
|
2563
|
-
explanation:,
|
2564
|
-
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
2565
|
-
# the Card Dispute was lost.
|
2566
|
-
lost_at:,
|
2567
|
-
# The identifier of the Transaction that was created to debit the disputed funds
|
2568
|
-
# from your account.
|
2569
|
-
transaction_id:
|
2570
|
-
)
|
2571
|
-
end
|
4692
|
+
# Postal code does not match, but the street address matches or was not provided.
|
4693
|
+
POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
|
4694
|
+
T.let(
|
4695
|
+
:postal_code_no_match_address_match,
|
4696
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4697
|
+
)
|
2572
4698
|
|
2573
|
-
|
2574
|
-
|
2575
|
-
|
2576
|
-
|
2577
|
-
|
2578
|
-
|
4699
|
+
# Postal code and street address match.
|
4700
|
+
MATCH =
|
4701
|
+
T.let(
|
4702
|
+
:match,
|
4703
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4704
|
+
)
|
4705
|
+
|
4706
|
+
# Postal code and street address do not match.
|
4707
|
+
NO_MATCH =
|
4708
|
+
T.let(
|
4709
|
+
:no_match,
|
4710
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4711
|
+
)
|
4712
|
+
|
4713
|
+
# Postal code matches, but the street address was not verified. (deprecated)
|
4714
|
+
POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
|
4715
|
+
T.let(
|
4716
|
+
:postal_code_match_address_not_checked,
|
4717
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4718
|
+
)
|
4719
|
+
|
4720
|
+
sig do
|
4721
|
+
override.returns(
|
4722
|
+
T::Array[
|
4723
|
+
Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result::TaggedSymbol
|
4724
|
+
]
|
4725
|
+
)
|
4726
|
+
end
|
4727
|
+
def self.values
|
4728
|
+
end
|
4729
|
+
end
|
4730
|
+
end
|
2579
4731
|
end
|
2580
4732
|
end
|
2581
4733
|
|
@@ -7985,6 +10137,13 @@ module Increase
|
|
7985
10137
|
Increase::Transaction::Source::Category::TaggedSymbol
|
7986
10138
|
)
|
7987
10139
|
|
10140
|
+
# Card Financial: details will be under the `card_financial` object.
|
10141
|
+
CARD_FINANCIAL =
|
10142
|
+
T.let(
|
10143
|
+
:card_financial,
|
10144
|
+
Increase::Transaction::Source::Category::TaggedSymbol
|
10145
|
+
)
|
10146
|
+
|
7988
10147
|
# Card Revenue Payment: details will be under the `card_revenue_payment` object.
|
7989
10148
|
CARD_REVENUE_PAYMENT =
|
7990
10149
|
T.let(
|