increase 1.157.0 → 1.158.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.
@@ -172,6 +172,26 @@ module Increase
172
172
  end
173
173
  attr_writer :card_authorization_expiration
174
174
 
175
+ # A Card Balance Inquiry object. This field will be present in the JSON response
176
+ # if and only if `category` is equal to `card_balance_inquiry`. Card Balance
177
+ # Inquiries are transactions that allow merchants to check the available balance
178
+ # on a card without placing a hold on funds, commonly used when a customer
179
+ # requests their balance at an ATM.
180
+ sig do
181
+ returns(T.nilable(Increase::CardPayment::Element::CardBalanceInquiry))
182
+ end
183
+ attr_reader :card_balance_inquiry
184
+
185
+ sig do
186
+ params(
187
+ card_balance_inquiry:
188
+ T.nilable(
189
+ Increase::CardPayment::Element::CardBalanceInquiry::OrHash
190
+ )
191
+ ).void
192
+ end
193
+ attr_writer :card_balance_inquiry
194
+
175
195
  # A Card Decline object. This field will be present in the JSON response if and
176
196
  # only if `category` is equal to `card_decline`.
177
197
  sig { returns(T.nilable(Increase::CardPayment::Element::CardDecline)) }
@@ -339,6 +359,10 @@ module Increase
339
359
  T.nilable(
340
360
  Increase::CardPayment::Element::CardAuthorizationExpiration::OrHash
341
361
  ),
362
+ card_balance_inquiry:
363
+ T.nilable(
364
+ Increase::CardPayment::Element::CardBalanceInquiry::OrHash
365
+ ),
342
366
  card_decline:
343
367
  T.nilable(Increase::CardPayment::Element::CardDecline::OrHash),
344
368
  card_financial:
@@ -377,6 +401,12 @@ module Increase
377
401
  # Card Authorization Expirations are cancellations of authorizations that were
378
402
  # never settled by the acquirer.
379
403
  card_authorization_expiration:,
404
+ # A Card Balance Inquiry object. This field will be present in the JSON response
405
+ # if and only if `category` is equal to `card_balance_inquiry`. Card Balance
406
+ # Inquiries are transactions that allow merchants to check the available balance
407
+ # on a card without placing a hold on funds, commonly used when a customer
408
+ # requests their balance at an ATM.
409
+ card_balance_inquiry:,
380
410
  # A Card Decline object. This field will be present in the JSON response if and
381
411
  # only if `category` is equal to `card_decline`.
382
412
  card_decline:,
@@ -437,6 +467,8 @@ module Increase
437
467
  T.nilable(
438
468
  Increase::CardPayment::Element::CardAuthorizationExpiration
439
469
  ),
470
+ card_balance_inquiry:
471
+ T.nilable(Increase::CardPayment::Element::CardBalanceInquiry),
440
472
  card_decline:
441
473
  T.nilable(Increase::CardPayment::Element::CardDecline),
442
474
  card_financial:
@@ -3108,17 +3140,2213 @@ module Increase
3108
3140
 
3109
3141
  sig do
3110
3142
  override.returns(
3111
- T::Array[
3112
- Increase::CardPayment::Element::CardAuthorization::ProcessingCategory::TaggedSymbol
3113
- ]
3143
+ T::Array[
3144
+ Increase::CardPayment::Element::CardAuthorization::ProcessingCategory::TaggedSymbol
3145
+ ]
3146
+ )
3147
+ end
3148
+ def self.values
3149
+ end
3150
+ end
3151
+
3152
+ # A constant representing the object's type. For this resource it will always be
3153
+ # `card_authorization`.
3154
+ module Type
3155
+ extend Increase::Internal::Type::Enum
3156
+
3157
+ TaggedSymbol =
3158
+ T.type_alias do
3159
+ T.all(
3160
+ Symbol,
3161
+ Increase::CardPayment::Element::CardAuthorization::Type
3162
+ )
3163
+ end
3164
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3165
+
3166
+ CARD_AUTHORIZATION =
3167
+ T.let(
3168
+ :card_authorization,
3169
+ Increase::CardPayment::Element::CardAuthorization::Type::TaggedSymbol
3170
+ )
3171
+
3172
+ sig do
3173
+ override.returns(
3174
+ T::Array[
3175
+ Increase::CardPayment::Element::CardAuthorization::Type::TaggedSymbol
3176
+ ]
3177
+ )
3178
+ end
3179
+ def self.values
3180
+ end
3181
+ end
3182
+
3183
+ class Verification < Increase::Internal::Type::BaseModel
3184
+ OrHash =
3185
+ T.type_alias do
3186
+ T.any(
3187
+ Increase::CardPayment::Element::CardAuthorization::Verification,
3188
+ Increase::Internal::AnyHash
3189
+ )
3190
+ end
3191
+
3192
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
3193
+ # the back of the card.
3194
+ sig do
3195
+ returns(
3196
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode
3197
+ )
3198
+ end
3199
+ attr_reader :card_verification_code
3200
+
3201
+ sig do
3202
+ params(
3203
+ card_verification_code:
3204
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::OrHash
3205
+ ).void
3206
+ end
3207
+ attr_writer :card_verification_code
3208
+
3209
+ # Cardholder address provided in the authorization request and the address on file
3210
+ # we verified it against.
3211
+ sig do
3212
+ returns(
3213
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress
3214
+ )
3215
+ end
3216
+ attr_reader :cardholder_address
3217
+
3218
+ sig do
3219
+ params(
3220
+ cardholder_address:
3221
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::OrHash
3222
+ ).void
3223
+ end
3224
+ attr_writer :cardholder_address
3225
+
3226
+ # Fields related to verification of cardholder-provided values.
3227
+ sig do
3228
+ params(
3229
+ card_verification_code:
3230
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::OrHash,
3231
+ cardholder_address:
3232
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::OrHash
3233
+ ).returns(T.attached_class)
3234
+ end
3235
+ def self.new(
3236
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
3237
+ # the back of the card.
3238
+ card_verification_code:,
3239
+ # Cardholder address provided in the authorization request and the address on file
3240
+ # we verified it against.
3241
+ cardholder_address:
3242
+ )
3243
+ end
3244
+
3245
+ sig do
3246
+ override.returns(
3247
+ {
3248
+ card_verification_code:
3249
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode,
3250
+ cardholder_address:
3251
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress
3252
+ }
3253
+ )
3254
+ end
3255
+ def to_hash
3256
+ end
3257
+
3258
+ class CardVerificationCode < Increase::Internal::Type::BaseModel
3259
+ OrHash =
3260
+ T.type_alias do
3261
+ T.any(
3262
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode,
3263
+ Increase::Internal::AnyHash
3264
+ )
3265
+ end
3266
+
3267
+ # The result of verifying the Card Verification Code.
3268
+ sig do
3269
+ returns(
3270
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3271
+ )
3272
+ end
3273
+ attr_accessor :result
3274
+
3275
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
3276
+ # the back of the card.
3277
+ sig do
3278
+ params(
3279
+ result:
3280
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::OrSymbol
3281
+ ).returns(T.attached_class)
3282
+ end
3283
+ def self.new(
3284
+ # The result of verifying the Card Verification Code.
3285
+ result:
3286
+ )
3287
+ end
3288
+
3289
+ sig do
3290
+ override.returns(
3291
+ {
3292
+ result:
3293
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3294
+ }
3295
+ )
3296
+ end
3297
+ def to_hash
3298
+ end
3299
+
3300
+ # The result of verifying the Card Verification Code.
3301
+ module Result
3302
+ extend Increase::Internal::Type::Enum
3303
+
3304
+ TaggedSymbol =
3305
+ T.type_alias do
3306
+ T.all(
3307
+ Symbol,
3308
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result
3309
+ )
3310
+ end
3311
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3312
+
3313
+ # No card verification code was provided in the authorization request.
3314
+ NOT_CHECKED =
3315
+ T.let(
3316
+ :not_checked,
3317
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3318
+ )
3319
+
3320
+ # The card verification code matched the one on file.
3321
+ MATCH =
3322
+ T.let(
3323
+ :match,
3324
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3325
+ )
3326
+
3327
+ # The card verification code did not match the one on file.
3328
+ NO_MATCH =
3329
+ T.let(
3330
+ :no_match,
3331
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3332
+ )
3333
+
3334
+ sig do
3335
+ override.returns(
3336
+ T::Array[
3337
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
3338
+ ]
3339
+ )
3340
+ end
3341
+ def self.values
3342
+ end
3343
+ end
3344
+ end
3345
+
3346
+ class CardholderAddress < Increase::Internal::Type::BaseModel
3347
+ OrHash =
3348
+ T.type_alias do
3349
+ T.any(
3350
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress,
3351
+ Increase::Internal::AnyHash
3352
+ )
3353
+ end
3354
+
3355
+ # Line 1 of the address on file for the cardholder.
3356
+ sig { returns(T.nilable(String)) }
3357
+ attr_accessor :actual_line1
3358
+
3359
+ # The postal code of the address on file for the cardholder.
3360
+ sig { returns(T.nilable(String)) }
3361
+ attr_accessor :actual_postal_code
3362
+
3363
+ # The cardholder address line 1 provided for verification in the authorization
3364
+ # request.
3365
+ sig { returns(T.nilable(String)) }
3366
+ attr_accessor :provided_line1
3367
+
3368
+ # The postal code provided for verification in the authorization request.
3369
+ sig { returns(T.nilable(String)) }
3370
+ attr_accessor :provided_postal_code
3371
+
3372
+ # The address verification result returned to the card network.
3373
+ sig do
3374
+ returns(
3375
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3376
+ )
3377
+ end
3378
+ attr_accessor :result
3379
+
3380
+ # Cardholder address provided in the authorization request and the address on file
3381
+ # we verified it against.
3382
+ sig do
3383
+ params(
3384
+ actual_line1: T.nilable(String),
3385
+ actual_postal_code: T.nilable(String),
3386
+ provided_line1: T.nilable(String),
3387
+ provided_postal_code: T.nilable(String),
3388
+ result:
3389
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::OrSymbol
3390
+ ).returns(T.attached_class)
3391
+ end
3392
+ def self.new(
3393
+ # Line 1 of the address on file for the cardholder.
3394
+ actual_line1:,
3395
+ # The postal code of the address on file for the cardholder.
3396
+ actual_postal_code:,
3397
+ # The cardholder address line 1 provided for verification in the authorization
3398
+ # request.
3399
+ provided_line1:,
3400
+ # The postal code provided for verification in the authorization request.
3401
+ provided_postal_code:,
3402
+ # The address verification result returned to the card network.
3403
+ result:
3404
+ )
3405
+ end
3406
+
3407
+ sig do
3408
+ override.returns(
3409
+ {
3410
+ actual_line1: T.nilable(String),
3411
+ actual_postal_code: T.nilable(String),
3412
+ provided_line1: T.nilable(String),
3413
+ provided_postal_code: T.nilable(String),
3414
+ result:
3415
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3416
+ }
3417
+ )
3418
+ end
3419
+ def to_hash
3420
+ end
3421
+
3422
+ # The address verification result returned to the card network.
3423
+ module Result
3424
+ extend Increase::Internal::Type::Enum
3425
+
3426
+ TaggedSymbol =
3427
+ T.type_alias do
3428
+ T.all(
3429
+ Symbol,
3430
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result
3431
+ )
3432
+ end
3433
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3434
+
3435
+ # No address information was provided in the authorization request.
3436
+ NOT_CHECKED =
3437
+ T.let(
3438
+ :not_checked,
3439
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3440
+ )
3441
+
3442
+ # Postal code matches, but the street address does not match or was not provided.
3443
+ POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
3444
+ T.let(
3445
+ :postal_code_match_address_no_match,
3446
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3447
+ )
3448
+
3449
+ # Postal code does not match, but the street address matches or was not provided.
3450
+ POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
3451
+ T.let(
3452
+ :postal_code_no_match_address_match,
3453
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3454
+ )
3455
+
3456
+ # Postal code and street address match.
3457
+ MATCH =
3458
+ T.let(
3459
+ :match,
3460
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3461
+ )
3462
+
3463
+ # Postal code and street address do not match.
3464
+ NO_MATCH =
3465
+ T.let(
3466
+ :no_match,
3467
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3468
+ )
3469
+
3470
+ # Postal code matches, but the street address was not verified. (deprecated)
3471
+ POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
3472
+ T.let(
3473
+ :postal_code_match_address_not_checked,
3474
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3475
+ )
3476
+
3477
+ sig do
3478
+ override.returns(
3479
+ T::Array[
3480
+ Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
3481
+ ]
3482
+ )
3483
+ end
3484
+ def self.values
3485
+ end
3486
+ end
3487
+ end
3488
+ end
3489
+ end
3490
+
3491
+ class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel
3492
+ OrHash =
3493
+ T.type_alias do
3494
+ T.any(
3495
+ Increase::CardPayment::Element::CardAuthorizationExpiration,
3496
+ Increase::Internal::AnyHash
3497
+ )
3498
+ end
3499
+
3500
+ # The Card Authorization Expiration identifier.
3501
+ sig { returns(String) }
3502
+ attr_accessor :id
3503
+
3504
+ # The identifier for the Card Authorization this reverses.
3505
+ sig { returns(String) }
3506
+ attr_accessor :card_authorization_id
3507
+
3508
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3509
+ # currency.
3510
+ sig do
3511
+ returns(
3512
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3513
+ )
3514
+ end
3515
+ attr_accessor :currency
3516
+
3517
+ # The amount of this authorization expiration in the minor unit of the
3518
+ # transaction's currency. For dollars, for example, this is cents.
3519
+ sig { returns(Integer) }
3520
+ attr_accessor :expired_amount
3521
+
3522
+ # The card network used to process this card authorization.
3523
+ sig do
3524
+ returns(
3525
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3526
+ )
3527
+ end
3528
+ attr_accessor :network
3529
+
3530
+ # A constant representing the object's type. For this resource it will always be
3531
+ # `card_authorization_expiration`.
3532
+ sig do
3533
+ returns(
3534
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3535
+ )
3536
+ end
3537
+ attr_accessor :type
3538
+
3539
+ # A Card Authorization Expiration object. This field will be present in the JSON
3540
+ # response if and only if `category` is equal to `card_authorization_expiration`.
3541
+ # Card Authorization Expirations are cancellations of authorizations that were
3542
+ # never settled by the acquirer.
3543
+ sig do
3544
+ params(
3545
+ id: String,
3546
+ card_authorization_id: String,
3547
+ currency:
3548
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::OrSymbol,
3549
+ expired_amount: Integer,
3550
+ network:
3551
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::OrSymbol,
3552
+ type:
3553
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type::OrSymbol
3554
+ ).returns(T.attached_class)
3555
+ end
3556
+ def self.new(
3557
+ # The Card Authorization Expiration identifier.
3558
+ id:,
3559
+ # The identifier for the Card Authorization this reverses.
3560
+ card_authorization_id:,
3561
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3562
+ # currency.
3563
+ currency:,
3564
+ # The amount of this authorization expiration in the minor unit of the
3565
+ # transaction's currency. For dollars, for example, this is cents.
3566
+ expired_amount:,
3567
+ # The card network used to process this card authorization.
3568
+ network:,
3569
+ # A constant representing the object's type. For this resource it will always be
3570
+ # `card_authorization_expiration`.
3571
+ type:
3572
+ )
3573
+ end
3574
+
3575
+ sig do
3576
+ override.returns(
3577
+ {
3578
+ id: String,
3579
+ card_authorization_id: String,
3580
+ currency:
3581
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol,
3582
+ expired_amount: Integer,
3583
+ network:
3584
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol,
3585
+ type:
3586
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3587
+ }
3588
+ )
3589
+ end
3590
+ def to_hash
3591
+ end
3592
+
3593
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3594
+ # currency.
3595
+ module Currency
3596
+ extend Increase::Internal::Type::Enum
3597
+
3598
+ TaggedSymbol =
3599
+ T.type_alias do
3600
+ T.all(
3601
+ Symbol,
3602
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency
3603
+ )
3604
+ end
3605
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3606
+
3607
+ # US Dollar (USD)
3608
+ USD =
3609
+ T.let(
3610
+ :USD,
3611
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3612
+ )
3613
+
3614
+ sig do
3615
+ override.returns(
3616
+ T::Array[
3617
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3618
+ ]
3619
+ )
3620
+ end
3621
+ def self.values
3622
+ end
3623
+ end
3624
+
3625
+ # The card network used to process this card authorization.
3626
+ module Network
3627
+ extend Increase::Internal::Type::Enum
3628
+
3629
+ TaggedSymbol =
3630
+ T.type_alias do
3631
+ T.all(
3632
+ Symbol,
3633
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network
3634
+ )
3635
+ end
3636
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3637
+
3638
+ # Visa
3639
+ VISA =
3640
+ T.let(
3641
+ :visa,
3642
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3643
+ )
3644
+
3645
+ # Pulse
3646
+ PULSE =
3647
+ T.let(
3648
+ :pulse,
3649
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3650
+ )
3651
+
3652
+ sig do
3653
+ override.returns(
3654
+ T::Array[
3655
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3656
+ ]
3657
+ )
3658
+ end
3659
+ def self.values
3660
+ end
3661
+ end
3662
+
3663
+ # A constant representing the object's type. For this resource it will always be
3664
+ # `card_authorization_expiration`.
3665
+ module Type
3666
+ extend Increase::Internal::Type::Enum
3667
+
3668
+ TaggedSymbol =
3669
+ T.type_alias do
3670
+ T.all(
3671
+ Symbol,
3672
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type
3673
+ )
3674
+ end
3675
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3676
+
3677
+ CARD_AUTHORIZATION_EXPIRATION =
3678
+ T.let(
3679
+ :card_authorization_expiration,
3680
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3681
+ )
3682
+
3683
+ sig do
3684
+ override.returns(
3685
+ T::Array[
3686
+ Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3687
+ ]
3688
+ )
3689
+ end
3690
+ def self.values
3691
+ end
3692
+ end
3693
+ end
3694
+
3695
+ class CardBalanceInquiry < Increase::Internal::Type::BaseModel
3696
+ OrHash =
3697
+ T.type_alias do
3698
+ T.any(
3699
+ Increase::CardPayment::Element::CardBalanceInquiry,
3700
+ Increase::Internal::AnyHash
3701
+ )
3702
+ end
3703
+
3704
+ # The Card Balance Inquiry identifier.
3705
+ sig { returns(String) }
3706
+ attr_accessor :id
3707
+
3708
+ # Additional amounts associated with the card authorization, such as ATM
3709
+ # surcharges fees. These are usually a subset of the `amount` field and are used
3710
+ # to provide more detailed information about the transaction.
3711
+ sig do
3712
+ returns(
3713
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts
3714
+ )
3715
+ end
3716
+ attr_reader :additional_amounts
3717
+
3718
+ sig do
3719
+ params(
3720
+ additional_amounts:
3721
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::OrHash
3722
+ ).void
3723
+ end
3724
+ attr_writer :additional_amounts
3725
+
3726
+ # The balance amount in the minor unit of the account's currency. For dollars, for
3727
+ # example, this is cents.
3728
+ sig { returns(Integer) }
3729
+ attr_accessor :balance
3730
+
3731
+ # The ID of the Card Payment this transaction belongs to.
3732
+ sig { returns(String) }
3733
+ attr_accessor :card_payment_id
3734
+
3735
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
3736
+ # currency.
3737
+ sig do
3738
+ returns(
3739
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency::TaggedSymbol
3740
+ )
3741
+ end
3742
+ attr_accessor :currency
3743
+
3744
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
3745
+ # purchase), the identifier of the token that was used.
3746
+ sig { returns(T.nilable(String)) }
3747
+ attr_accessor :digital_wallet_token_id
3748
+
3749
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
3750
+ # is transacting with.
3751
+ sig { returns(String) }
3752
+ attr_accessor :merchant_acceptor_id
3753
+
3754
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
3755
+ # card is transacting with.
3756
+ sig { returns(String) }
3757
+ attr_accessor :merchant_category_code
3758
+
3759
+ # The city the merchant resides in.
3760
+ sig { returns(T.nilable(String)) }
3761
+ attr_accessor :merchant_city
3762
+
3763
+ # The country the merchant resides in.
3764
+ sig { returns(String) }
3765
+ attr_accessor :merchant_country
3766
+
3767
+ # The merchant descriptor of the merchant the card is transacting with.
3768
+ sig { returns(String) }
3769
+ attr_accessor :merchant_descriptor
3770
+
3771
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
3772
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
3773
+ sig { returns(T.nilable(String)) }
3774
+ attr_accessor :merchant_postal_code
3775
+
3776
+ # The state the merchant resides in.
3777
+ sig { returns(T.nilable(String)) }
3778
+ attr_accessor :merchant_state
3779
+
3780
+ # Fields specific to the `network`.
3781
+ sig do
3782
+ returns(
3783
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails
3784
+ )
3785
+ end
3786
+ attr_reader :network_details
3787
+
3788
+ sig do
3789
+ params(
3790
+ network_details:
3791
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::OrHash
3792
+ ).void
3793
+ end
3794
+ attr_writer :network_details
3795
+
3796
+ # Network-specific identifiers for a specific request or transaction.
3797
+ sig do
3798
+ returns(
3799
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers
3800
+ )
3801
+ end
3802
+ attr_reader :network_identifiers
3803
+
3804
+ sig do
3805
+ params(
3806
+ network_identifiers:
3807
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers::OrHash
3808
+ ).void
3809
+ end
3810
+ attr_writer :network_identifiers
3811
+
3812
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
3813
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
3814
+ # score is from 0 to 999, where 999 is the riskiest.
3815
+ sig { returns(T.nilable(Integer)) }
3816
+ attr_accessor :network_risk_score
3817
+
3818
+ # If the authorization was made in-person with a physical card, the Physical Card
3819
+ # that was used.
3820
+ sig { returns(T.nilable(String)) }
3821
+ attr_accessor :physical_card_id
3822
+
3823
+ # The identifier of the Real-Time Decision sent to approve or decline this
3824
+ # transaction.
3825
+ sig { returns(T.nilable(String)) }
3826
+ attr_accessor :real_time_decision_id
3827
+
3828
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
3829
+ # is transacting with.
3830
+ sig { returns(T.nilable(String)) }
3831
+ attr_accessor :terminal_id
3832
+
3833
+ # A constant representing the object's type. For this resource it will always be
3834
+ # `card_balance_inquiry`.
3835
+ sig do
3836
+ returns(
3837
+ Increase::CardPayment::Element::CardBalanceInquiry::Type::TaggedSymbol
3838
+ )
3839
+ end
3840
+ attr_accessor :type
3841
+
3842
+ # Fields related to verification of cardholder-provided values.
3843
+ sig do
3844
+ returns(
3845
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification
3846
+ )
3847
+ end
3848
+ attr_reader :verification
3849
+
3850
+ sig do
3851
+ params(
3852
+ verification:
3853
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::OrHash
3854
+ ).void
3855
+ end
3856
+ attr_writer :verification
3857
+
3858
+ # A Card Balance Inquiry object. This field will be present in the JSON response
3859
+ # if and only if `category` is equal to `card_balance_inquiry`. Card Balance
3860
+ # Inquiries are transactions that allow merchants to check the available balance
3861
+ # on a card without placing a hold on funds, commonly used when a customer
3862
+ # requests their balance at an ATM.
3863
+ sig do
3864
+ params(
3865
+ id: String,
3866
+ additional_amounts:
3867
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::OrHash,
3868
+ balance: Integer,
3869
+ card_payment_id: String,
3870
+ currency:
3871
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency::OrSymbol,
3872
+ digital_wallet_token_id: T.nilable(String),
3873
+ merchant_acceptor_id: String,
3874
+ merchant_category_code: String,
3875
+ merchant_city: T.nilable(String),
3876
+ merchant_country: String,
3877
+ merchant_descriptor: String,
3878
+ merchant_postal_code: T.nilable(String),
3879
+ merchant_state: T.nilable(String),
3880
+ network_details:
3881
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::OrHash,
3882
+ network_identifiers:
3883
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers::OrHash,
3884
+ network_risk_score: T.nilable(Integer),
3885
+ physical_card_id: T.nilable(String),
3886
+ real_time_decision_id: T.nilable(String),
3887
+ terminal_id: T.nilable(String),
3888
+ type:
3889
+ Increase::CardPayment::Element::CardBalanceInquiry::Type::OrSymbol,
3890
+ verification:
3891
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::OrHash
3892
+ ).returns(T.attached_class)
3893
+ end
3894
+ def self.new(
3895
+ # The Card Balance Inquiry identifier.
3896
+ id:,
3897
+ # Additional amounts associated with the card authorization, such as ATM
3898
+ # surcharges fees. These are usually a subset of the `amount` field and are used
3899
+ # to provide more detailed information about the transaction.
3900
+ additional_amounts:,
3901
+ # The balance amount in the minor unit of the account's currency. For dollars, for
3902
+ # example, this is cents.
3903
+ balance:,
3904
+ # The ID of the Card Payment this transaction belongs to.
3905
+ card_payment_id:,
3906
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
3907
+ # currency.
3908
+ currency:,
3909
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
3910
+ # purchase), the identifier of the token that was used.
3911
+ digital_wallet_token_id:,
3912
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
3913
+ # is transacting with.
3914
+ merchant_acceptor_id:,
3915
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
3916
+ # card is transacting with.
3917
+ merchant_category_code:,
3918
+ # The city the merchant resides in.
3919
+ merchant_city:,
3920
+ # The country the merchant resides in.
3921
+ merchant_country:,
3922
+ # The merchant descriptor of the merchant the card is transacting with.
3923
+ merchant_descriptor:,
3924
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
3925
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
3926
+ merchant_postal_code:,
3927
+ # The state the merchant resides in.
3928
+ merchant_state:,
3929
+ # Fields specific to the `network`.
3930
+ network_details:,
3931
+ # Network-specific identifiers for a specific request or transaction.
3932
+ network_identifiers:,
3933
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
3934
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
3935
+ # score is from 0 to 999, where 999 is the riskiest.
3936
+ network_risk_score:,
3937
+ # If the authorization was made in-person with a physical card, the Physical Card
3938
+ # that was used.
3939
+ physical_card_id:,
3940
+ # The identifier of the Real-Time Decision sent to approve or decline this
3941
+ # transaction.
3942
+ real_time_decision_id:,
3943
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
3944
+ # is transacting with.
3945
+ terminal_id:,
3946
+ # A constant representing the object's type. For this resource it will always be
3947
+ # `card_balance_inquiry`.
3948
+ type:,
3949
+ # Fields related to verification of cardholder-provided values.
3950
+ verification:
3951
+ )
3952
+ end
3953
+
3954
+ sig do
3955
+ override.returns(
3956
+ {
3957
+ id: String,
3958
+ additional_amounts:
3959
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts,
3960
+ balance: Integer,
3961
+ card_payment_id: String,
3962
+ currency:
3963
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency::TaggedSymbol,
3964
+ digital_wallet_token_id: T.nilable(String),
3965
+ merchant_acceptor_id: String,
3966
+ merchant_category_code: String,
3967
+ merchant_city: T.nilable(String),
3968
+ merchant_country: String,
3969
+ merchant_descriptor: String,
3970
+ merchant_postal_code: T.nilable(String),
3971
+ merchant_state: T.nilable(String),
3972
+ network_details:
3973
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails,
3974
+ network_identifiers:
3975
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers,
3976
+ network_risk_score: T.nilable(Integer),
3977
+ physical_card_id: T.nilable(String),
3978
+ real_time_decision_id: T.nilable(String),
3979
+ terminal_id: T.nilable(String),
3980
+ type:
3981
+ Increase::CardPayment::Element::CardBalanceInquiry::Type::TaggedSymbol,
3982
+ verification:
3983
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification
3984
+ }
3985
+ )
3986
+ end
3987
+ def to_hash
3988
+ end
3989
+
3990
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
3991
+ OrHash =
3992
+ T.type_alias do
3993
+ T.any(
3994
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts,
3995
+ Increase::Internal::AnyHash
3996
+ )
3997
+ end
3998
+
3999
+ # The part of this transaction amount that was for clinic-related services.
4000
+ sig do
4001
+ returns(
4002
+ T.nilable(
4003
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic
4004
+ )
4005
+ )
4006
+ end
4007
+ attr_reader :clinic
4008
+
4009
+ sig do
4010
+ params(
4011
+ clinic:
4012
+ T.nilable(
4013
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic::OrHash
4014
+ )
4015
+ ).void
4016
+ end
4017
+ attr_writer :clinic
4018
+
4019
+ # The part of this transaction amount that was for dental-related services.
4020
+ sig do
4021
+ returns(
4022
+ T.nilable(
4023
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental
4024
+ )
4025
+ )
4026
+ end
4027
+ attr_reader :dental
4028
+
4029
+ sig do
4030
+ params(
4031
+ dental:
4032
+ T.nilable(
4033
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental::OrHash
4034
+ )
4035
+ ).void
4036
+ end
4037
+ attr_writer :dental
4038
+
4039
+ # The original pre-authorized amount.
4040
+ sig do
4041
+ returns(
4042
+ T.nilable(
4043
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original
4044
+ )
4045
+ )
4046
+ end
4047
+ attr_reader :original
4048
+
4049
+ sig do
4050
+ params(
4051
+ original:
4052
+ T.nilable(
4053
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original::OrHash
4054
+ )
4055
+ ).void
4056
+ end
4057
+ attr_writer :original
4058
+
4059
+ # The part of this transaction amount that was for healthcare prescriptions.
4060
+ sig do
4061
+ returns(
4062
+ T.nilable(
4063
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription
4064
+ )
4065
+ )
4066
+ end
4067
+ attr_reader :prescription
4068
+
4069
+ sig do
4070
+ params(
4071
+ prescription:
4072
+ T.nilable(
4073
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription::OrHash
4074
+ )
4075
+ ).void
4076
+ end
4077
+ attr_writer :prescription
4078
+
4079
+ # The surcharge amount charged for this transaction by the merchant.
4080
+ sig do
4081
+ returns(
4082
+ T.nilable(
4083
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge
4084
+ )
4085
+ )
4086
+ end
4087
+ attr_reader :surcharge
4088
+
4089
+ sig do
4090
+ params(
4091
+ surcharge:
4092
+ T.nilable(
4093
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge::OrHash
4094
+ )
4095
+ ).void
4096
+ end
4097
+ attr_writer :surcharge
4098
+
4099
+ # The total amount of a series of incremental authorizations, optionally provided.
4100
+ sig do
4101
+ returns(
4102
+ T.nilable(
4103
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative
4104
+ )
4105
+ )
4106
+ end
4107
+ attr_reader :total_cumulative
4108
+
4109
+ sig do
4110
+ params(
4111
+ total_cumulative:
4112
+ T.nilable(
4113
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative::OrHash
4114
+ )
4115
+ ).void
4116
+ end
4117
+ attr_writer :total_cumulative
4118
+
4119
+ # The total amount of healthcare-related additional amounts.
4120
+ sig do
4121
+ returns(
4122
+ T.nilable(
4123
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare
4124
+ )
4125
+ )
4126
+ end
4127
+ attr_reader :total_healthcare
4128
+
4129
+ sig do
4130
+ params(
4131
+ total_healthcare:
4132
+ T.nilable(
4133
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare::OrHash
4134
+ )
4135
+ ).void
4136
+ end
4137
+ attr_writer :total_healthcare
4138
+
4139
+ # The part of this transaction amount that was for transit-related services.
4140
+ sig do
4141
+ returns(
4142
+ T.nilable(
4143
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit
4144
+ )
4145
+ )
4146
+ end
4147
+ attr_reader :transit
4148
+
4149
+ sig do
4150
+ params(
4151
+ transit:
4152
+ T.nilable(
4153
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit::OrHash
4154
+ )
4155
+ ).void
4156
+ end
4157
+ attr_writer :transit
4158
+
4159
+ # An unknown additional amount.
4160
+ sig do
4161
+ returns(
4162
+ T.nilable(
4163
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown
4164
+ )
4165
+ )
4166
+ end
4167
+ attr_reader :unknown
4168
+
4169
+ sig do
4170
+ params(
4171
+ unknown:
4172
+ T.nilable(
4173
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown::OrHash
4174
+ )
4175
+ ).void
4176
+ end
4177
+ attr_writer :unknown
4178
+
4179
+ # The part of this transaction amount that was for vision-related services.
4180
+ sig do
4181
+ returns(
4182
+ T.nilable(
4183
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision
4184
+ )
4185
+ )
4186
+ end
4187
+ attr_reader :vision
4188
+
4189
+ sig do
4190
+ params(
4191
+ vision:
4192
+ T.nilable(
4193
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision::OrHash
4194
+ )
4195
+ ).void
4196
+ end
4197
+ attr_writer :vision
4198
+
4199
+ # Additional amounts associated with the card authorization, such as ATM
4200
+ # surcharges fees. These are usually a subset of the `amount` field and are used
4201
+ # to provide more detailed information about the transaction.
4202
+ sig do
4203
+ params(
4204
+ clinic:
4205
+ T.nilable(
4206
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic::OrHash
4207
+ ),
4208
+ dental:
4209
+ T.nilable(
4210
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental::OrHash
4211
+ ),
4212
+ original:
4213
+ T.nilable(
4214
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original::OrHash
4215
+ ),
4216
+ prescription:
4217
+ T.nilable(
4218
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription::OrHash
4219
+ ),
4220
+ surcharge:
4221
+ T.nilable(
4222
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge::OrHash
4223
+ ),
4224
+ total_cumulative:
4225
+ T.nilable(
4226
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative::OrHash
4227
+ ),
4228
+ total_healthcare:
4229
+ T.nilable(
4230
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare::OrHash
4231
+ ),
4232
+ transit:
4233
+ T.nilable(
4234
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit::OrHash
4235
+ ),
4236
+ unknown:
4237
+ T.nilable(
4238
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown::OrHash
4239
+ ),
4240
+ vision:
4241
+ T.nilable(
4242
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision::OrHash
4243
+ )
4244
+ ).returns(T.attached_class)
4245
+ end
4246
+ def self.new(
4247
+ # The part of this transaction amount that was for clinic-related services.
4248
+ clinic:,
4249
+ # The part of this transaction amount that was for dental-related services.
4250
+ dental:,
4251
+ # The original pre-authorized amount.
4252
+ original:,
4253
+ # The part of this transaction amount that was for healthcare prescriptions.
4254
+ prescription:,
4255
+ # The surcharge amount charged for this transaction by the merchant.
4256
+ surcharge:,
4257
+ # The total amount of a series of incremental authorizations, optionally provided.
4258
+ total_cumulative:,
4259
+ # The total amount of healthcare-related additional amounts.
4260
+ total_healthcare:,
4261
+ # The part of this transaction amount that was for transit-related services.
4262
+ transit:,
4263
+ # An unknown additional amount.
4264
+ unknown:,
4265
+ # The part of this transaction amount that was for vision-related services.
4266
+ vision:
4267
+ )
4268
+ end
4269
+
4270
+ sig do
4271
+ override.returns(
4272
+ {
4273
+ clinic:
4274
+ T.nilable(
4275
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic
4276
+ ),
4277
+ dental:
4278
+ T.nilable(
4279
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental
4280
+ ),
4281
+ original:
4282
+ T.nilable(
4283
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original
4284
+ ),
4285
+ prescription:
4286
+ T.nilable(
4287
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription
4288
+ ),
4289
+ surcharge:
4290
+ T.nilable(
4291
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge
4292
+ ),
4293
+ total_cumulative:
4294
+ T.nilable(
4295
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative
4296
+ ),
4297
+ total_healthcare:
4298
+ T.nilable(
4299
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare
4300
+ ),
4301
+ transit:
4302
+ T.nilable(
4303
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit
4304
+ ),
4305
+ unknown:
4306
+ T.nilable(
4307
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown
4308
+ ),
4309
+ vision:
4310
+ T.nilable(
4311
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision
4312
+ )
4313
+ }
4314
+ )
4315
+ end
4316
+ def to_hash
4317
+ end
4318
+
4319
+ class Clinic < Increase::Internal::Type::BaseModel
4320
+ OrHash =
4321
+ T.type_alias do
4322
+ T.any(
4323
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic,
4324
+ Increase::Internal::AnyHash
4325
+ )
4326
+ end
4327
+
4328
+ # The amount in minor units of the `currency` field. The amount is positive if it
4329
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4330
+ # subtracted from the amount (such as a discount).
4331
+ sig { returns(Integer) }
4332
+ attr_accessor :amount
4333
+
4334
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4335
+ # amount's currency.
4336
+ sig { returns(String) }
4337
+ attr_accessor :currency
4338
+
4339
+ # The part of this transaction amount that was for clinic-related services.
4340
+ sig do
4341
+ params(amount: Integer, currency: String).returns(
4342
+ T.attached_class
4343
+ )
4344
+ end
4345
+ def self.new(
4346
+ # The amount in minor units of the `currency` field. The amount is positive if it
4347
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4348
+ # subtracted from the amount (such as a discount).
4349
+ amount:,
4350
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4351
+ # amount's currency.
4352
+ currency:
4353
+ )
4354
+ end
4355
+
4356
+ sig { override.returns({ amount: Integer, currency: String }) }
4357
+ def to_hash
4358
+ end
4359
+ end
4360
+
4361
+ class Dental < Increase::Internal::Type::BaseModel
4362
+ OrHash =
4363
+ T.type_alias do
4364
+ T.any(
4365
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental,
4366
+ Increase::Internal::AnyHash
4367
+ )
4368
+ end
4369
+
4370
+ # The amount in minor units of the `currency` field. The amount is positive if it
4371
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4372
+ # subtracted from the amount (such as a discount).
4373
+ sig { returns(Integer) }
4374
+ attr_accessor :amount
4375
+
4376
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4377
+ # amount's currency.
4378
+ sig { returns(String) }
4379
+ attr_accessor :currency
4380
+
4381
+ # The part of this transaction amount that was for dental-related services.
4382
+ sig do
4383
+ params(amount: Integer, currency: String).returns(
4384
+ T.attached_class
4385
+ )
4386
+ end
4387
+ def self.new(
4388
+ # The amount in minor units of the `currency` field. The amount is positive if it
4389
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4390
+ # subtracted from the amount (such as a discount).
4391
+ amount:,
4392
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4393
+ # amount's currency.
4394
+ currency:
4395
+ )
4396
+ end
4397
+
4398
+ sig { override.returns({ amount: Integer, currency: String }) }
4399
+ def to_hash
4400
+ end
4401
+ end
4402
+
4403
+ class Original < Increase::Internal::Type::BaseModel
4404
+ OrHash =
4405
+ T.type_alias do
4406
+ T.any(
4407
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original,
4408
+ Increase::Internal::AnyHash
4409
+ )
4410
+ end
4411
+
4412
+ # The amount in minor units of the `currency` field. The amount is positive if it
4413
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4414
+ # subtracted from the amount (such as a discount).
4415
+ sig { returns(Integer) }
4416
+ attr_accessor :amount
4417
+
4418
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4419
+ # amount's currency.
4420
+ sig { returns(String) }
4421
+ attr_accessor :currency
4422
+
4423
+ # The original pre-authorized amount.
4424
+ sig do
4425
+ params(amount: Integer, currency: String).returns(
4426
+ T.attached_class
4427
+ )
4428
+ end
4429
+ def self.new(
4430
+ # The amount in minor units of the `currency` field. The amount is positive if it
4431
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4432
+ # subtracted from the amount (such as a discount).
4433
+ amount:,
4434
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4435
+ # amount's currency.
4436
+ currency:
4437
+ )
4438
+ end
4439
+
4440
+ sig { override.returns({ amount: Integer, currency: String }) }
4441
+ def to_hash
4442
+ end
4443
+ end
4444
+
4445
+ class Prescription < Increase::Internal::Type::BaseModel
4446
+ OrHash =
4447
+ T.type_alias do
4448
+ T.any(
4449
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription,
4450
+ Increase::Internal::AnyHash
4451
+ )
4452
+ end
4453
+
4454
+ # The amount in minor units of the `currency` field. The amount is positive if it
4455
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4456
+ # subtracted from the amount (such as a discount).
4457
+ sig { returns(Integer) }
4458
+ attr_accessor :amount
4459
+
4460
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4461
+ # amount's currency.
4462
+ sig { returns(String) }
4463
+ attr_accessor :currency
4464
+
4465
+ # The part of this transaction amount that was for healthcare prescriptions.
4466
+ sig do
4467
+ params(amount: Integer, currency: String).returns(
4468
+ T.attached_class
4469
+ )
4470
+ end
4471
+ def self.new(
4472
+ # The amount in minor units of the `currency` field. The amount is positive if it
4473
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4474
+ # subtracted from the amount (such as a discount).
4475
+ amount:,
4476
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4477
+ # amount's currency.
4478
+ currency:
4479
+ )
4480
+ end
4481
+
4482
+ sig { override.returns({ amount: Integer, currency: String }) }
4483
+ def to_hash
4484
+ end
4485
+ end
4486
+
4487
+ class Surcharge < Increase::Internal::Type::BaseModel
4488
+ OrHash =
4489
+ T.type_alias do
4490
+ T.any(
4491
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge,
4492
+ Increase::Internal::AnyHash
4493
+ )
4494
+ end
4495
+
4496
+ # The amount in minor units of the `currency` field. The amount is positive if it
4497
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4498
+ # subtracted from the amount (such as a discount).
4499
+ sig { returns(Integer) }
4500
+ attr_accessor :amount
4501
+
4502
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4503
+ # amount's currency.
4504
+ sig { returns(String) }
4505
+ attr_accessor :currency
4506
+
4507
+ # The surcharge amount charged for this transaction by the merchant.
4508
+ sig do
4509
+ params(amount: Integer, currency: String).returns(
4510
+ T.attached_class
4511
+ )
4512
+ end
4513
+ def self.new(
4514
+ # The amount in minor units of the `currency` field. The amount is positive if it
4515
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4516
+ # subtracted from the amount (such as a discount).
4517
+ amount:,
4518
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4519
+ # amount's currency.
4520
+ currency:
4521
+ )
4522
+ end
4523
+
4524
+ sig { override.returns({ amount: Integer, currency: String }) }
4525
+ def to_hash
4526
+ end
4527
+ end
4528
+
4529
+ class TotalCumulative < Increase::Internal::Type::BaseModel
4530
+ OrHash =
4531
+ T.type_alias do
4532
+ T.any(
4533
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative,
4534
+ Increase::Internal::AnyHash
4535
+ )
4536
+ end
4537
+
4538
+ # The amount in minor units of the `currency` field. The amount is positive if it
4539
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4540
+ # subtracted from the amount (such as a discount).
4541
+ sig { returns(Integer) }
4542
+ attr_accessor :amount
4543
+
4544
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4545
+ # amount's currency.
4546
+ sig { returns(String) }
4547
+ attr_accessor :currency
4548
+
4549
+ # The total amount of a series of incremental authorizations, optionally provided.
4550
+ sig do
4551
+ params(amount: Integer, currency: String).returns(
4552
+ T.attached_class
4553
+ )
4554
+ end
4555
+ def self.new(
4556
+ # The amount in minor units of the `currency` field. The amount is positive if it
4557
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4558
+ # subtracted from the amount (such as a discount).
4559
+ amount:,
4560
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4561
+ # amount's currency.
4562
+ currency:
4563
+ )
4564
+ end
4565
+
4566
+ sig { override.returns({ amount: Integer, currency: String }) }
4567
+ def to_hash
4568
+ end
4569
+ end
4570
+
4571
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
4572
+ OrHash =
4573
+ T.type_alias do
4574
+ T.any(
4575
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare,
4576
+ Increase::Internal::AnyHash
4577
+ )
4578
+ end
4579
+
4580
+ # The amount in minor units of the `currency` field. The amount is positive if it
4581
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4582
+ # subtracted from the amount (such as a discount).
4583
+ sig { returns(Integer) }
4584
+ attr_accessor :amount
4585
+
4586
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4587
+ # amount's currency.
4588
+ sig { returns(String) }
4589
+ attr_accessor :currency
4590
+
4591
+ # The total amount of healthcare-related additional amounts.
4592
+ sig do
4593
+ params(amount: Integer, currency: String).returns(
4594
+ T.attached_class
4595
+ )
4596
+ end
4597
+ def self.new(
4598
+ # The amount in minor units of the `currency` field. The amount is positive if it
4599
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4600
+ # subtracted from the amount (such as a discount).
4601
+ amount:,
4602
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4603
+ # amount's currency.
4604
+ currency:
4605
+ )
4606
+ end
4607
+
4608
+ sig { override.returns({ amount: Integer, currency: String }) }
4609
+ def to_hash
4610
+ end
4611
+ end
4612
+
4613
+ class Transit < Increase::Internal::Type::BaseModel
4614
+ OrHash =
4615
+ T.type_alias do
4616
+ T.any(
4617
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit,
4618
+ Increase::Internal::AnyHash
4619
+ )
4620
+ end
4621
+
4622
+ # The amount in minor units of the `currency` field. The amount is positive if it
4623
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4624
+ # subtracted from the amount (such as a discount).
4625
+ sig { returns(Integer) }
4626
+ attr_accessor :amount
4627
+
4628
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4629
+ # amount's currency.
4630
+ sig { returns(String) }
4631
+ attr_accessor :currency
4632
+
4633
+ # The part of this transaction amount that was for transit-related services.
4634
+ sig do
4635
+ params(amount: Integer, currency: String).returns(
4636
+ T.attached_class
4637
+ )
4638
+ end
4639
+ def self.new(
4640
+ # The amount in minor units of the `currency` field. The amount is positive if it
4641
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4642
+ # subtracted from the amount (such as a discount).
4643
+ amount:,
4644
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4645
+ # amount's currency.
4646
+ currency:
4647
+ )
4648
+ end
4649
+
4650
+ sig { override.returns({ amount: Integer, currency: String }) }
4651
+ def to_hash
4652
+ end
4653
+ end
4654
+
4655
+ class Unknown < Increase::Internal::Type::BaseModel
4656
+ OrHash =
4657
+ T.type_alias do
4658
+ T.any(
4659
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown,
4660
+ Increase::Internal::AnyHash
4661
+ )
4662
+ end
4663
+
4664
+ # The amount in minor units of the `currency` field. The amount is positive if it
4665
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4666
+ # subtracted from the amount (such as a discount).
4667
+ sig { returns(Integer) }
4668
+ attr_accessor :amount
4669
+
4670
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4671
+ # amount's currency.
4672
+ sig { returns(String) }
4673
+ attr_accessor :currency
4674
+
4675
+ # An unknown additional amount.
4676
+ sig do
4677
+ params(amount: Integer, currency: String).returns(
4678
+ T.attached_class
4679
+ )
4680
+ end
4681
+ def self.new(
4682
+ # The amount in minor units of the `currency` field. The amount is positive if it
4683
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4684
+ # subtracted from the amount (such as a discount).
4685
+ amount:,
4686
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4687
+ # amount's currency.
4688
+ currency:
4689
+ )
4690
+ end
4691
+
4692
+ sig { override.returns({ amount: Integer, currency: String }) }
4693
+ def to_hash
4694
+ end
4695
+ end
4696
+
4697
+ class Vision < Increase::Internal::Type::BaseModel
4698
+ OrHash =
4699
+ T.type_alias do
4700
+ T.any(
4701
+ Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision,
4702
+ Increase::Internal::AnyHash
4703
+ )
4704
+ end
4705
+
4706
+ # The amount in minor units of the `currency` field. The amount is positive if it
4707
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4708
+ # subtracted from the amount (such as a discount).
4709
+ sig { returns(Integer) }
4710
+ attr_accessor :amount
4711
+
4712
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4713
+ # amount's currency.
4714
+ sig { returns(String) }
4715
+ attr_accessor :currency
4716
+
4717
+ # The part of this transaction amount that was for vision-related services.
4718
+ sig do
4719
+ params(amount: Integer, currency: String).returns(
4720
+ T.attached_class
4721
+ )
4722
+ end
4723
+ def self.new(
4724
+ # The amount in minor units of the `currency` field. The amount is positive if it
4725
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
4726
+ # subtracted from the amount (such as a discount).
4727
+ amount:,
4728
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
4729
+ # amount's currency.
4730
+ currency:
4731
+ )
4732
+ end
4733
+
4734
+ sig { override.returns({ amount: Integer, currency: String }) }
4735
+ def to_hash
4736
+ end
4737
+ end
4738
+ end
4739
+
4740
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
4741
+ # currency.
4742
+ module Currency
4743
+ extend Increase::Internal::Type::Enum
4744
+
4745
+ TaggedSymbol =
4746
+ T.type_alias do
4747
+ T.all(
4748
+ Symbol,
4749
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency
4750
+ )
4751
+ end
4752
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4753
+
4754
+ # US Dollar (USD)
4755
+ USD =
4756
+ T.let(
4757
+ :USD,
4758
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency::TaggedSymbol
4759
+ )
4760
+
4761
+ sig do
4762
+ override.returns(
4763
+ T::Array[
4764
+ Increase::CardPayment::Element::CardBalanceInquiry::Currency::TaggedSymbol
4765
+ ]
4766
+ )
4767
+ end
4768
+ def self.values
4769
+ end
4770
+ end
4771
+
4772
+ class NetworkDetails < Increase::Internal::Type::BaseModel
4773
+ OrHash =
4774
+ T.type_alias do
4775
+ T.any(
4776
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails,
4777
+ Increase::Internal::AnyHash
4778
+ )
4779
+ end
4780
+
4781
+ # The payment network used to process this card authorization.
4782
+ sig do
4783
+ returns(
4784
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::TaggedSymbol
4785
+ )
4786
+ end
4787
+ attr_accessor :category
4788
+
4789
+ # Fields specific to the `pulse` network.
4790
+ sig do
4791
+ returns(
4792
+ T.nilable(
4793
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse
4794
+ )
4795
+ )
4796
+ end
4797
+ attr_reader :pulse
4798
+
4799
+ sig do
4800
+ params(
4801
+ pulse:
4802
+ T.nilable(
4803
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse::OrHash
4804
+ )
4805
+ ).void
4806
+ end
4807
+ attr_writer :pulse
4808
+
4809
+ # Fields specific to the `visa` network.
4810
+ sig do
4811
+ returns(
4812
+ T.nilable(
4813
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa
4814
+ )
4815
+ )
4816
+ end
4817
+ attr_reader :visa
4818
+
4819
+ sig do
4820
+ params(
4821
+ visa:
4822
+ T.nilable(
4823
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::OrHash
4824
+ )
4825
+ ).void
4826
+ end
4827
+ attr_writer :visa
4828
+
4829
+ # Fields specific to the `network`.
4830
+ sig do
4831
+ params(
4832
+ category:
4833
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::OrSymbol,
4834
+ pulse:
4835
+ T.nilable(
4836
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse::OrHash
4837
+ ),
4838
+ visa:
4839
+ T.nilable(
4840
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::OrHash
4841
+ )
4842
+ ).returns(T.attached_class)
4843
+ end
4844
+ def self.new(
4845
+ # The payment network used to process this card authorization.
4846
+ category:,
4847
+ # Fields specific to the `pulse` network.
4848
+ pulse:,
4849
+ # Fields specific to the `visa` network.
4850
+ visa:
4851
+ )
4852
+ end
4853
+
4854
+ sig do
4855
+ override.returns(
4856
+ {
4857
+ category:
4858
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::TaggedSymbol,
4859
+ pulse:
4860
+ T.nilable(
4861
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse
4862
+ ),
4863
+ visa:
4864
+ T.nilable(
4865
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa
4866
+ )
4867
+ }
4868
+ )
4869
+ end
4870
+ def to_hash
4871
+ end
4872
+
4873
+ # The payment network used to process this card authorization.
4874
+ module Category
4875
+ extend Increase::Internal::Type::Enum
4876
+
4877
+ TaggedSymbol =
4878
+ T.type_alias do
4879
+ T.all(
4880
+ Symbol,
4881
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category
4882
+ )
4883
+ end
4884
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4885
+
4886
+ # Visa
4887
+ VISA =
4888
+ T.let(
4889
+ :visa,
4890
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::TaggedSymbol
4891
+ )
4892
+
4893
+ # Pulse
4894
+ PULSE =
4895
+ T.let(
4896
+ :pulse,
4897
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::TaggedSymbol
4898
+ )
4899
+
4900
+ sig do
4901
+ override.returns(
4902
+ T::Array[
4903
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category::TaggedSymbol
4904
+ ]
4905
+ )
4906
+ end
4907
+ def self.values
4908
+ end
4909
+ end
4910
+
4911
+ class Pulse < Increase::Internal::Type::BaseModel
4912
+ OrHash =
4913
+ T.type_alias do
4914
+ T.any(
4915
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse,
4916
+ Increase::Internal::AnyHash
4917
+ )
4918
+ end
4919
+
4920
+ # Fields specific to the `pulse` network.
4921
+ sig { returns(T.attached_class) }
4922
+ def self.new
4923
+ end
4924
+
4925
+ sig { override.returns({}) }
4926
+ def to_hash
4927
+ end
4928
+ end
4929
+
4930
+ class Visa < Increase::Internal::Type::BaseModel
4931
+ OrHash =
4932
+ T.type_alias do
4933
+ T.any(
4934
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa,
4935
+ Increase::Internal::AnyHash
4936
+ )
4937
+ end
4938
+
4939
+ # For electronic commerce transactions, this identifies the level of security used
4940
+ # in obtaining the customer's payment credential. For mail or telephone order
4941
+ # transactions, identifies the type of mail or telephone order.
4942
+ sig do
4943
+ returns(
4944
+ T.nilable(
4945
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
4946
+ )
4947
+ )
4948
+ end
4949
+ attr_accessor :electronic_commerce_indicator
4950
+
4951
+ # The method used to enter the cardholder's primary account number and card
4952
+ # expiration date.
4953
+ sig do
4954
+ returns(
4955
+ T.nilable(
4956
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
4957
+ )
4958
+ )
4959
+ end
4960
+ attr_accessor :point_of_service_entry_mode
4961
+
4962
+ # Only present when `actioner: network`. Describes why a card authorization was
4963
+ # approved or declined by Visa through stand-in processing.
4964
+ sig do
4965
+ returns(
4966
+ T.nilable(
4967
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
4968
+ )
4969
+ )
4970
+ end
4971
+ attr_accessor :stand_in_processing_reason
4972
+
4973
+ # Fields specific to the `visa` network.
4974
+ sig do
4975
+ params(
4976
+ electronic_commerce_indicator:
4977
+ T.nilable(
4978
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::OrSymbol
4979
+ ),
4980
+ point_of_service_entry_mode:
4981
+ T.nilable(
4982
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::OrSymbol
4983
+ ),
4984
+ stand_in_processing_reason:
4985
+ T.nilable(
4986
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::OrSymbol
4987
+ )
4988
+ ).returns(T.attached_class)
4989
+ end
4990
+ def self.new(
4991
+ # For electronic commerce transactions, this identifies the level of security used
4992
+ # in obtaining the customer's payment credential. For mail or telephone order
4993
+ # transactions, identifies the type of mail or telephone order.
4994
+ electronic_commerce_indicator:,
4995
+ # The method used to enter the cardholder's primary account number and card
4996
+ # expiration date.
4997
+ point_of_service_entry_mode:,
4998
+ # Only present when `actioner: network`. Describes why a card authorization was
4999
+ # approved or declined by Visa through stand-in processing.
5000
+ stand_in_processing_reason:
5001
+ )
5002
+ end
5003
+
5004
+ sig do
5005
+ override.returns(
5006
+ {
5007
+ electronic_commerce_indicator:
5008
+ T.nilable(
5009
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5010
+ ),
5011
+ point_of_service_entry_mode:
5012
+ T.nilable(
5013
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5014
+ ),
5015
+ stand_in_processing_reason:
5016
+ T.nilable(
5017
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5018
+ )
5019
+ }
5020
+ )
5021
+ end
5022
+ def to_hash
5023
+ end
5024
+
5025
+ # For electronic commerce transactions, this identifies the level of security used
5026
+ # in obtaining the customer's payment credential. For mail or telephone order
5027
+ # transactions, identifies the type of mail or telephone order.
5028
+ module ElectronicCommerceIndicator
5029
+ extend Increase::Internal::Type::Enum
5030
+
5031
+ TaggedSymbol =
5032
+ T.type_alias do
5033
+ T.all(
5034
+ Symbol,
5035
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator
5036
+ )
5037
+ end
5038
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5039
+
5040
+ # 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.
5041
+ MAIL_PHONE_ORDER =
5042
+ T.let(
5043
+ :mail_phone_order,
5044
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5045
+ )
5046
+
5047
+ # Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.
5048
+ RECURRING =
5049
+ T.let(
5050
+ :recurring,
5051
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5052
+ )
5053
+
5054
+ # 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.
5055
+ INSTALLMENT =
5056
+ T.let(
5057
+ :installment,
5058
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5059
+ )
5060
+
5061
+ # Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.
5062
+ UNKNOWN_MAIL_PHONE_ORDER =
5063
+ T.let(
5064
+ :unknown_mail_phone_order,
5065
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5066
+ )
5067
+
5068
+ # Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure
5069
+ SECURE_ELECTRONIC_COMMERCE =
5070
+ T.let(
5071
+ :secure_electronic_commerce,
5072
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5073
+ )
5074
+
5075
+ # 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.
5076
+ NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
5077
+ T.let(
5078
+ :non_authenticated_security_transaction_at_3ds_capable_merchant,
5079
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5080
+ )
5081
+
5082
+ # 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.
5083
+ NON_AUTHENTICATED_SECURITY_TRANSACTION =
5084
+ T.let(
5085
+ :non_authenticated_security_transaction,
5086
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5087
+ )
5088
+
5089
+ # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.
5090
+ NON_SECURE_TRANSACTION =
5091
+ T.let(
5092
+ :non_secure_transaction,
5093
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5094
+ )
5095
+
5096
+ sig do
5097
+ override.returns(
5098
+ T::Array[
5099
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol
5100
+ ]
5101
+ )
5102
+ end
5103
+ def self.values
5104
+ end
5105
+ end
5106
+
5107
+ # The method used to enter the cardholder's primary account number and card
5108
+ # expiration date.
5109
+ module PointOfServiceEntryMode
5110
+ extend Increase::Internal::Type::Enum
5111
+
5112
+ TaggedSymbol =
5113
+ T.type_alias do
5114
+ T.all(
5115
+ Symbol,
5116
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode
5117
+ )
5118
+ end
5119
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5120
+
5121
+ # Unknown
5122
+ UNKNOWN =
5123
+ T.let(
5124
+ :unknown,
5125
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5126
+ )
5127
+
5128
+ # Manual key entry
5129
+ MANUAL =
5130
+ T.let(
5131
+ :manual,
5132
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5133
+ )
5134
+
5135
+ # Magnetic stripe read, without card verification value
5136
+ MAGNETIC_STRIPE_NO_CVV =
5137
+ T.let(
5138
+ :magnetic_stripe_no_cvv,
5139
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5140
+ )
5141
+
5142
+ # Optical code
5143
+ OPTICAL_CODE =
5144
+ T.let(
5145
+ :optical_code,
5146
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5147
+ )
5148
+
5149
+ # Contact chip card
5150
+ INTEGRATED_CIRCUIT_CARD =
5151
+ T.let(
5152
+ :integrated_circuit_card,
5153
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5154
+ )
5155
+
5156
+ # Contactless read of chip card
5157
+ CONTACTLESS =
5158
+ T.let(
5159
+ :contactless,
5160
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5161
+ )
5162
+
5163
+ # Transaction initiated using a credential that has previously been stored on file
5164
+ CREDENTIAL_ON_FILE =
5165
+ T.let(
5166
+ :credential_on_file,
5167
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5168
+ )
5169
+
5170
+ # Magnetic stripe read
5171
+ MAGNETIC_STRIPE =
5172
+ T.let(
5173
+ :magnetic_stripe,
5174
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5175
+ )
5176
+
5177
+ # Contactless read of magnetic stripe data
5178
+ CONTACTLESS_MAGNETIC_STRIPE =
5179
+ T.let(
5180
+ :contactless_magnetic_stripe,
5181
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5182
+ )
5183
+
5184
+ # Contact chip card, without card verification value
5185
+ INTEGRATED_CIRCUIT_CARD_NO_CVV =
5186
+ T.let(
5187
+ :integrated_circuit_card_no_cvv,
5188
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5189
+ )
5190
+
5191
+ sig do
5192
+ override.returns(
5193
+ T::Array[
5194
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol
5195
+ ]
5196
+ )
5197
+ end
5198
+ def self.values
5199
+ end
5200
+ end
5201
+
5202
+ # Only present when `actioner: network`. Describes why a card authorization was
5203
+ # approved or declined by Visa through stand-in processing.
5204
+ module StandInProcessingReason
5205
+ extend Increase::Internal::Type::Enum
5206
+
5207
+ TaggedSymbol =
5208
+ T.type_alias do
5209
+ T.all(
5210
+ Symbol,
5211
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason
5212
+ )
5213
+ end
5214
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5215
+
5216
+ # Increase failed to process the authorization in a timely manner.
5217
+ ISSUER_ERROR =
5218
+ T.let(
5219
+ :issuer_error,
5220
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5221
+ )
5222
+
5223
+ # The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
5224
+ INVALID_PHYSICAL_CARD =
5225
+ T.let(
5226
+ :invalid_physical_card,
5227
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5228
+ )
5229
+
5230
+ # The 3DS cardholder authentication verification value was invalid.
5231
+ INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
5232
+ T.let(
5233
+ :invalid_cardholder_authentication_verification_value,
5234
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5235
+ )
5236
+
5237
+ # An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
5238
+ INTERNAL_VISA_ERROR =
5239
+ T.let(
5240
+ :internal_visa_error,
5241
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5242
+ )
5243
+
5244
+ # 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.
5245
+ MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
5246
+ T.let(
5247
+ :merchant_transaction_advisory_service_authentication_required,
5248
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5249
+ )
5250
+
5251
+ # The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
5252
+ PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK =
5253
+ T.let(
5254
+ :payment_fraud_disruption_acquirer_block,
5255
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5256
+ )
5257
+
5258
+ # An unspecific reason for stand-in processing.
5259
+ OTHER =
5260
+ T.let(
5261
+ :other,
5262
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5263
+ )
5264
+
5265
+ sig do
5266
+ override.returns(
5267
+ T::Array[
5268
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol
5269
+ ]
5270
+ )
5271
+ end
5272
+ def self.values
5273
+ end
5274
+ end
5275
+ end
5276
+ end
5277
+
5278
+ class NetworkIdentifiers < Increase::Internal::Type::BaseModel
5279
+ OrHash =
5280
+ T.type_alias do
5281
+ T.any(
5282
+ Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers,
5283
+ Increase::Internal::AnyHash
5284
+ )
5285
+ end
5286
+
5287
+ # The randomly generated 6-character Authorization Identification Response code
5288
+ # sent back to the acquirer in an approved response.
5289
+ sig { returns(T.nilable(String)) }
5290
+ attr_accessor :authorization_identification_response
5291
+
5292
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
5293
+ # Expected to be unique per acquirer within a window of time. For some card
5294
+ # networks the retrieval reference number includes the trace counter.
5295
+ sig { returns(T.nilable(String)) }
5296
+ attr_accessor :retrieval_reference_number
5297
+
5298
+ # A counter used to verify an individual authorization. Expected to be unique per
5299
+ # acquirer within a window of time.
5300
+ sig { returns(T.nilable(String)) }
5301
+ attr_accessor :trace_number
5302
+
5303
+ # A globally unique transaction identifier provided by the card network, used
5304
+ # across multiple life-cycle requests.
5305
+ sig { returns(T.nilable(String)) }
5306
+ attr_accessor :transaction_id
5307
+
5308
+ # Network-specific identifiers for a specific request or transaction.
5309
+ sig do
5310
+ params(
5311
+ authorization_identification_response: T.nilable(String),
5312
+ retrieval_reference_number: T.nilable(String),
5313
+ trace_number: T.nilable(String),
5314
+ transaction_id: T.nilable(String)
5315
+ ).returns(T.attached_class)
5316
+ end
5317
+ def self.new(
5318
+ # The randomly generated 6-character Authorization Identification Response code
5319
+ # sent back to the acquirer in an approved response.
5320
+ authorization_identification_response:,
5321
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
5322
+ # Expected to be unique per acquirer within a window of time. For some card
5323
+ # networks the retrieval reference number includes the trace counter.
5324
+ retrieval_reference_number:,
5325
+ # A counter used to verify an individual authorization. Expected to be unique per
5326
+ # acquirer within a window of time.
5327
+ trace_number:,
5328
+ # A globally unique transaction identifier provided by the card network, used
5329
+ # across multiple life-cycle requests.
5330
+ transaction_id:
5331
+ )
5332
+ end
5333
+
5334
+ sig do
5335
+ override.returns(
5336
+ {
5337
+ authorization_identification_response: T.nilable(String),
5338
+ retrieval_reference_number: T.nilable(String),
5339
+ trace_number: T.nilable(String),
5340
+ transaction_id: T.nilable(String)
5341
+ }
3114
5342
  )
3115
5343
  end
3116
- def self.values
5344
+ def to_hash
3117
5345
  end
3118
5346
  end
3119
5347
 
3120
5348
  # A constant representing the object's type. For this resource it will always be
3121
- # `card_authorization`.
5349
+ # `card_balance_inquiry`.
3122
5350
  module Type
3123
5351
  extend Increase::Internal::Type::Enum
3124
5352
 
@@ -3126,21 +5354,21 @@ module Increase
3126
5354
  T.type_alias do
3127
5355
  T.all(
3128
5356
  Symbol,
3129
- Increase::CardPayment::Element::CardAuthorization::Type
5357
+ Increase::CardPayment::Element::CardBalanceInquiry::Type
3130
5358
  )
3131
5359
  end
3132
5360
  OrSymbol = T.type_alias { T.any(Symbol, String) }
3133
5361
 
3134
- CARD_AUTHORIZATION =
5362
+ CARD_BALANCE_INQUIRY =
3135
5363
  T.let(
3136
- :card_authorization,
3137
- Increase::CardPayment::Element::CardAuthorization::Type::TaggedSymbol
5364
+ :card_balance_inquiry,
5365
+ Increase::CardPayment::Element::CardBalanceInquiry::Type::TaggedSymbol
3138
5366
  )
3139
5367
 
3140
5368
  sig do
3141
5369
  override.returns(
3142
5370
  T::Array[
3143
- Increase::CardPayment::Element::CardAuthorization::Type::TaggedSymbol
5371
+ Increase::CardPayment::Element::CardBalanceInquiry::Type::TaggedSymbol
3144
5372
  ]
3145
5373
  )
3146
5374
  end
@@ -3152,7 +5380,7 @@ module Increase
3152
5380
  OrHash =
3153
5381
  T.type_alias do
3154
5382
  T.any(
3155
- Increase::CardPayment::Element::CardAuthorization::Verification,
5383
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification,
3156
5384
  Increase::Internal::AnyHash
3157
5385
  )
3158
5386
  end
@@ -3161,7 +5389,7 @@ module Increase
3161
5389
  # the back of the card.
3162
5390
  sig do
3163
5391
  returns(
3164
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode
5392
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode
3165
5393
  )
3166
5394
  end
3167
5395
  attr_reader :card_verification_code
@@ -3169,7 +5397,7 @@ module Increase
3169
5397
  sig do
3170
5398
  params(
3171
5399
  card_verification_code:
3172
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::OrHash
5400
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::OrHash
3173
5401
  ).void
3174
5402
  end
3175
5403
  attr_writer :card_verification_code
@@ -3178,7 +5406,7 @@ module Increase
3178
5406
  # we verified it against.
3179
5407
  sig do
3180
5408
  returns(
3181
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress
5409
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress
3182
5410
  )
3183
5411
  end
3184
5412
  attr_reader :cardholder_address
@@ -3186,7 +5414,7 @@ module Increase
3186
5414
  sig do
3187
5415
  params(
3188
5416
  cardholder_address:
3189
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::OrHash
5417
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::OrHash
3190
5418
  ).void
3191
5419
  end
3192
5420
  attr_writer :cardholder_address
@@ -3195,9 +5423,9 @@ module Increase
3195
5423
  sig do
3196
5424
  params(
3197
5425
  card_verification_code:
3198
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::OrHash,
5426
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::OrHash,
3199
5427
  cardholder_address:
3200
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::OrHash
5428
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::OrHash
3201
5429
  ).returns(T.attached_class)
3202
5430
  end
3203
5431
  def self.new(
@@ -3214,9 +5442,9 @@ module Increase
3214
5442
  override.returns(
3215
5443
  {
3216
5444
  card_verification_code:
3217
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode,
5445
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode,
3218
5446
  cardholder_address:
3219
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress
5447
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress
3220
5448
  }
3221
5449
  )
3222
5450
  end
@@ -3227,7 +5455,7 @@ module Increase
3227
5455
  OrHash =
3228
5456
  T.type_alias do
3229
5457
  T.any(
3230
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode,
5458
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode,
3231
5459
  Increase::Internal::AnyHash
3232
5460
  )
3233
5461
  end
@@ -3235,7 +5463,7 @@ module Increase
3235
5463
  # The result of verifying the Card Verification Code.
3236
5464
  sig do
3237
5465
  returns(
3238
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5466
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3239
5467
  )
3240
5468
  end
3241
5469
  attr_accessor :result
@@ -3245,7 +5473,7 @@ module Increase
3245
5473
  sig do
3246
5474
  params(
3247
5475
  result:
3248
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::OrSymbol
5476
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::OrSymbol
3249
5477
  ).returns(T.attached_class)
3250
5478
  end
3251
5479
  def self.new(
@@ -3258,7 +5486,7 @@ module Increase
3258
5486
  override.returns(
3259
5487
  {
3260
5488
  result:
3261
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5489
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3262
5490
  }
3263
5491
  )
3264
5492
  end
@@ -3273,7 +5501,7 @@ module Increase
3273
5501
  T.type_alias do
3274
5502
  T.all(
3275
5503
  Symbol,
3276
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result
5504
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result
3277
5505
  )
3278
5506
  end
3279
5507
  OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -3282,27 +5510,27 @@ module Increase
3282
5510
  NOT_CHECKED =
3283
5511
  T.let(
3284
5512
  :not_checked,
3285
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5513
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3286
5514
  )
3287
5515
 
3288
5516
  # The card verification code matched the one on file.
3289
5517
  MATCH =
3290
5518
  T.let(
3291
5519
  :match,
3292
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5520
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3293
5521
  )
3294
5522
 
3295
5523
  # The card verification code did not match the one on file.
3296
5524
  NO_MATCH =
3297
5525
  T.let(
3298
5526
  :no_match,
3299
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5527
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3300
5528
  )
3301
5529
 
3302
5530
  sig do
3303
5531
  override.returns(
3304
5532
  T::Array[
3305
- Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol
5533
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result::TaggedSymbol
3306
5534
  ]
3307
5535
  )
3308
5536
  end
@@ -3315,7 +5543,7 @@ module Increase
3315
5543
  OrHash =
3316
5544
  T.type_alias do
3317
5545
  T.any(
3318
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress,
5546
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress,
3319
5547
  Increase::Internal::AnyHash
3320
5548
  )
3321
5549
  end
@@ -3340,7 +5568,7 @@ module Increase
3340
5568
  # The address verification result returned to the card network.
3341
5569
  sig do
3342
5570
  returns(
3343
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5571
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3344
5572
  )
3345
5573
  end
3346
5574
  attr_accessor :result
@@ -3354,7 +5582,7 @@ module Increase
3354
5582
  provided_line1: T.nilable(String),
3355
5583
  provided_postal_code: T.nilable(String),
3356
5584
  result:
3357
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::OrSymbol
5585
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::OrSymbol
3358
5586
  ).returns(T.attached_class)
3359
5587
  end
3360
5588
  def self.new(
@@ -3380,7 +5608,7 @@ module Increase
3380
5608
  provided_line1: T.nilable(String),
3381
5609
  provided_postal_code: T.nilable(String),
3382
5610
  result:
3383
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5611
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3384
5612
  }
3385
5613
  )
3386
5614
  end
@@ -3395,7 +5623,7 @@ module Increase
3395
5623
  T.type_alias do
3396
5624
  T.all(
3397
5625
  Symbol,
3398
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result
5626
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result
3399
5627
  )
3400
5628
  end
3401
5629
  OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -3404,48 +5632,48 @@ module Increase
3404
5632
  NOT_CHECKED =
3405
5633
  T.let(
3406
5634
  :not_checked,
3407
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5635
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3408
5636
  )
3409
5637
 
3410
5638
  # Postal code matches, but the street address does not match or was not provided.
3411
5639
  POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
3412
5640
  T.let(
3413
5641
  :postal_code_match_address_no_match,
3414
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5642
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3415
5643
  )
3416
5644
 
3417
5645
  # Postal code does not match, but the street address matches or was not provided.
3418
5646
  POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
3419
5647
  T.let(
3420
5648
  :postal_code_no_match_address_match,
3421
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5649
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3422
5650
  )
3423
5651
 
3424
5652
  # Postal code and street address match.
3425
5653
  MATCH =
3426
5654
  T.let(
3427
5655
  :match,
3428
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5656
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3429
5657
  )
3430
5658
 
3431
5659
  # Postal code and street address do not match.
3432
5660
  NO_MATCH =
3433
5661
  T.let(
3434
5662
  :no_match,
3435
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5663
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3436
5664
  )
3437
5665
 
3438
5666
  # Postal code matches, but the street address was not verified. (deprecated)
3439
5667
  POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
3440
5668
  T.let(
3441
5669
  :postal_code_match_address_not_checked,
3442
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5670
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3443
5671
  )
3444
5672
 
3445
5673
  sig do
3446
5674
  override.returns(
3447
5675
  T::Array[
3448
- Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
5676
+ Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result::TaggedSymbol
3449
5677
  ]
3450
5678
  )
3451
5679
  end
@@ -3456,210 +5684,6 @@ module Increase
3456
5684
  end
3457
5685
  end
3458
5686
 
3459
- class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel
3460
- OrHash =
3461
- T.type_alias do
3462
- T.any(
3463
- Increase::CardPayment::Element::CardAuthorizationExpiration,
3464
- Increase::Internal::AnyHash
3465
- )
3466
- end
3467
-
3468
- # The Card Authorization Expiration identifier.
3469
- sig { returns(String) }
3470
- attr_accessor :id
3471
-
3472
- # The identifier for the Card Authorization this reverses.
3473
- sig { returns(String) }
3474
- attr_accessor :card_authorization_id
3475
-
3476
- # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3477
- # currency.
3478
- sig do
3479
- returns(
3480
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3481
- )
3482
- end
3483
- attr_accessor :currency
3484
-
3485
- # The amount of this authorization expiration in the minor unit of the
3486
- # transaction's currency. For dollars, for example, this is cents.
3487
- sig { returns(Integer) }
3488
- attr_accessor :expired_amount
3489
-
3490
- # The card network used to process this card authorization.
3491
- sig do
3492
- returns(
3493
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3494
- )
3495
- end
3496
- attr_accessor :network
3497
-
3498
- # A constant representing the object's type. For this resource it will always be
3499
- # `card_authorization_expiration`.
3500
- sig do
3501
- returns(
3502
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3503
- )
3504
- end
3505
- attr_accessor :type
3506
-
3507
- # A Card Authorization Expiration object. This field will be present in the JSON
3508
- # response if and only if `category` is equal to `card_authorization_expiration`.
3509
- # Card Authorization Expirations are cancellations of authorizations that were
3510
- # never settled by the acquirer.
3511
- sig do
3512
- params(
3513
- id: String,
3514
- card_authorization_id: String,
3515
- currency:
3516
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::OrSymbol,
3517
- expired_amount: Integer,
3518
- network:
3519
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::OrSymbol,
3520
- type:
3521
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type::OrSymbol
3522
- ).returns(T.attached_class)
3523
- end
3524
- def self.new(
3525
- # The Card Authorization Expiration identifier.
3526
- id:,
3527
- # The identifier for the Card Authorization this reverses.
3528
- card_authorization_id:,
3529
- # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3530
- # currency.
3531
- currency:,
3532
- # The amount of this authorization expiration in the minor unit of the
3533
- # transaction's currency. For dollars, for example, this is cents.
3534
- expired_amount:,
3535
- # The card network used to process this card authorization.
3536
- network:,
3537
- # A constant representing the object's type. For this resource it will always be
3538
- # `card_authorization_expiration`.
3539
- type:
3540
- )
3541
- end
3542
-
3543
- sig do
3544
- override.returns(
3545
- {
3546
- id: String,
3547
- card_authorization_id: String,
3548
- currency:
3549
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol,
3550
- expired_amount: Integer,
3551
- network:
3552
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol,
3553
- type:
3554
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3555
- }
3556
- )
3557
- end
3558
- def to_hash
3559
- end
3560
-
3561
- # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
3562
- # currency.
3563
- module Currency
3564
- extend Increase::Internal::Type::Enum
3565
-
3566
- TaggedSymbol =
3567
- T.type_alias do
3568
- T.all(
3569
- Symbol,
3570
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency
3571
- )
3572
- end
3573
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3574
-
3575
- # US Dollar (USD)
3576
- USD =
3577
- T.let(
3578
- :USD,
3579
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3580
- )
3581
-
3582
- sig do
3583
- override.returns(
3584
- T::Array[
3585
- Increase::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol
3586
- ]
3587
- )
3588
- end
3589
- def self.values
3590
- end
3591
- end
3592
-
3593
- # The card network used to process this card authorization.
3594
- module Network
3595
- extend Increase::Internal::Type::Enum
3596
-
3597
- TaggedSymbol =
3598
- T.type_alias do
3599
- T.all(
3600
- Symbol,
3601
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network
3602
- )
3603
- end
3604
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3605
-
3606
- # Visa
3607
- VISA =
3608
- T.let(
3609
- :visa,
3610
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3611
- )
3612
-
3613
- # Pulse
3614
- PULSE =
3615
- T.let(
3616
- :pulse,
3617
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3618
- )
3619
-
3620
- sig do
3621
- override.returns(
3622
- T::Array[
3623
- Increase::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol
3624
- ]
3625
- )
3626
- end
3627
- def self.values
3628
- end
3629
- end
3630
-
3631
- # A constant representing the object's type. For this resource it will always be
3632
- # `card_authorization_expiration`.
3633
- module Type
3634
- extend Increase::Internal::Type::Enum
3635
-
3636
- TaggedSymbol =
3637
- T.type_alias do
3638
- T.all(
3639
- Symbol,
3640
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type
3641
- )
3642
- end
3643
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3644
-
3645
- CARD_AUTHORIZATION_EXPIRATION =
3646
- T.let(
3647
- :card_authorization_expiration,
3648
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3649
- )
3650
-
3651
- sig do
3652
- override.returns(
3653
- T::Array[
3654
- Increase::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol
3655
- ]
3656
- )
3657
- end
3658
- def self.values
3659
- end
3660
- end
3661
- end
3662
-
3663
5687
  class CardDecline < Increase::Internal::Type::BaseModel
3664
5688
  OrHash =
3665
5689
  T.type_alias do
@@ -17233,6 +19257,13 @@ module Increase
17233
19257
  Increase::CardPayment::Element::Category::TaggedSymbol
17234
19258
  )
17235
19259
 
19260
+ # Card Balance Inquiry: details will be under the `card_balance_inquiry` object.
19261
+ CARD_BALANCE_INQUIRY =
19262
+ T.let(
19263
+ :card_balance_inquiry,
19264
+ Increase::CardPayment::Element::Category::TaggedSymbol
19265
+ )
19266
+
17236
19267
  # Inbound Card Validation: details will be under the `card_validation` object.
17237
19268
  CARD_VALIDATION =
17238
19269
  T.let(